Oceanbase

🚀 OceanBase MCP 服务器

OceanBase MCP 服务器能够列出 OceanBase 表资源、读取表内容、执行 SQL 查询，还支持通过环境变量安全访问数据库，同时具备全面的日志记录功能，为数据库操作提供便利与安全保障。

✨ 主要特性

• 列出可用的 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  # 或 `venv\Scripts\activate` 在 Windows 上

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

# 运行测试
pytest

⚠️ 安全注意事项

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

🌟 安全最佳实践

此 MCP 服务器需要数据库访问权限才能运行。出于安全考虑：

1. 创建一个专用的 OceanBase 用户，并赋予最小的权限
2. 不要使用 root 凭据 或管理账户
3. 限制数据库访问，使其仅限于必要的操作
4. 启用日志记录 以进行审核
5. 定期进行安全审查 以检查数据库访问情况

请参阅 OceanBase 安全配置指南 以了解详细说明：

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

⚠️ 重要提示

在配置数据库访问时，始终遵循最小特权原则。

📄 许可证

Apache License - 有关详细信息，请参阅 LICENSE 文件。

🤝 贡献指南

1. 分叉仓库
2. 创建你的功能分支（git checkout -b feature/amazing-feature）
3. 提交你的更改（git commit -m 'Add some amazing feature'）
4. 推送到分支（git push origin feature/amazing-feature）
5. 打开一个拉取请求