Metadata-Version: 2.4
Name: iflow-mcp_neoai-agent-rds-mcp
Version: 0.1.0
Summary: A Model-Controlled Panel for managing Amazon RDS instances
Home-page: https://github.com/neoai-agent/rds-mcp
Author: RDS MCP Contributors
Author-email: neoai.agent@gmail.com
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
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.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: mcp-server==0.1.4
Requires-Dist: boto3==1.40.0
Requires-Dist: anyio==4.5.0
Requires-Dist: litellm==1.75.0
Requires-Dist: backoff==2.2.0
Provides-Extra: dev
Requires-Dist: pytest==8.3.4; extra == "dev"
Requires-Dist: black==25.1.0; extra == "dev"
Requires-Dist: isort==6.0.0; extra == "dev"
Requires-Dist: ruff==0.9.4; extra == "dev"
Requires-Dist: build==1.1.0; extra == "dev"
Requires-Dist: twine==6.1.0; extra == "dev"
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license-file
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# RDS MCP Server

A Model Context Protocol (MCP) server for monitoring and analyzing Amazon RDS(MySQL, PostgreSQL) instances information, metrics and slowquery logs.

## Installation

Install directly from GitHub using pipx:

```bash
# Install
pipx install git+https://github.com/neoai-agent/rds-mcp.git

# Or run without installation
pipx run git+https://github.com/neoai-agent/rds-mcp.git
```

## Quick Start

### Authentication Options

The server supports multiple AWS authentication methods:

#### Option 1: IAM Roles (Recommended for EC2/ECS)
When running on AWS infrastructure with IAM roles attached, you can omit AWS credentials:

```bash
rds-mcp --openai-api-key "YOUR_OPENAI_API_KEY" --region "YOUR_AWS_REGION"
```

#### Option 2: AWS Access Keys
For local development or when IAM roles are not available:

```bash
rds-mcp --access-key "YOUR_AWS_ACCESS_KEY" --secret-access-key "YOUR_AWS_SECRET_KEY" --region "YOUR_AWS_REGION" --openai-api-key "YOUR_OPENAI_API_KEY"
```

#### Option 3: Environment Variables
You can also set AWS credentials via environment variables:
```bash
rds-mcp --access-key "YOUR_AWS_ACCESS_KEY" --secret-access-key "YOUR_AWS_SECRET_KEY" --region "YOUR_AWS_REGION" --openai_api_key "YOUR_OPENAI_API_KEY"
```

**Note**: When using IAM roles, the server will automatically use the default AWS credential chain, which includes IAM roles, environment variables, and AWS credentials file.

## Available Tools

The server provides the following tools for RDS instance management and monitoring:

1. Get RDS instance details:
```python
await get_db_info(
    database_name="your-db-instance",
    region="your-aws-region"
)
```

2. Get database metrics:
```python
await get_database_metrics(
    database_name="your-db-instance",
    time_range_minutes=30
)
```

3. Get slow queries:
```python
await get_database_queries(
    database_name="your-db-instance",
    time_range_minutes=30
)
```

4. Get instance performance metrics:
```python
await get_top_rds_load(
    database_name="your-db-instance",
    time_range_minutes=30
)
```

## Development

For development setup:
```bash
git clone https://github.com/neoai-agent/rds-mcp.git
cd rds-mcp
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
pip install -e ".[dev]"
```

## License

MIT License - See [LICENSE](LICENSE) file for details 
