Astro Docs

🚀 Astro ドキュメント MCP サーバー

このサーバーは、AIエージェントがAstroのドキュメントにアクセスできるようにするMCPサーバーです。AIアシスタントは、このサーバーを通じてAstro関連のドキュメントを検索し、参照することができ、ユーザーがAstro関連のタスクを完了するのを支援します。

このTypeScriptベースのMCPサーバーは、Astroドキュメントを検索するシステムを実装しています。以下の方法で、核心的なMCP概念を実演しています。

• astro-docs:// URIとメタデータを使用して、Astroドキュメントの各部分を表現
• Astroドキュメントを検索するツールを提供
• 一般的なAstroの質問やタスクに関するヒントを提供

✨ 主な機能

リソース

• Astroドキュメントの各部分を一覧表示し、アクセスすることができます。
• 各ドキュメント部分には、タイトル、内容、カテゴリがあります。
• 純粋なテキストのMIMEタイプを使用して、簡単に内容にアクセスできます。

ツール

• search_docs - Astroドキュメントを検索します。
  • 検索クエリを必須パラメータとして受け取ります。
  • 一致するドキュメント部分を返します。

ヒント文

• explain_astro_islands - Astroアイランドアーキテクチャの詳細な説明を取得します。
• astro_project_setup - 新しいAstroプロジェクトのセットアップガイドを取得します。
• astro_vs_other_frameworks - Astroと他のWebフレームワークを比較します。

📁 プロジェクト構成

• src/ - サーバーのソースコード
  • index.ts - 主なMCPサーバーの実装
  • scripts/ - ビルドとテストを支援するスクリプト
    • build.js - TypeScriptをトランスパイルし、起動スクリプトを生成するビルドスクリプト
    • test-client.js - サーバー機能を検証するテストクライアント
• bin/ - 生成された実行可能スクリプト
  • astro-docs-mcp - 主な起動スクリプト
• build/ - コンパイルされたJavaScriptファイル（自動生成）

🛠️ 設定要件

• Node.js v16以上が必要です。
• 最適な互換性を得るために、Node.js v20以上の使用を推奨します。
• サーバーはESモジュール構文を使用しています。
• 設定ファイルの例：config.json

📦 インストールと設定

インストール手順

1. このリポジトリをローカルにクローンします。

   git clone https://github.com/yourusername/astro-docs-mcp.git
   cd astro-docs-mcp
   

2. 依存関係をインストールします。

   pnpm install
   

3. サーバーを起動します。

   npm start
   

設定例

{
  "mcp_server": {
    "port": 3000,
    "documentation_path": "./docs",
    "logging": {
      "level": "info",
      "enabled": true
    }
  }
}

💻 使用例

基本コマンド

1. 利用可能なドキュメント部分を一覧表示します。

   npm run list
   

2. ドキュメント内容を検索します。

   npm run search <クエリ>
   

3. 特定のドキュメントを表示します。

   npm run read astro-docs:///<id>
   

🐞 トラブルシューティング

1. ポート競合：デフォルトのポート3000が使用中の場合は、別のポートで実行してみてください。

   npm start -- --port=3001
   

2. 依存関係の問題：すべての依存関係が正しくインストールされていることを確認してください。

   pnpm install
   

3. ログ出力：config.json のログ設定が有効になっていることを確認してください。

   "logging": {
     "level": "debug",
     "enabled": true
   }
   

🚀 将来的な改善点

• Astro公式サイトからドキュメントをリアルタイムで取得する機能を実装する。
• より詳細なドキュメント部分を追加する。
• ドキュメントのバージョン管理をサポートする。
• 一般的なAstroパターンのコード例やスニペットを追加する。