awslabs.documentdb-mcp-server 0.0.1__tar.gz

awslabs_documentdb_mcp_server-0.0.1/.gitignore

@@ -0,0 +1,59 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# Virtual environments
+.venv
+env/
+venv/
+ENV/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+
+# Testing
+.tox/
+.coverage
+.coverage.*
+htmlcov/
+.pytest_cache/
+
+# Ruff
+.ruff_cache/
+
+# Build
+*.manifest
+*.spec
+.pybuilder/
+target/
+
+# Environments
+.env
+.env.local
+.env.*.local
+
+# PyPI
+.pypirc

awslabs_documentdb_mcp_server-0.0.1/.pre-commit-config.yaml

@@ -0,0 +1,14 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.9.6
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format
+
+  - repo: https://github.com/commitizen-tools/commitizen
+    rev: v3.13.0
+    hooks:
+      - id: commitizen
+      - id: commitizen-branch
+        stages: [pre-push]

awslabs_documentdb_mcp_server-0.0.1/.python-version

@@ -0,0 +1 @@
+3.10

awslabs_documentdb_mcp_server-0.0.1/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## Unreleased
+
+### Added
+
+- Initial project setup

awslabs_documentdb_mcp_server-0.0.1/LICENSE

@@ -0,0 +1,175 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.

awslabs_documentdb_mcp_server-0.0.1/NOTICE

@@ -0,0 +1,2 @@
+awslabs.documentdb-mcp-server
+Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.

awslabs_documentdb_mcp_server-0.0.1/PKG-INFO

@@ -0,0 +1,202 @@
+Metadata-Version: 2.4
+Name: awslabs.documentdb-mcp-server
+Version: 0.0.1
+Summary: An AWS Labs Model Context Protocol (MCP) server for documentdb
+Project-URL: homepage, https://awslabs.github.io/mcp/
+Project-URL: docs, https://awslabs.github.io/mcp/servers/documentdb-mcp-server/
+Project-URL: documentation, https://awslabs.github.io/mcp/servers/documentdb-mcp-server/
+Project-URL: repository, https://github.com/awslabs/mcp.git
+Project-URL: changelog, https://github.com/awslabs/mcp/blob/main/src/documentdb-mcp-server/CHANGELOG.md
+Author: Amazon Web Services
+Author-email: AWSLabs MCP <203918161+awslabs-mcp@users.noreply.github.com>, Nitin Ahuja <nitahuja@amazon.com>
+License: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.10
+Requires-Dist: loguru>=0.7.0
+Requires-Dist: mcp[cli]>=1.6.0
+Requires-Dist: pydantic>=2.10.6
+Requires-Dist: pymongo>=4.12.1
+Description-Content-Type: text/markdown
+
+# 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
+
+```bash
+# 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 |
+|--------|-------------|---------|
+| `--port` | Port to run the server on | 8888 |
+| `--host` | Host to bind the server to | 127.0.0.1 |
+| `--sse` | Use SSE transport | False |
+| `--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)
+
+```python
+# 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:
+
+```bash
+python -m awslabs.documentdb_mcp_server.server --allow-write
+```
+
+When the server is running with write operations enabled:
+
+```python
+# 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."
+```
+
+## Prerequisites
+
+- Network access to your DocumentDB cluster
+- SSL/TLS certificate if your cluster requires TLS (typically `global-bundle.pem`)

awslabs_documentdb_mcp_server-0.0.1/README.md

@@ -0,0 +1,173 @@
+# 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
+
+```bash
+# 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 |
+|--------|-------------|---------|
+| `--port` | Port to run the server on | 8888 |
+| `--host` | Host to bind the server to | 127.0.0.1 |
+| `--sse` | Use SSE transport | False |
+| `--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)
+
+```python
+# 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:
+
+```bash
+python -m awslabs.documentdb_mcp_server.server --allow-write
+```
+
+When the server is running with write operations enabled:
+
+```python
+# 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."
+```
+
+## Prerequisites
+
+- Network access to your DocumentDB cluster
+- SSL/TLS certificate if your cluster requires TLS (typically `global-bundle.pem`)

awslabs_documentdb_mcp_server-0.0.1/awslabs/documentdb_mcp_server/__init__.py

@@ -0,0 +1,14 @@
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance
+# with the License. A copy of the License is located at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# or in the 'license' file accompanying this file. This file is distributed on an 'AS IS' BASIS, WITHOUT WARRANTIES
+# OR CONDITIONS OF ANY KIND, express or implied. See the License for the specific language governing permissions
+# and limitations under the License.
+
+"""AWS Labs DocumentDB MCP Server package."""
+
+__version__ = '1.0.0'