awslabs.postgres-mcp-server 1.0.9__py3-none-any.whl → 1.0.11__py3-none-any.whl

{awslabs_postgres_mcp_server-1.0.9.dist-info → awslabs_postgres_mcp_server-1.0.11.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: awslabs.postgres-mcp-server
-Version: 1.0.9
+Version: 1.0.11
 Summary: An AWS Labs Model Context Protocol (MCP) server for postgres
 Project-URL: homepage, https://awslabs.github.io/mcp/
 Project-URL: docs, https://awslabs.github.io/mcp/servers/postgres-mcp-server/
@@ -21,8 +21,9 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Requires-Python: >=3.10
-Requires-Dist: boto3>=1.38.5
-Requires-Dist: botocore>=1.38.5
+Requires-Dist: aiorwlock
+Requires-Dist: boto3>=1.42.4
+Requires-Dist: botocore>1.42.4
 Requires-Dist: loguru>=0.7.0
 Requires-Dist: mcp[cli]>=1.11.0
 Requires-Dist: psycopg[pool]>=3.1.12
@@ -43,11 +44,9 @@ An AWS Labs Model Context Protocol (MCP) server for Aurora Postgres
 
 1. Install `uv` from [Astral](https://docs.astral.sh/uv/getting-started/installation/) or the [GitHub README](https://github.com/astral-sh/uv#installation)
 2. Install Python using `uv python install 3.10`
-3. Aurora Postgres Cluster with Postgres username and password stored in AWS Secrets Manager
-4. Enable RDS Data API for your Aurora Postgres Cluster, see [instructions here](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html)
-5. This MCP server can only be run locally on the same host as your LLM client.
-6. Docker runtime
-7. Set up AWS credentials with access to AWS services
+3. This MCP server can only be run locally on the same host as your LLM client.
+4. Docker runtime
+5. Set up AWS credentials with access to AWS services
    - You need an AWS account with appropriate permissions
    - Configure AWS credentials with `aws configure` or environment variables
 
@@ -59,8 +58,6 @@ An AWS Labs Model Context Protocol (MCP) server for Aurora Postgres
 
 Configure the MCP server in your MCP client configuration (e.g., for Amazon Q Developer CLI, edit `~/.aws/amazonq/mcp.json`):
 
-### Option 1: Using RDS Data API Connection (for Aurora Postgres)
-
 ```json
 {
   "mcpServers": {
@@ -68,11 +65,7 @@ Configure the MCP server in your MCP client configuration (e.g., for Amazon Q De
       "command": "uvx",
       "args": [
         "awslabs.postgres-mcp-server@latest",
-        "--resource_arn", "[your data]",
-        "--secret_arn", "[your data]",
-        "--database", "[your data]",
-        "--region", "[your data]",
-        "--readonly", "True"
+        "--allow_write_query"
       ],
       "env": {
         "AWS_PROFILE": "your-aws-profile",
@@ -86,35 +79,6 @@ Configure the MCP server in your MCP client configuration (e.g., for Amazon Q De
 }
 ```
 
-### Option 2: Using Direct PostgreSQL(psycopg) Connection (for Aurora Postgres and RDS Postgres)
-
-```json
-{
-  "mcpServers": {
-    "awslabs.postgres-mcp-server": {
-      "command": "uvx",
-      "args": [
-        "awslabs.postgres-mcp-server@latest",
-        "--hostname", "[your data]",
-        "--secret_arn", "[your data]",
-        "--database", "[your data]",
-        "--region", "[your data]",
-        "--readonly", "True"
-      ],
-      "env": {
-        "AWS_PROFILE": "your-aws-profile",
-        "AWS_REGION": "us-east-1",
-        "FASTMCP_LOG_LEVEL": "ERROR"
-      },
-      "disabled": false,
-      "autoApprove": []
-    }
-  }
-}
-```
-
-Note: The `--port` parameter is optional and defaults to 5432 (the standard PostgreSQL port). You only need to specify it if your PostgreSQL instance uses a non-standard port.
-
 ### Windows Installation
 
 For Windows users, the MCP server configuration format is slightly different:
@@ -167,56 +131,61 @@ For Windows users, the MCP server configuration format is slightly different:
         "-e", "AWS_SECRET_ACCESS_KEY=[your data]",
         "-e", "AWS_REGION=[your data]",
         "awslabs/postgres-mcp-server:latest",
-        "--resource_arn", "[your data]",
-        "--secret_arn", "[your data]",
-        "--database", "[your data]",
-        "--region", "[your data]",
-        "--readonly", "True"
+        "--allow_write_query"
       ]
     }
   }
 }
 ```
 
-#### Option 2: Using Direct PostgreSQL (psycopg) Connection (for Aurora Postgres and RDS Postgres)
+NOTE: the MCP config example include --allow_write_query illustrate how to enable write queries. If you want to disable write queries, remove --allow_write_query option.
 
-```
-{
-  "mcpServers": {
-    "awslabs.postgres-mcp-server": {
-      "command": "docker",
-      "args": [
-        "run",
-        "-i",
-        "--rm",
-        "-e", "AWS_ACCESS_KEY_ID=[your data]",
-        "-e", "AWS_SECRET_ACCESS_KEY=[your data]",
-        "-e", "AWS_REGION=[your data]",
-        "awslabs/postgres-mcp-server:latest",
-        "--hostname", "[your data]",
-        "--secret_arn", "[your data]",
-        "--database", "[your data]",
-        "--region", "[your data]",
-        "--readonly", "True"
-      ]
-    }
-  }
-}
-```
+## Support for Database Cluster Creation
 
-Note: The `--port` parameter is optional and defaults to 5432 (the standard PostgreSQL port). You only need to specify it if your PostgreSQL instance uses a non-standard port.
+You can use the following LLM prompt to create a new Aurora PostgreSQL cluster:
 
-NOTE: By default, only read-only queries are allowed and it is controlled by --readonly parameter above. Set it to False if you also want to allow writable DML or DDL.
+> Create an Aurora PostgreSQL cluster named 'mycluster' in us-west-2 region
+
+---
 
 ## Connection Methods
 
-This MCP server supports two connection methods:
+The MCP server supports connecting to multiple database endpoints using different connection methods via LLM prompts.
+
+### Database Types
+- **APG**: Amazon Aurora PostgreSQL
+- **RPG**: Amazon RDS for PostgreSQL
+
+### Example Prompts
+
+**Connect using RDS Data API:**
+> Connect to database named postgres in Aurora PostgreSQL cluster 'my-cluster' with database_type as APG, using rdsapi as connection method in us-west-2 region
+
+**Connect using pgwire (Aurora PostgreSQL):**
+> Connect to database named postgres with database endpoint as my-apg17-instance-1.ctgfg6yyo9df.us-west-2.rds.amazonaws.com with database_type as APG, using pgwire as connection method in us-west-2 region
+
+**Connect using pgwire (RDS PostgreSQL):**
+> Connect to database named postgres with database endpoint as test-apg17-instance-1.ctgfg6yyo9df.us-west-2.rds.amazonaws.com with database_type as RPG, using pgwire as connection method in us-west-2 region
+
+---
+
+### Supported Connection Methods
+
+| Method | Description | Supported Database Types |
+|--------|-------------|--------------------------|
+| `pgwire` | Connect to PostgreSQL instance directly using the PostgreSQL wire protocol. Requires proper VPC security group configuration for direct database connectivity. | APG, RPG |
+| `pgwire_iam` | Same as `pgwire`, but uses IAM authentication. Requires IAM authentication to be enabled on the Aurora PostgreSQL cluster. | APG only |
+| `rdsapi` | Connect to Aurora PostgreSQL using the RDS Data API. Requires the RDS Data API to be enabled on the cluster. | APG only |
 
-1. **RDS Data API Connection** (using `--resource_arn`): Uses the AWS RDS Data API to connect to Aurora PostgreSQL. This method requires that your Aurora cluster has the Data API enabled.
+### Prerequisites by Connection Method
 
-2. **Direct PostgreSQL Connection** (using `--hostname`): Uses psycopg to connect directly to any PostgreSQL database, including Aurora PostgreSQL, RDS PostgreSQL, or self-hosted PostgreSQL instances. This method provides better performance for frequent queries but requires direct network access to the database.
+#### pgwire / pgwire_iam
+- VPC security group must allow inbound connections from your MCP server to the database
+- For `pgwire_iam`: IAM authentication must be enabled on the Aurora PostgreSQL cluster
 
-Choose the connection method that best fits your environment and requirements.
+#### rdsapi
+- RDS Data API must be enabled on the Aurora PostgreSQL cluster
+- Appropriate IAM permissions for Data API access
 
 ### AWS Authentication
 

awslabs_postgres_mcp_server-1.0.11.dist-info/RECORD

@@ -0,0 +1,16 @@
+awslabs/__init__.py,sha256=WuqxdDgUZylWNmVoPKiK7qGsTB_G4UmuXIrJ-VBwDew,731
+awslabs/postgres_mcp_server/__init__.py,sha256=hdq77O7hNe9kS1kzfuuzsMu72sBoHZOFXyRnhcr3TX0,865
+awslabs/postgres_mcp_server/mutable_sql_detector.py,sha256=bivLNglukgfi0IWcQSfDcwxFae4Q8CSvb--yWW617l0,2717
+awslabs/postgres_mcp_server/server.py,sha256=-43tNzPiZqnjEpefV_7NcrVRNq7oMimms33CIcN5f0s,26911
+awslabs/postgres_mcp_server/connection/__init__.py,sha256=ogj0dR6Lbr-WqXqXeRErIM1nlHTs9iqeD_ws6m86Y0E,753
+awslabs/postgres_mcp_server/connection/abstract_db_connection.py,sha256=BGdyRoF1fgjLoFSiWg-XdS0KJ1UKuNgV03gGcRXOG8U,2080
+awslabs/postgres_mcp_server/connection/cp_api_connection.py,sha256=mansXmSROE6_CtQZGLzqKdggyu0rCfeSPd9aQNYgkn0,24498
+awslabs/postgres_mcp_server/connection/db_connection_map.py,sha256=DxFI0er9o_xTcu341f8FavC_AV77RDAiUrH66F8mKxY,4008
+awslabs/postgres_mcp_server/connection/psycopg_pool_connection.py,sha256=p8iFe_1gV4lMxA9OS9IWBBqOww9SS9EFQ6ZVdmq9GSQ,14307
+awslabs/postgres_mcp_server/connection/rds_api_connection.py,sha256=myKQYHhDiY5i0LK0ui0UsBjGCvSgJODdBHLjjTtRyyw,5587
+awslabs_postgres_mcp_server-1.0.11.dist-info/METADATA,sha256=JYRHizqm9YQURNl8dmptKPbk7ma1QBg9PSBYBzR8ovI,8258
+awslabs_postgres_mcp_server-1.0.11.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+awslabs_postgres_mcp_server-1.0.11.dist-info/entry_points.txt,sha256=qHCxq_MTANxTB8-mA7Wl6H71qWEMwmG-I6_koII4AXY,88
+awslabs_postgres_mcp_server-1.0.11.dist-info/licenses/LICENSE,sha256=CeipvOyAZxBGUsFoaFqwkx54aPnIKEtm9a5u2uXxEws,10142
+awslabs_postgres_mcp_server-1.0.11.dist-info/licenses/NOTICE,sha256=qMIIe3h7I1Y4-CKejn50wbSKXEZLWhYHdKaRwKdXN9M,95
+awslabs_postgres_mcp_server-1.0.11.dist-info/RECORD,,

{awslabs_postgres_mcp_server-1.0.9.dist-info → awslabs_postgres_mcp_server-1.0.11.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.27.0
+Generator: hatchling 1.28.0
 Root-Is-Purelib: true
 Tag: py3-none-any

awslabs/postgres_mcp_server/connection/db_connection_singleton.py

@@ -1,117 +0,0 @@
-# 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.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-"""Database connection singleton for postgres MCP Server."""
-
-import asyncio
-from awslabs.postgres_mcp_server.connection.rds_api_connection import RDSDataAPIConnection
-from loguru import logger
-
-
-class DBConnectionSingleton:
-    """Manages a single RDS Data API connection instance across the application."""
-
-    _instance = None
-
-    def __init__(
-        self,
-        resource_arn: str,
-        secret_arn: str,
-        database: str,
-        region: str,
-        readonly: bool = True,
-        is_test: bool = False,
-    ):
-        """Initialize a new DB connection singleton for RDS Data API.
-
-        Args:
-            resource_arn: The ARN of the RDS cluster
-            secret_arn: The ARN of the secret containing credentials
-            database: The name of the database to connect to
-            region: The AWS region where the RDS instance is located
-            readonly: Whether the connection should be read-only (default: True)
-            is_test: Whether this is a test connection (default: False)
-        """
-        if not all([resource_arn, secret_arn, database, region]):
-            raise ValueError(
-                'Missing required connection parameters for RDS Data API. '
-                'Please provide resource_arn, secret_arn, database, and region.'
-            )
-
-        self._db_connection = RDSDataAPIConnection(
-            cluster_arn=resource_arn,
-            secret_arn=secret_arn,
-            database=database,
-            region=region,
-            readonly=readonly,
-            is_test=is_test,
-        )
-
-    @classmethod
-    def initialize(
-        cls,
-        resource_arn: str,
-        secret_arn: str,
-        database: str,
-        region: str,
-        readonly: bool = True,
-        is_test: bool = False,
-    ):
-        """Initialize the singleton instance if it doesn't exist.
-
-        Args:
-            resource_arn: The ARN of the RDS cluster
-            secret_arn: The ARN of the secret containing credentials
-            database: The name of the database to connect to
-            region: The AWS region where the RDS instance is located
-            readonly: Whether the connection should be read-only (default: True)
-            is_test: Whether this is a test connection (default: False)
-        """
-        if cls._instance is None:
-            cls._instance = cls(
-                resource_arn=resource_arn,
-                secret_arn=secret_arn,
-                database=database,
-                region=region,
-                readonly=readonly,
-                is_test=is_test,
-            )
-
-    @classmethod
-    def get(cls):
-        """Get the singleton instance."""
-        if cls._instance is None:
-            raise RuntimeError('DBConnectionSingleton is not initialized.')
-        return cls._instance
-
-    @property
-    def db_connection(self):
-        """Get the database connection."""
-        return self._db_connection
-
-    @classmethod
-    def cleanup(cls):
-        """Clean up resources when shutting down."""
-        if cls._instance and cls._instance._db_connection:
-            # Handle calling async close method from sync context
-            try:
-                loop = asyncio.get_event_loop()
-                if loop.is_running():
-                    # If we're in an async context, create a task
-                    asyncio.create_task(cls._instance._db_connection.close())
-                else:
-                    # If we're in a sync context, run the coroutine to completion
-                    loop.run_until_complete(cls._instance._db_connection.close())
-            except Exception as e:
-                logger.error(f'Error during connection cleanup: {str(e)}')

awslabs_postgres_mcp_server-1.0.9.dist-info/RECORD

@@ -1,15 +0,0 @@
-awslabs/__init__.py,sha256=WuqxdDgUZylWNmVoPKiK7qGsTB_G4UmuXIrJ-VBwDew,731
-awslabs/postgres_mcp_server/__init__.py,sha256=W5_481HOI7iYfOK8foDzV68US73mBfZmPR6LOSS7JcU,673
-awslabs/postgres_mcp_server/mutable_sql_detector.py,sha256=bivLNglukgfi0IWcQSfDcwxFae4Q8CSvb--yWW617l0,2717
-awslabs/postgres_mcp_server/server.py,sha256=wenII8rWhhUVVo-m2C2cPWVwS1S_Us3LUKmKQrr9ebw,11621
-awslabs/postgres_mcp_server/connection/__init__.py,sha256=9j_gZeLcWoXu_Fny1PkC3RsnDMOHr9M3OM9EWvlGR7o,850
-awslabs/postgres_mcp_server/connection/abstract_db_connection.py,sha256=BGdyRoF1fgjLoFSiWg-XdS0KJ1UKuNgV03gGcRXOG8U,2080
-awslabs/postgres_mcp_server/connection/db_connection_singleton.py,sha256=Fwm6uTwB-bhprx-UgiOttDFtczeMUfW5M79wGL0x1Go,4279
-awslabs/postgres_mcp_server/connection/psycopg_pool_connection.py,sha256=qHbRR8-P__v5_-_Q-AQdZVD_nTHj-2Y1p-j1RnKRmrs,12593
-awslabs/postgres_mcp_server/connection/rds_api_connection.py,sha256=1G4qfik5Nu-KbAxRLFNshQ5DJxFnJQI6eqLJPXp-Qn4,5419
-awslabs_postgres_mcp_server-1.0.9.dist-info/METADATA,sha256=2gNeSfP8bN2bbXtFqnJH937jRJ7__eDgYL-xWUkkCDE,8992
-awslabs_postgres_mcp_server-1.0.9.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-awslabs_postgres_mcp_server-1.0.9.dist-info/entry_points.txt,sha256=qHCxq_MTANxTB8-mA7Wl6H71qWEMwmG-I6_koII4AXY,88
-awslabs_postgres_mcp_server-1.0.9.dist-info/licenses/LICENSE,sha256=CeipvOyAZxBGUsFoaFqwkx54aPnIKEtm9a5u2uXxEws,10142
-awslabs_postgres_mcp_server-1.0.9.dist-info/licenses/NOTICE,sha256=qMIIe3h7I1Y4-CKejn50wbSKXEZLWhYHdKaRwKdXN9M,95
-awslabs_postgres_mcp_server-1.0.9.dist-info/RECORD,,