Amplify Doc MCP

🚀 AWS Amplify MCP サーバー日本語ドキュメント

AWS Amplify MCP サーバーは、特定の設定に基づいて検索機能を提供し、ユーザーのクエリに対して最適な結果を返すことができます。

🚀 クイックスタート

このセクションでは、AWS Amplify MCP サーバーの基本的な設定と使用方法を説明します。

📦 インストール

このサーバーを使用するには、以下のシステム要件を満たす必要があります。

• Node.js 18.x またはそれ以上のバージョン（Node.js 20.18.2 までテスト済み）
• npm 8.x またはそれ以上のバージョン（npm 10.8.2 までテスト済み）

🔧 設定説明

サーバーの設定は、以下の JSON ファイルで行います。

{
  "awsRegion": "cn-north-1",
  "awsProfile": "default",
  "amplifyGeneration": "gen2",
  "autoUpdateInterval": 60,
  "maxCacheAge": 86400,
  "indexPath": "/var/www/html/amplify-docs-search"
}

💻 使用例

基本的な使用法

サーバーを起動するには、以下のコマンドを実行します。

bin/mcp

高度な使用法

サーバーの設定を変更するには、src/config.ts ファイルを編集します。

📚 ドキュメント

🔍 查询処理流程

1. クエリ解析: サーバーはユーザーの検索リクエストを解析し、ブール演算子やワイルドカードなどの高度な構文を識別します。
2. ディレクトリ最適化: リクエスト内のキーワードと選択された Amplify バージョン（Gen 1、Gen 2、または両方）に基づいて、検索対象のファイル範囲を最適化します。
3. スマートソート: 結果は以下の要素に基づいてソートされます。
   • クエリで特定のバージョン（Gen 1 または Gen 2）が指定されているかどうか
   • クエリが設定、CLI コマンド、またはリソース作成に関するものかどうか
   • ドキュメントとクエリコンテキストの関連性
   • タイトルの正確な一致
   • 一致数とドキュメントの重要性
4. コンテンツ抽出: 各一致するファイルから関連するコンテンツを抽出し、フォーマット処理を行います。
5. キャッシュメカニズム: 検索結果はキャッシュされ、繰り返しのクエリのパフォーマンスを向上させます。

🏗️ プロジェクト構造

• src/index.ts: メインサーバーの実装
• src/config.ts: 設定の読み込みと処理
• src/git.ts: Git リポジトリの管理
• src/cache.ts: 検索結果のキャッシュ
• src/directory.ts: ディレクトリ構造の管理
• src/types/: TypeScript の型定義
• scripts/build.js: ドキュメントのビルドスクリプト
• bin/mcp: サーバーを実行するための実行可能スクリプト

💡 使用アドバイス

1. 環境最適化:

   • 最適な検索結果を得るために、"amplifyGeneration" を "gen1" または "gen2" のいずれかに設定することをおすすめします。

2. 検索最適化:

   • 一般的なフレーズではなく、具体的な技術用語を使用します。
   • 結果の範囲を絞るためにカテゴリ名を含めます（例: "アクセス権限" ではなく "ストレージ所有者のアクセス権限" を使用）。
   • 正確なフレーズマッチングを行うには引用符を使用します。
   • 検索結果を向上させるために略語や代替語を含めます。

3. パフォーマンス考慮事項:

   • 必要に応じて autoUpdateInterval を適切に設定します（値を大きくするとサーバーの負荷を軽減できます）。
   • 頻繁にアクセスされるクエリに対してキャッシュメカニズムを利用します。
   • パフォーマンスを向上させるために、初期の広範な検索に filesOnly: true を使用することを検討します。

🤝 貢献とフィードバック

この MCP サーバーの改善のために、どんな貢献やフィードバックも歓迎します。以下の点に関する提案がある場合は、GitHub で問題を提出するか、プルリクエストを送信してください。

• 検索クエリ結果の改善
• ソートアルゴリズムの強化
• 新機能やパラメータの追加
• パフォーマンスの最適化

📄 ライセンス

このプロジェクトは MIT License の下でオープンソースとして公開されています。