项目简介

Awesome OceanBase MCP 是一个完整的 MCP 服务器实现集合,专门为 OceanBase 分布式数据库生态系统构建。它通过标准化的 MCP 协议,让 Claude、ChatGPT 等 AI 助手能够安全地访问和管理 OceanBase 数据库及其相关组件。

主要功能

🔧 多服务器支持

  • OceanBase MCP Server: 提供与 OceanBase 数据库的安全交互能力,支持 SQL 查询、数据管理操作
  • OCP MCP Server: 集成 OceanBase 云平台,提供集群管理和监控能力
  • OBCloud MCP Server: 连接 OBCloud 服务,提供云数据库管理功能
  • OKCTL MCP Server: 在 Kubernetes 环境中管理 OceanBase 资源和部署
  • OBDIAG MCP Server: 集成 OceanBase 诊断工具,支持性能分析和故障排查
  • obshell MCP Server: 通过 obshell 实现 OceanBase 集群创建、部署和运维管理
  • seekdb MCP Server: 为 seekdb 数据库提供向量操作、集合管理、SQL 查询和 AI 功能

🚀 核心特性

  • 🤖 AI 友好: 直接在 AI 助手内部进行数据库操作
  • 🔒 安全可靠: 提供安全的数据库访问和操作机制
  • 🛠️ 完整生态: 覆盖完整的 OceanBase 产品和工具链
  • 🎯 即开即用: 简单配置即可开始使用

安装步骤

环境要求

  • Python 3.8+ 或 TypeScript 5.0+
  • OceanBase 数据库实例(可通过官方仓库或在线试用获取)

服务器配置

MCP 客户端需要配置以下信息来连接相应的 MCP 服务器:

OceanBase MCP Server 配置

{
  "name": "oceanbase-mcp-server",
  "command": "python",
  "args": ["-m", "oceanbase_mcp_server", "--transport", "stdio"]
}

OCP MCP Server 配置

{
  "name": "ocp-mcp-server", 
  "command": "python", 
  "args": ["-m", "ocp_mcp", "--transport", "stdio"]
}

OBCloud MCP Server 配置

{
  "name": "obcloud-mcp-server",
  "command": "node",
  "args": ["src/obcloud_mcp_server/src/index.ts"]
}

关键环境变量

  • 'OB_HOST': OceanBase 数据库主机地址
  • 'OB_PORT': 数据库端口(默认 2881)
  • 'OB_USER': 数据库用户名
  • 'OB_PASSWORD': 数据库密码
  • 'OB_DATABASE': 默认数据库
  • 'OCP_URL': OCP 平台地址
  • 'OCP_ACCESS_KEY_ID': OCP 访问密钥 ID
  • 'OCP_ACCESS_KEY_SECRET': OCP 访问密钥
  • 'project': OBCloud 项目 ID
  • 'username': OBCloud 用户名
  • 'password': OBCloud 密码

基本使用方法

  1. 配置连接参数: 设置相应的环境变量
  2. 启动 MCP 服务器: 根据选择的服务器类型运行相应的启动命令
  3. 在 AI 客户端中调用工具: 使用 MCP 协议注册的工具,如执行 SQL、查询集群信息、管理租户等
  4. 与 AI 助手交互: 通过自然语言指令操作 OceanBase 数据库

支持多种传输协议:

  • stdio: 标准输入输出模式
  • sse: Server-Sent Events 模式
  1. 查看资源和监控数据: 通过相应的工具获取数据库状态和性能指标

信息

分类

数据库与文件