Skip to main content

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

Project description

AWS DocumentDB MCP Server

An AWS Labs Model Context Protocol (MCP) server for AWS DocumentDB that enables AI assistants to interact with DocumentDB databases.

Overview

The DocumentDB MCP Server provides tools to connect to and query AWS DocumentDB databases. It serves as a bridge between AI assistants and AWS DocumentDB, allowing for safe and efficient database operations through the Model Context Protocol (MCP).

Features

  • Connection Management: Establish and maintain connections to DocumentDB clusters
  • Database Management: List databases and retrieve database statistics
  • Collection Management: List, create, drop collections and retrieve collection statistics
  • Document Operations: Query, insert, update, and delete documents
  • Aggregation Pipelines: Execute DocumentDB aggregation pipelines
  • Query Planning: Get explanations of how operations will be executed
  • Schema Analysis: Analyze collection schemas by sampling documents
  • Read-Only Mode: Optional security feature to restrict operations to read-only operations

Available Tools

The DocumentDB MCP Server provides the following tools:

Connection Management

  • connect: Connect to a DocumentDB cluster and get a connection ID
  • disconnect: Close an active connection

Database Management

  • listDatabases: List all available databases in the DocumentDB cluster
  • getDatabaseStats: Get statistics about a DocumentDB database

Collection Management

  • listCollections: List collections in a database
  • createCollection: Create a new collection in a database (blocked in read-only mode)
  • dropCollection: Drop a collection from a database (blocked in read-only mode)
  • getCollectionStats: Get statistics about a collection
  • countDocuments: Count documents in a collection
  • analyzeSchema: Analyze the schema of a collection by sampling documents and providing field coverage

Document Operations

  • find: Query documents from a collection
  • aggregate: Run aggregation pipelines
  • insert: Insert documents (blocked in read-only mode)
  • update: Update documents (blocked in read-only mode)
  • delete: Delete documents (blocked in read-only mode)

Query Planning

  • explainOperation: Get an explanation of how an operation will be executed

Server Configuration

Starting the Server

# Basic usage
python -m awslabs.documentdb_mcp_server.server

# With custom port and host
python -m awslabs.documentdb_mcp_server.server --port 9000 --host 0.0.0.0

# With write operations enabled
python -m awslabs.documentdb_mcp_server.server --allow-write

Command Line Options

Option Description Default
--log-level Set logging level (TRACE, DEBUG, INFO, etc.) INFO
--connection-timeout Idle connection timeout in minutes 30
--allow-write Enable write operations (otherwise defaults to read-only mode) False

Read-Only Mode

By default, the server runs in read-only mode that only allows read operations. This enhances security by preventing any modifications to the database. In read-only mode:

  • Read operations (find, aggregate, listCollections) work normally
  • Write operations (insert, update, delete) are blocked and return a permission error
  • Connection management operations (connect, disconnect) work normally

This mode is particularly useful for:

  • Demonstration environments
  • Security-sensitive applications
  • Integration with public-facing AI assistants
  • Protecting production databases from unintended modifications

Usage Examples

Basic Connection and Query (Read-Only Operations)

# Connect to a DocumentDB cluster
connection_result = await use_mcp_tool(
    server_name="awslabs.aws-documentdb-mcp-server",
    tool_name="connect",
    arguments={
        "connection_string": "mongodb://<username>:<password>@docdb-cluster.cluster-xyz.us-west-2.docdb.amazonaws.com:27017/?tls=true&tlsCAFile=global-bundle.pem"
    }
)
connection_id = connection_result["connection_id"]

# Query documents
query_result = await use_mcp_tool(
    server_name="awslabs.aws-documentdb-mcp-server",
    tool_name="find",
    arguments={
        "connection_id": connection_id,
        "database": "my_database",
        "collection": "users",
        "query": {"active": True},
        "limit": 5
    }
)

# Close the connection when done
await use_mcp_tool(
    server_name="awslabs.aws-documentdb-mcp-server",
    tool_name="disconnect",
    arguments={"connection_id": connection_id}
)

