数据库交互协议

Polardbx-MCP是一个模型上下文协议服务器,提供工具和资源,允许AI代理与阿里云PolarDB-X数据库进行交互。

  • by aliyun
  • JavaScript
  • 本地部署
  • 4 星标
  • 更新于
在 GitHub 查看 aliyun/alibabacloud-polardbx-mcp-server

使用说明

波兰bx mcp

模型上下文协议(MCP)服务器,提供工具和资源,允许AI代理与阿里巴巴云交互 PolarDB-X 数据库。

安装

选项1:从npm安装

# Install globally
npm install -g polardbx-mcp

# Or install in current project only
npm install polardbx-mcp

选项2:从源代码构建

  1. 克隆此存储库:

  2. 安装依赖项并构建:

npm install
npm run build
  1. 在环境变量文件中配置PolarDB-X连接 .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
  1. 启动服务器:
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"
      },
    }
  }
}

从源代码构建时的临床配置示例:

{
  "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查询
  • 检查数据库状态:检查PolarDB-X的状态
  • 显示所有命令:显示PolarDB-X的所有SQL命令

资源

服务器为数据库中的每个表提供架构信息:

  • 表模式(polardbx://<数据库名>/<表名>)
    • 每个表的JSON模式信息
    • 包括列名和数据类型