使用说明

项目简介

OceanBase MCP Server 是一个基于 Model Context Protocol (MCP) 构建的后端服务，旨在为大型语言模型 (LLM) 客户端提供与 OceanBase 数据库安全交互的能力。它允许 LLM 应用通过标准化的 MCP 协议访问 OceanBase 数据库中的数据，并执行 SQL 查询等操作，从而扩展 LLM 的上下文理解和功能执行范围。

主要功能点

资源 (Resources) 管理: 将 OceanBase 数据库中的表结构以资源的形式暴露给 LLM 客户端，方便客户端了解和访问数据库中的数据。
数据访问: 允许 LLM 客户端读取 OceanBase 数据库中指定表的数据内容。
工具 (Tools) 执行: 提供 'execute_sql' 工具，允许 LLM 客户端通过服务器在 OceanBase 数据库上执行 SQL 查询，并获取查询结果。

安装步骤

环境准备: 确保您的机器上已安装 Python 环境。建议使用 Python 3.8 或更高版本。

克隆仓库: 使用 Git 克隆 'mcp-oceanbase' 仓库到本地：

git clone https://github.com/oceanbase/mcp-oceanbase.git
cd mcp-oceanbase

安装依赖: 安装项目依赖的 Python 包。由于仓库中没有 'requirements.txt' 文件，根据代码分析，您需要安装 'mcp-server-sdk' 和 'mysql-connector-python' 包。
```
pip install mcp-server-sdk mysql-connector-python
```

服务器配置

MCP 客户端需要配置以下 JSON 格式的信息以连接到 OceanBase MCP Server。请根据您的实际环境配置进行修改：

{
  "serverName": "oceanbase-mcp-server",
  "command": "python",
  "args": ["-m", "oceanbase_mcp_server.server"]
}

配置参数说明：

'serverName': MCP 服务器的名称，您可以自定义设置，用于在客户端标识该服务器。例如: '"oceanbase-mcp-server"'。
'command': 启动 MCP 服务器的命令。由于服务器是 Python 实现，这里设置为 '"python"'，表示使用 Python 解释器来运行服务器代码。
'args': 传递给 'command' 的参数，用于指定要运行的 Python 模块。'["-m", "oceanbase_mcp_server.server"]' 表示运行 'oceanbase_mcp_server' 包中的 'server.py' 模块，即启动 OceanBase MCP Server。

环境变量配置 (重要)：

OceanBase MCP Server 依赖以下环境变量来配置数据库连接信息。请务必根据您的 OceanBase 数据库实际配置进行设置，否则服务器将无法正常连接数据库。

| 环境变量名 | 描述 | 是否必须 | 默认值 | |-------------|------------------------------------------|--------|-------------| | 'OB_HOST' | OceanBase 数据库主机地址 | 否 | 'localhost' | | 'OB_PORT' | OceanBase 数据库端口号 | 否 | '2881' | | 'OB_USER' | OceanBase 数据库用户名 | 是 | 无 | | 'OB_PASSWORD'| OceanBase 数据库密码 | 是 | 无 | | 'OB_DATABASE'| OceanBase 数据库名 | 是 | 无 |

您可以通过以下方式设置环境变量（以 Linux/macOS 为例）：

export OB_HOST=your_oceanbase_host
export OB_PORT=your_oceanbase_port
export OB_USER=your_oceanbase_user
export OB_PASSWORD=your_oceanbase_password
export OB_DATABASE=your_oceanbase_database

请将 'your_oceanbase_host'、'your_oceanbase_port'、'your_oceanbase_user'、'your_oceanbase_password' 和 'your_oceanbase_database' 替换为您的实际 OceanBase 数据库连接信息。

基本使用方法

启动服务器: 在配置好环境变量后，在仓库根目录下运行以下命令启动 OceanBase MCP Server：
```
python -m oceanbase_mcp_server.server
```
服务器成功启动后，将监听 MCP 客户端的请求。
客户端交互: 在 MCP 客户端中，配置上述服务器连接信息，客户端即可通过 MCP 协议与 OceanBase MCP Server 进行交互，例如：
- 调用 'listResources' 方法，服务器会返回 OceanBase 数据库中的表列表。
- 调用 'readResource' 方法，并提供 'oceanbase://表名/data' 格式的 URI，服务器会返回指定表的数据。
- 调用 'callTool' 方法，并指定工具名为 'execute_sql'，同时在 'arguments' 中提供 SQL 查询语句，服务器会在 OceanBase 数据库上执行该 SQL 查询，并将结果返回给客户端。

请参考 MCP 协议文档和您的 MCP 客户端使用说明，了解如何配置和使用 MCP 服务器。

关键词