什么是 AWS Amplify 文档 MCP 服务器？

AWS Amplify 文档 MCP 服务器是一个克隆 AWS Amplify 官方文档仓库并提供强大搜索功能的工具。它允许用户通过自然语言查询快速找到所需的文档。

如何使用 AWS Amplify 文档 MCP 服务器？

只需启动服务器并输入您的查询词，即可开始搜索。支持高级搜索语法和智能排序。

适用场景

适用于开发者需要快速查找 AWS Amplify 相关文档的情况，尤其是那些涉及 React、CLI 和其他框架的开发者。

主要功能

强大的搜索功能支持自然语言查询，帮助您快速找到所需文档。

高级搜索语法支持布尔运算符、通配符、字段特定搜索等功能。

智能结果排名根据查询的相关性对结果进行智能排序。

分页支持处理大量搜索结果时提供分页功能。

性能缓存缓存搜索结果以提高性能。

自动更新定期从官方仓库拉取最新文档版本。

生成版本选择支持 Gen 1、Gen 2 或两者同时使用。

优势与局限性

优势

快速查找 AWS Amplify 官方文档

支持高级搜索语法和智能排序

自动更新确保内容始终是最新的

优化了磁盘空间使用

局限性

需要一定的网络环境支持

对于非常复杂的问题可能需要多次尝试

如何使用

安装服务器克隆项目代码并安装依赖。

配置服务器编辑 config 文件以设置搜索范围和选项。

启动服务器运行脚本以启动 MCP 服务器。

使用案例

案例 1：查询认证相关文档查找与 React 相关的认证流程文档。

案例 2：查询存储相关文档查找存储相关的配置和访问权限。

常见问题

如何切换不同的文档生成版本？在 config 文件中设置 'amplifyGeneration' 参数为 'gen1'、'gen2' 或 'both'。

如何强制重建数据目录？使用命令 './start-server.sh --gen <version> --rebuild'。

是否支持模糊搜索？是的，支持通配符和布尔运算符。

AWS Amplify MCP 服务器中文文档

配置说明

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

查询处理流程

查询解析: 服务器解析用户的搜索请求，识别高级语法如布尔操作符和通配符。
目录优化: 根据请求中的关键词和选择的 Amplify 版本（Gen 1、Gen 2 或两者），优化要搜索的文件范围。
智能排序: 结果根据以下因素进行排序：
- 查询中是否提及特定版本（Gen 1 或 Gen 2）
- 查询是否涉及设置、CLI 命令或资源创建
- 文档与查询上下文的相关性
- 标题中的精确匹配
- 匹配数量和文档重要性
内容提取: 对于每个匹配的文件，提取相关的内容并进行格式化处理。
缓存机制: 搜索结果会被缓存以提高重复查询的性能。

项目结构

src/index.ts: 主服务器实现
src/config.ts: 配置加载与处理
src/git.ts: Git 仓库管理
src/cache.ts: 搜索结果缓存
src/directory.ts: 目录结构管理
src/types/: TypeScript 类型定义
scripts/build.js: 文档构建脚本
bin/mcp: 可执行脚本用于运行服务器

使用建议

环境优化:
- 为了最佳搜索效果，建议将 "amplifyGeneration" 设置为 "gen1" 或 "gen2" 中的一个。
搜索优化:
- 使用具体的技术术语而非通用短语
- 包括类别名称以缩小结果范围（例如，使用 "存储所有者访问权限" 而不是仅 "访问权限"）
- 使用引号进行精确短语匹配
- 包含缩写和替代词以提高搜索结果
性能考量:
- 根据需求设置适当的 autoUpdateInterval（更高的值可减少服务器负载）
- 利用缓存机制对频繁访问的查询
- 考虑使用 filesOnly: true 进行初始广泛搜索以提升性能