OceanBase MCP Server

OceanBase MCP Server

site icon
2025.03.26 2
Python数据库服务数据库中间件数据库
OceanBase MCP Server 是一个模型上下文协议(MCP)服务器,用于安全地与OceanBase数据库进行交互。该服务器允许AI助手通过受控接口列出表、读取数据和执行SQL查询,使数据库探索和分析更加安全和结构化。
View on GitHub

Overview

基本能力

产品定位

OceanBase MCP Server 是一个用于安全交互OceanBase数据库的中间件服务,旨在为AI助手提供结构化的数据库访问能力。

核心功能

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

适用场景

  • AI助手需要查询OceanBase数据库的场景
  • 需要安全可控的数据库访问环境
  • 数据库探索和分析任务

工具列表

  • uv: 用于运行MCP服务器的工具
  • pytest: 用于运行测试的工具

常见问题解答

  • 安全问题:建议创建专用OceanBase用户并遵循最小权限原则
  • 配置问题:需要正确设置环境变量才能连接数据库

使用教程

使用依赖

需要安装Python环境

安装教程

pip install oceanbase-mcp-server

配置环境变量

OB_HOST=localhost     # 数据库主机
OB_PORT=2881         # 可选:数据库端口(默认为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

许可证

该项目遵循 Apache-2.0 开源许可条款,请参阅 Apache-2.0 了解完整条款。