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