关于 polardbx-mcp
polardbx-mcp 是面向 Alibaba Cloud PolarDB-X 数据库的 MCP 服务,供 AI Agent 访问数据库。它提供 SQL 查询、状态检查和命令查看工具,并通过资源呈现表结构信息。
主要功能
- 01运行 PolarDB-X SQL 查询
- 02检查数据库状态
- 03查看 PolarDB-X SQL 命令
- 04提供表结构资源
- 05展示列名和数据类型
适用场景
- 01通过 Agent 查询 PolarDB-X 数据
- 02检查 PolarDB-X 数据库状态
- 03获取数据库表的列和类型信息
MCP 相关
该 MCP 服务为客户端提供 PolarDB-X 查询、状态检查和命令查看工具,并提供包含列名与数据类型的表结构资源。
配置
本地服务的配置在各客户端中通用,复制后粘贴到客户端的 MCP 配置文件即可。
工具
还没有获取到工具列表
本地服务需要在你的电脑上运行后才能读取工具,维护者暂未提供工具列表。
详细介绍
polardbx-mcp
一个模型上下文协议(MCP)服务,提供工具和资源,使 AI Agent 能够与阿里云 PolarDB-X 数据库交互。
安装
选项 1:从 npm 安装
# Install globally
npm install -g polardbx-mcp
# Or install in current project only
npm install polardbx-mcp
选项 2:从源代码构建
-
克隆此仓库:
-
安装依赖并构建:
npm install
npm run build
- 在环境变量文件
.env中配置 PolarDB-X 连接:
POLARDB_X_HOST=your_database_host
POLARDB_X_PORT=your_database_port
POLARDB_X_USER=your_database_user
POLARDB_X_PASSWORD=your_database_password
POLARDB_X_DATABASE=your_database_name
- 启动服务:
npm start
MCP 客户端配置
从 npm 安装时的 Cline 配置示例:
{
"mcpServers": {
"polardbx-mcp": {
"command": "npx",
"args": [
"polardbx-mcp"
],
"env": {
"POLARDB_X_HOST": "your_database_host",
"POLARDB_X_PORT": "your_database_port",
"POLARDB_X_USER": "your_database_user",
"POLARDB_X_PASSWORD": "your_database_password",
"POLARDB_X_DATABASE": "your_database_name"
},
}
}
}
从源代码构建时的 Cline 配置示例:
{
"mcpServers": {
"polardbx-mcp": {
"command": "node",
"args": [
"path_to_mcp/polardbx-mcp/build/index.js"
],
"env": {
"POLARDB_X_HOST": "your_database_host",
"POLARDB_X_PORT": "your_database_port",
"POLARDB_X_USER": "your_database_user",
"POLARDB_X_PASSWORD": "your_database_password",
"POLARDB_X_DATABASE": "your_database_name"
},
}
}
}
MCP 服务组件
工具
- query:在 PolarDB-X 上运行 SQL 查询
- inspect database status:检查 PolarDB-X 的状态
- show all commands:显示 PolarDB-X 的所有 SQL 命令
资源
该服务为数据库中的每个表提供架构信息:
- 表架构(polardbx://<database_name>/<table_name>)
- 每个表的 JSON 架构信息
- 包含列名和数据类型
评论
支持 Markdown
一个开放协议,规定了 AI 应用如何以统一方式连接外部工具与数据源。客户端负责与模型对话,MCP 服务负责提供工具、资源和提示模板,两者通过标准消息通信,同一个服务可以被不同客户端复用。