Oceanbase MCP Server

🚀 OceanBase MCP Server

OceanBase MCP Server is a tool that enables users to interact with OceanBase databases, providing functions such as listing available tables, reading table contents, and executing SQL queries.

🚀 Quick Start

To quickly start using OceanBase MCP Server, you need to complete installation and configuration first. The specific steps are as follows:

✨ Features

• List available OceanBase tables as resources.
• Read table contents.
• Execute SQL queries and perform appropriate error handling.
• Achieve secure database access through environment variables.
• 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

Configure Claude Desktop

Add the following content to claude_desktop_config.json:

{
  "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

# Run the server
python -m oceanbase_mcp_server

🔧 Technical Details

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 the production environment.
• Monitor and log all database operations.

Security Best Practices

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

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

For detailed instructions, please refer to the OceanBase Security Configuration Guide to learn how to:

• Create a restricted OceanBase user.
• Set appropriate privileges.
• Monitor database access.
• Obtain security best practices.

⚠️ Important Note

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

📄 License

This project is under the Apache License - see the LICENSE file for details.

Contribution

1. Fork the repository.
2. Create a 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.