このページは機械翻訳されています。英語の原文を読む。
オーサリングガイド
このガイドは、アーキテクチャの章と言語リファレンスを補完する実践的なガイドです。アーキテクチャが Aggrega が現在の形になっている理由を説明し、リファレンスが各フィールドの意味を規定するのに対し、このガイドは実際にオーサリングする方法を教えます。どのエンティティを、どの順序で使うか、そして CLI と AI アシスタントが最小限の手間で正しいファイルを作成するのをどのように支援するかを説明します。
このガイドは 2 種類の読者を同時に対象としています。エディタで手作業でオーサリングする人と、Model Context Protocol サーバーを通じて人に代わってオーサリングする AI アシスタントです。どちらも同じループに従い、同じリファレンスを参照するため、以下のページは両者に役立ちます。
読む順序
- Aggrega ファイルのオーサリング — オーサリングのループ全体:ロールを選び、形を学び、スキャフォールドし、記入し、検証し、ビルドします。ここから始めてください。
- ペルソナ — 協働する 4 つのオーサリングロール(開発者、アーキテクト、運用、オペレーター)と、その背景にある「強制ではなくガイダンス」という考え方。
- ロール別エンティティ — すべてのエンティティの種類を、通常それを所有するロールに対応付けたもので、各関心事がどのファイルに属するかがわかります。
- インストール —
aggregaバイナリをインストールします。最初にコマンドを示し、接続のセクションからは MCP サーバーの接続へ案内します。 - Visual Studio Code で Aggrega を使う — Visual Studio Code 用の Aggrega 拡張機能について、必要なもの、ウェルカムページ、各パネルとトポロジーグラフ、すべての設定とコマンドを説明します。
インポートは、別の形式で既にあるプロジェクトを出発点として、そこからこれらのファイルのドラフトを作成します。ドラフトはレビューしてからビルドします。
Aggrega を学ぶでは、ドキュメント全体を通じた道筋の中にこのガイドを位置づけています。
AI アシスタントとの連携
- AI アシスタントで Aggrega をセットアップする — コマンドを実行できるアシスタントに貼り付ける 1 つのプロンプトで、アシスタントが Aggrega をインストールし、Aggrega スキルを追加し、自身をサーバーに接続します。
- MCP サーバーの接続 — クライアントごとのサーバーエントリー、各クライアントがそれを保持する場所、HTTPS 経由で接続するサーバー、そして接続の確認方法。
- Aggrega スキル — アシスタントが Aggrega のために読み込む指示です。そのインストール方法と、最新の状態に保つ方法を説明します。
- アシスタントが Aggrega でできること — 接続したサーバーによって、アシスタントが何を読み取り、確認し、ビルドし、公開できるか。
アシスタントの機能とこのガイドの関係
aggrega mcp サーバーは、このガイド、言語リファレンス、JSON Schema を、アシスタントが YAML を書く前に読むリソースとして公開し、さらにエンティティをスキャフォールドおよび検証するツールも提供します。アシスタントに組み込まれたオーサリング用プロンプトは、これらのページの内容を繰り返すのではなく、これらのページを参照するため、このガイドがオーサリング手法に関する唯一の説明文書となります。ループについては Aggrega ファイルのオーサリングを、接続については MCP サーバーの接続を参照してください。