AWS Documentation

مجتمعي البحث والويب

Fetch, convert, and search AWS documentation pages, with recommendations for related content.

ماذا يمكنك أن تفعل مع AWS Documentation؟

  • Read Documentation: Fetch and convert AWS documentation pages to markdown format
  • Search Documentation: Search AWS documentation using the official search API (global only)
  • Read Sections: Fetches sections of AWS documentation page and converts it to markdown format.
  • Search Table: Filter and search rows in large documentation tables (e.g., service quotas, pricing) without reading the full page (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)

التثبيت

خطوات التثبيت موجودة في التوثيق أدناه. التوثيق

التوثيق

مأخوذ من ملف README للمشروع على GitHub ويُحدَّث أسبوعيًا. تفتح الروابط على GitHub.

المحتويات
  1. AWS Documentation MCP Server
  2. Features
  3. Prerequisites
  4. Installation
  5. Environment Variables
  6. Basic Usage
  7. Tools
  8. Development

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)
  • Read Sections: Fetches sections of AWS documentation page and converts it to markdown format.
  • Search Table: Filter and search rows in large documentation tables (e.g., service quotas, pricing) without reading the full page (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

KiroCursorVS 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

VariableDescriptionDefault
FASTMCP_LOG_LEVELLogging level (DEBUG, INFO, WARNING, ERROR, CRITICAL)WARNING
AWS_DOCUMENTATION_PARTITIONAWS partition (aws or aws-cn)aws
MCP_USER_AGENTCustom User-Agent string for HTTP requestsChrome-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:

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
read_sections (global only)

Fetches sections of AWS documentation page and converts it to markdown format.

read_sections(url: str, section: list[str]) -> list[dict]
search_table (global only)

Searches for specific rows in large documentation tables (e.g., service quotas, pricing tables, supported models). More efficient than read_sections for pages with hundreds of table rows — returns matching rows as structured JSON instead of the full table.

search_table(url: str, section_title: Optional[str], query: str, max_rows: int = 20) -> SearchTableResponse
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

الأسئلة الشائعة

ما هو AWS Documentation؟

Fetch, convert, and search AWS documentation pages, with recommendations for related content.

كيف أثبّت AWS Documentation؟

اتبع خطوات التثبيت في توثيقه المعروض في هذه الصفحة وفي مستودعه.

هل AWS Documentation مفتوح المصدر؟

نعم. شيفرته متاحة على GitHub بترخيص Apache-2.0.

من يصون AWS Documentation؟

ينشره awslabs. يدرجه AI.tn لكنه لا يصونه ولا يوصي به.

من القوائم المجتمعية awesome-mcp-servers ومستودع المشروع على GitHub. الإدراج ليس توصية: راجع شيفرة الخادم وصلاحياته قبل منحه الوصول إلى بياناتك.