OceanBase MCP 服务器

这是一个基于模型上下文协议（MCP）的服务器，用于与 OceanBase 数据库进行安全交互。该服务器允许AI助手通过受控接口列出表、读取数据并执行SQL查询，从而使数据库探索和分析更加安全和结构化。

<a href="https://glama.ai/mcp/servers/@yuanoOo/oceanbase_mcp_server"> <img width="380" height="200" src="https://gips3.baidu.com/it/u=1226733428,1474609031&fm=3081&app=3081&f=PNG?w=760&h=400" alt="OceanBase Server MCP 服务器" /> </a>

特性

• 列出可用的OceanBase表作为资源
• 读取表内容
• 执行SQL查询，并具有适当的错误处理
• 通过环境变量实现安全的数据库访问
• 完整的日志记录

安装

pip install oceanbase-mcp-server

配置

设置以下环境变量：

OB_HOST=localhost     # 数据库主机
OB_PORT=2881         # 可选：数据库端口（未指定时默认为2881）
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"
      }
    }
  }
}

作为独立服务器运行

# 安装依赖项
pip install -r requirements.txt

# 运行服务器
python -m oceanbase_mcp_server

开发

# 克隆仓库
git clone https://github.com/yourusername/oceanbase_mcp_server.git
cd oceanbase_mcp_server

# 创建虚拟环境
python -m venv venv
source venv/bin/activate  # 或者在Windows上使用 `venv\Scripts\activate`

# 安装开发依赖项
pip install -r requirements-dev.txt

# 运行测试
pytest

安全注意事项

• 永远不要提交环境变量或凭据
• 使用具有最小必要权限的数据库用户
• 考虑在生产环境中实施查询白名单
• 监控并记录所有数据库操作

安全最佳实践

此MCP服务器需要数据库访问才能工作。为了安全：

1. 创建一个专用的OceanBase用户，具有最小权限
2. 永远不要使用root凭证或管理账户
3. 限制数据库访问仅限于必要的操作
4. 启用日志记录以供审核
5. 定期审查数据库访问的安全性

参见OceanBase安全配置指南，了解详细说明：

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

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

许可证

Apache许可证 - 详情请参阅LICENSE文件。

贡献

1. 分叉仓库
2. 创建功能分支 (git checkout -b feature/amazing-feature)
3. 提交更改 (git commit -m '添加一些惊人的功能')
4. 推送到分支 (git push origin feature/amazing-feature)
5. 打开拉取请求