aws-docs-mcp

🚀 AWS文档MCP服务器

这是一个用于AWS文档的模型上下文协议（MCP）服务器。该服务器提供了访问AWS文档、搜索内容以及获取推荐的工具。

🚀 快速开始

本MCP服务器为访问AWS文档提供了便利，可进行内容搜索和获取推荐。

✨ 主要特性

• 阅读文档：获取AWS文档页面并将其转换为Markdown格式。
• 搜索文档：使用官方搜索API搜索AWS文档（仅支持全球范围）。
• 内容推荐：获取AWS文档页面的内容推荐（仅支持全球范围）。
• 获取可用服务列表：获取中国区域可用的AWS服务列表（仅适用于中国）。

📦 安装指南

安装要求

1. 从 Astral 或 GitHub README 安装 uv。
2. 使用 uv python install 3.10 安装Python 3.10或更高版本（也可安装更新版本）。

安装方式

| 光标工具 | VS Code | |:------:|:-------:| | | |

在MCP客户端配置中配置MCP服务器（例如，对于Amazon Q开发者CLI，编辑 ~/.aws/amazonq/mcp.json）：

{
  "mcpServers": {
    "awslabs.aws-documentation-mcp-server": {
      "command": "uvx",
      "args": ["awslabs.aws-documentation-mcp-server@latest"],
      "env": {
        "FASTMCP_LOG_LEVEL": "ERROR",
        "AWS_DOCUMENTATION_PARTITION": "aws"
      },
      "disabled": false,
      "autoApprove": []
    }
  }
}

⚠️ 重要提示

将 AWS_DOCUMENTATION_PARTITION 设置为 aws-cn 可查询AWS中国文档，而非全球AWS文档。

或者在成功执行 docker build -t mcp/aws-documentation . 后使用Docker进行配置：

{
  "mcpServers": {
    "awslabs.aws-documentation-mcp-server": {
      "command": "docker",
      "args": [
        "run",
        "--rm",
        "--interactive",
        "--env",
        "FASTMCP_LOG_LEVEL=ERROR",
        "--env",
        "AWS_DOCUMENTATION_PARTITION=aws",
        "mcp/aws-documentation:latest"
      ],
      "env": {},
      "disabled": false,
      "autoApprove": []
    }
  }
}

💻 使用示例

基础用法

示例：

• "查找S3存储桶命名规则的文档，并注明来源"
• "为页面 https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html 获取内容推荐"

高级用法

本服务器提供了多个工具函数，以下是这些工具函数的使用说明：

read_documentation

获取AWS文档页面并将其转换为Markdown格式。

read_documentation(url: str) -> str

search_documentation（仅全球范围）

使用官方AWS文档搜索API搜索AWS文档。

search_documentation(search_phrase: str, limit: int) -> list[dict]

recommend（仅全球范围）

获取AWS文档页面的内容推荐。

recommend(url: str) -> list[dict]

get_available_services（仅中国）

获取中国区域可用的AWS服务列表。

get_available_services() -> str