内容
# polardbx-mcp
一个模型上下文协议（MCP）服务器，提供工具和资源，允许 AI 代理与阿里云 [PolarDB-X](https://github.com/polardb/polardbx-sql) 数据库交互。
## 安装
### 选项 1：从 npm 安装
```bash
# 全局安装
npm install -g polardbx-mcp
# 或仅在当前项目中安装
npm install polardbx-mcp
```
### 选项 2：从源代码构建
1. 克隆此仓库：
2. 安装依赖并构建：
```bash
npm install
npm run build
```
3. 在环境变量文件 `.env` 中配置 PolarDB-X 连接：
```
POLARDB_X_HOST=您的数据库主机
POLARDB_X_PORT=您的数据库端口
POLARDB_X_USER=您的数据库用户名
POLARDB_X_PASSWORD=您的数据库密码
POLARDB_X_DATABASE=您的数据库名称
```
4. 启动服务器：
```bash
npm start
```
## MCP 客户端配置
如果您从 npm 安装，以下是示例客户端配置：
```
{
"mcpServers": {
"polardbx-mcp": {
"command": "npx",
"args": [
"polardbx-mcp"
],
"env": {
"POLARDB_X_HOST": "您的数据库主机",
"POLARDB_X_PORT": "您的数据库端口",
"POLARDB_X_USER": "您的数据库用户名",
"POLARDB_X_PASSWORD": "您的数据库密码",
"POLARDB_X_DATABASE": "您的数据库名称"
},
}
}
}
```
如果您从源代码构建，以下是示例客户端配置：
```
{
"mcpServers": {
"polardbx-mcp": {
"command": "node",
"args": [
"mcp 服务器路径/polardbx-mcp/build/index.js"
],
"env": {
"POLARDB_X_HOST": "您的数据库主机",
"POLARDB_X_PORT": "您的数据库端口",
"POLARDB_X_USER": "您的数据库用户名",
"POLARDB_X_PASSWORD": "您的数据库密码",
"POLARDB_X_DATABASE": "您的数据库名称"
},
}
}
}
```
## MCP 服务器组件
### 工具
- 查询： 在 PolarDB-X 上运行 SQL 查询
- 检查数据库状态： 检查 PolarDB-X 的状态
- 显示所有命令： 显示 PolarDB-X 的所有 SQL 命令
### 资源
服务器提供数据库中每个表的模式信息：
- 表模式（polardbx://<数据库名称>/<表名称>）
- 每个表的 JSON 模式信息
- 包括列名和数据类型
MCP 市场
