Skip to main content

An AWS Labs Model Context Protocol (MCP) server for AWS Documentation

Project description

AWS Documentation MCP Server

Model Context Protocol (MCP) server for AWS Documentation

This MCP server provides tools to access AWS documentation, search for content, and get recommendations.

Features

  • Read Documentation: Fetch and convert AWS documentation pages to markdown format
  • Search Documentation: Search AWS documentation using the official search API (global only)
  • Recommendations: Get content recommendations for AWS documentation pages (global only)
  • Get Available Services List: Get a list of available AWS services in China regions (China only)

Prerequisites

Installation Requirements

  1. Install uv from Astral or the GitHub README
  2. Install Python 3.10 or newer using uv python install 3.10 (or a more recent version)

Installation

Kiro Cursor VS Code
Add to Kiro Install MCP Server Install on VS Code

Configure the MCP server in your MCP client configuration:

{
  "mcpServers": {
    "awslabs.aws-documentation-mcp-server": {
      "command": "uvx",
      "args": ["awslabs.aws-documentation-mcp-server@latest"],
      "env": {
        "FASTMCP_LOG_LEVEL": "ERROR",
        "AWS_DOCUMENTATION_PARTITION": "aws",
        "MCP_USER_AGENT": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/131.0.0.0 Safari/537.36"
      },
      "disabled": false,
      "autoApprove": []
    }
  }
}

For Kiro MCP configuration, see the Kiro IDE documentation or the Kiro CLI documentation for details.

For global configuration, edit ~/.kiro/settings/mcp.json. For project-specific configuration, edit .kiro/settings/mcp.json in your project directory.

Windows Installation

For Windows users, the MCP server configuration format is slightly different:

{
  "mcpServers": {
    "awslabs.aws-documentation-mcp-server": {
      "disabled": false,
      "timeout": 60,
      "type": "stdio",
      "command": "uv",
      "args": [
        "tool",
        "run",
        "--from",
        "awslabs.aws-documentation-mcp-server@latest",
        "awslabs.aws-documentation-mcp-server.exe"
      ],
      "env": {
        "FASTMCP_LOG_LEVEL": "ERROR",
        "AWS_DOCUMENTATION_PARTITION": "aws"
      }
    }
  }
}

Note: Set AWS_DOCUMENTATION_PARTITION to aws-cn to query AWS China documentation instead of global AWS documentation.

Corporate Networks: If you're behind a corporate proxy or firewall that blocks certain User-Agent strings, set MCP_USER_AGENT to match your browser's User-Agent to an allowable string.

or docker after a successful docker build -t mcp/aws-documentation .:

{
  "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": []
    }
  }
}

Environment Variables

Variable Description Default
FASTMCP_LOG_LEVEL Logging level (DEBUG, INFO, WARNING, ERROR, CRITICAL) WARNING
AWS_DOCUMENTATION_PARTITION AWS partition (aws or aws-cn) aws
MCP_USER_AGENT Custom User-Agent string for HTTP requests Chrome-based default

Corporate Network Support

For corporate environments with proxy servers or firewalls that block certain User-Agent strings:

{
  "env": {
    "MCP_USER_AGENT": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/131.0.0.0 Safari/537.36"
  }
}

Basic Usage

Example:

AWS Documentation MCP Demo

Tools

read_documentation

Fetches an AWS documentation page and converts it to markdown format.

read_documentation(url: str) -> str

search_documentation (global only)

Searches AWS documentation using the official AWS Documentation Search API.

search_documentation(ctx: Context, search_phrase: str, limit: int, product_types: Optional[List[str]], guide_types: Optional[List[str]]) -> SearchResponse

recommend (global only)

Gets content recommendations for an AWS documentation page.

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

get_available_services (China only)

Gets a list of available AWS services in China regions.

get_available_services() -> str

Development

For getting started with development on the AWS Documentation MCP server, please refer to the awslabs/mcp DEVELOPER_GUIDE first. Everything below this is specific to AWS Documentation MCP Server development.

Running tests

Unit tests: uv run --frozen pytest --cov --cov-branch --cov-report=term-missing Unit tests with integration tests: uv run --frozen pytest --cov --cov-branch --cov-report=term-missing --run-live

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file awslabs_aws_documentation_mcp_server-1.1.17.tar.gz.

File metadata

File hashes

Hashes for awslabs_aws_documentation_mcp_server-1.1.17.tar.gz
Algorithm Hash digest
SHA256 d45274b55e6d3095235044096b1e8b1c02f4cc5ac1859defaff55ed6cad1862b
MD5 37a093cfc5a2cd384f74493fa791b6b9
BLAKE2b-256 2716ccaf886f81b803e579402fcbcff054b0788adcf18c873ad23cbfd3a2316d

See more details on using hashes here.

Provenance

The following attestation bundles were made for awslabs_aws_documentation_mcp_server-1.1.17.tar.gz:

Publisher: release.yml on awslabs/mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file awslabs_aws_documentation_mcp_server-1.1.17-py3-none-any.whl.

File metadata

File hashes

Hashes for awslabs_aws_documentation_mcp_server-1.1.17-py3-none-any.whl
Algorithm Hash digest
SHA256 203b1040d4e12740a18c067b8bd858a57dc0ec6c61505f6b6117b79bc4be7e6a
MD5 e5e1a36cc817dc27fa3fec9f57342076
BLAKE2b-256 36b1aa39ab21b52c84fa323b28a7df9e8d90ab9b245f630d10a95349b1c34b87

See more details on using hashes here.

Provenance

The following attestation bundles were made for awslabs_aws_documentation_mcp_server-1.1.17-py3-none-any.whl:

Publisher: release.yml on awslabs/mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page