Oceanbase

🚀 OceanBase MCP Server

This project offers functionalities to interact with OceanBase databases, including listing tables, reading table contents, executing SQL queries, and ensuring secure access through environment variables.

✨ Features

• List available OceanBase tables as resources.
• Read table contents.
• Execute SQL queries with appropriate error handling.
• Enable secure database access via environment variables.
• Provide comprehensive logging.

📦 Installation

pip install oceanbase-mcp-server

🛠️ Configuration

Set the following environment variables:

OB_HOST=localhost     # Database host
OB_PORT=2881         # Optional: Database port (default is 2881 if not specified)
OB_USER=your_username
OB_PASSWORD=your_password
OB_DATABASE=your_database

💻 Usage Examples

Use in Claude Desktop

Add the following content to your claude_desktop_config.json file:

{
  "mcpServers": {
    "oceanbase": {
      "command": "uv",
      "args": [
        "--directory", 
        "path/to/oceanbase_mcp_server",
        "run",
        "oceanbase_mcp_server"
      ],
      "env": {
        "OB_HOST": "localhost",
        "OB_PORT": "2881",
        "OB_USER": "your_username",
        "OB_PASSWORD": "your_password",
        "OB_DATABASE": "your_database"
      }
    }
  }
}

Run as an Independent Server

# Install dependencies
pip install -r requirements.txt

# Start the server
python -m oceanbase_mcp_server

👨‍💻 Development

# Clone the repository
git clone https://github.com/yourusername/oceanbase_mcp_server.git
cd oceanbase_mcp_server

# Create a virtual environment
python -m venv venv
source venv/bin/activate  # Or `venv\Scripts\activate` on Windows

# Install development dependencies
pip install -r requirements-dev.txt

# Run tests
pytest

⚠️ Security Precautions

• Never commit environment variables or credentials.
• Use a database user with minimal privileges.
• Consider implementing a query whitelist in a production environment.
• Monitor and log all database operations.

🔒 Security Best Practices

This MCP server requires database access to run. For security reasons:

1. Create a dedicated OceanBase user and grant minimal privileges.
2. Do not use root credentials or administrative accounts.
3. Restrict database access to only necessary operations.
4. Enable logging for auditing.
5. Conduct regular security reviews to check database access.

Refer to the OceanBase Security Configuration Guide for detailed instructions:

• Create a restricted OceanBase user.
• Set appropriate permissions.
• Monitor database access.
• Follow security best practices.

⚠️ Important Note

Always follow the principle of least privilege when configuring database access.

📄 License

Apache License - See the LICENSE file for details.

🤝 Contribution Guidelines

1. Fork the repository.
2. Create your feature branch (git checkout -b feature/amazing-feature).
3. Commit your changes (git commit -m 'Add some amazing feature').
4. Push to the branch (git push origin feature/amazing-feature).
5. Open a pull request.