OceanBase MCP Server

OceanBase MCP服务器

一种模型上下文协议（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_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用户
• 设置适当的权限
• 监控数据库访问
• 安全最佳实践

⚠️ 重要提示：在配置数据库访问时，始终遵循最小权限原则。

许可证

Apache许可证-有关详细信息，请参阅许可证文件。

贡献

1. 分叉存储库
2. 创建功能分支(git checkout -b feature/amazing-feature)
3. 提交您的更改(git commit -m 'Add some amazing feature')
4. 推到分支(git push origin feature/amazing-feature)
5. 打开拉取请求