Enabling Write Operations

To enable write operations, start the server with the --allow-write flag:

python -m awslabs.documentdb_mcp_server.server --allow-write

When the server is running with write operations enabled:

# This operation will succeed
query_result = await use_mcp_tool(
    server_name="awslabs.aws-documentdb-mcp-server",
    tool_name="find",
    arguments={
        "connection_id": connection_id,
        "database": "my_database",
        "collection": "users",
        "query": {"active": True}
    }
)

# This operation will now succeed when --allow-write is used
insert_result = await use_mcp_tool(
    server_name="awslabs.aws-documentdb-mcp-server",
    tool_name="insert",
    arguments={
        "connection_id": connection_id,
        "database": "my_database",
        "collection": "users",
        "documents": {"name": "New User", "active": True}
    }
)

# Without the --allow-write flag, you would receive this error:
# ValueError: "Operation not permitted: Server is configured in read-only mode. Use --allow-write flag when starting the server to enable write operations."

Configure in your MCP client

Cursor VS Code
Install MCP Server Install on VS Code

Configure the MCP server in your MCP client configuration (e.g., for Amazon Q Developer CLI, edit ~/.aws/amazonq/mcp.json):

{
  "mcpServers": {
    "awslabs.documentdb-mcp-server": {
      "command": "uvx",
      "args": [
        "awslabs.documentdb-mcp-server@latest",
      ],
      "env": {
        "AWS_PROFILE": "your-aws-profile",
        "AWS_REGION": "us-east-1",
        "FASTMCP_LOG_LEVEL": "ERROR"
      },
      "disabled": false,
      "autoApprove": []
    }
  }
}

Windows Installation

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

{
  "mcpServers": {
    "awslabs.documentdb-mcp-server": {
      "disabled": false,
      "timeout": 60,
      "type": "stdio",
      "command": "uv",
      "args": [
        "tool",
        "run",
        "--from",
        "awslabs.documentdb-mcp-server@latest",
        "awslabs.documentdb-mcp-server.exe"
      ],
      "env": {
        "FASTMCP_LOG_LEVEL": "ERROR",
        "AWS_PROFILE": "your-aws-profile",
        "AWS_REGION": "us-east-1"
      }
    }
  }
}

Prerequisites

  • Network access to your DocumentDB cluster
  • SSL/TLS certificate if your cluster requires TLS (typically global-bundle.pem)

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

awslabs_documentdb_mcp_server-1.0.5.tar.gz (91.3 kB view details)

Uploaded Source

Built Distribution

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

awslabs_documentdb_mcp_server-1.0.5-py3-none-any.whl (23.6 kB view details)

Uploaded Python 3

File details

Details for the file awslabs_documentdb_mcp_server-1.0.5.tar.gz.

File metadata

File hashes

Hashes for awslabs_documentdb_mcp_server-1.0.5.tar.gz
Algorithm Hash digest
SHA256 4e60e1b742923ecf0d77ee7bab23bd5959c6c407091d262fd47b54a96771f79c
MD5 9a1f6f3cf4ad90cbb3be46384c02b4fc
BLAKE2b-256 7e787d36a29bbb9c0992d4b610f6239e61bde668399718351cc5a5417caf0555

See more details on using hashes here.

Provenance

The following attestation bundles were made for awslabs_documentdb_mcp_server-1.0.5.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_documentdb_mcp_server-1.0.5-py3-none-any.whl.

File metadata

File hashes

Hashes for awslabs_documentdb_mcp_server-1.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 c966895fa43e3373aa735c3ca8e51b687ec3278f91c42b79a7dba3dd398e7a62
MD5 622a76a99a536a7d07c3f550216984bd
BLAKE2b-256 2a302937598115c4d76bfdf7088d8b5d3d56f510a2848d01dd174398e69ab7ad

See more details on using hashes here.

Provenance

The following attestation bundles were made for awslabs_documentdb_mcp_server-1.0.5-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