Oceanbase MCP Server

🚀 OceanBase MCP 服务器

OceanBase MCP 服务器是一个用于管理 OceanBase 数据库的工具，它可以列出可用的 OceanBase 表、读取表内容、执行 SQL 查询等，同时通过环境变量实现数据库的安全访问，并提供全面的日志记录功能。

🚀 快速开始

OceanBase MCP 服务器提供了便捷的方式来管理 OceanBase 数据库。你可以通过安装和配置该服务器，轻松实现对数据库的各种操作。

✨ 主要特性

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

📦 安装指南

使用以下命令安装 OceanBase MCP 服务器：

pip install oceanbase-mcp-server

📚 详细文档

配置环境变量

设置以下环境变量以连接到 OceanBase 数据库：

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 用户
• 设置适当的权限
• 监控数据库访问
• 获取安全最佳实践

⚠️ 重要提示

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

贡献流程

1. 复刻仓库
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

📄 许可证

本项目采用 Apache 许可证 - 请参阅 LICENSE 文件以获取详细信息。