Amplify Doc MCP

🚀 AWS Amplify MCP 服務器中文文檔

本項目是 AWS Amplify MCP 服務器的中文文檔，主要介紹了服務器的配置、查詢處理流程、項目結構等內容，為用戶提供了詳細的使用指南和優化建議。

🚀 快速開始

系統要求

• Node.js 18.x 或更高版本（已測試到 Node.js 20.18.2）
• npm 8.x 或更高版本（已測試到 npm 10.8.2）

📦 安裝指南

暫未提供具體安裝步驟，可參考系統要求準備好運行環境。

✨ 主要特性

配置靈活

可通過配置文件對服務器的區域、配置文件、Amplify 版本、自動更新間隔、最大緩存時間和索引路徑等進行靈活配置。

查詢處理智能

• 支持解析高級語法，如布爾操作符和通配符。
• 可根據關鍵詞和 Amplify 版本優化搜索範圍。
• 結果排序綜合考慮多種因素，提高相關性。

性能優化

• 採用緩存機制，提高重複查詢性能。
• 可根據需求調整自動更新間隔，減少服務器負載。

📚 詳細文檔

配置說明

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

查詢處理流程

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 下開源。