OceanBase MCP Server

OceanBase MCP 服务

一个 Model Context Protocol（MCP）服务，可安全地与 OceanBase 数据库交互。 此服务允许 AI 助手通过受控接口列出表、读取数据和执行 SQL 查询，让数据库探索和分析更加安全、规范。

功能

• 将可用的 OceanBase 表列为资源
• 读取表内容
• 执行 SQL 查询并妥善处理错误
• 通过环境变量安全地访问数据库
• 全面的日志记录

安装

pip install oceanbase-mcp-server

配置

设置以下环境变量：

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

使用方法

配合 Claude Desktop 使用

将以下内容添加到你的 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"
      }
    }
  }
}

作为独立服务运行

# Install dependencies
pip install -r requirements.txt

# Run the server
python -m oceanbase_mcp_server

开发

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

# Create 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

安全注意事项

• 切勿提交环境变量或凭据
• 使用仅具备所需最低权限的数据库用户
• 考虑在生产环境中实现查询白名单
• 监控并记录所有数据库操作

安全最佳实践

此 MCP 服务需要访问数据库才能运行。为确保安全：

1. 创建专用的 OceanBase 用户，并仅授予最低权限
2. 切勿使用 root 凭据或管理员账户
3. 将数据库访问权限限制为仅限必要操作
4. 启用日志记录以便审计
5. 定期审查数据库访问安全性

请参阅 OceanBase 安全配置指南，了解以下内容的详细说明：

• 创建受限的 OceanBase 用户
• 设置适当的权限
• 监控数据库访问
• 安全最佳实践

⚠️ IMPORTANT：配置数据库访问时，务必遵循最小权限原则。

许可证

Apache License——详情请参阅 LICENSE 文件。

贡献

1. Fork 此仓库
2. 创建功能分支（git checkout -b feature/amazing-feature）
3. 提交更改（git commit -m 'Add some amazing feature'）
4. 推送到分支（git push origin feature/amazing-feature）
5. 创建 Pull Request