alibabacloud-polardbx-mcp-server

🚀 极狐 MCP（PolarDBX - MCP）

极狐 MCP（Model Context Protocol）服务器提供了工具和资源，允许 AI 代理与阿里云 PolarDB - X 数据库进行交互。

🚀 快速开始

本项目为 AI 代理与阿里云 PolarDB - X 数据库的交互提供了便利，通过安装和配置本服务，可实现对 PolarDB - X 数据库的多种操作。

📦 安装指南

选项 1：从 npm 安装

# 全局安装
npm install -g polardbx-mcp

# 或者仅在当前项目中安装
npm install polardbx-mcp

选项 2：从源代码构建

1. 克隆此仓库：
2. 安装依赖并构建：

npm install
npm run build

3. 在环境变量文件 .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

4. 启动服务器：

npm start

💻 使用示例

MCP 客户端配置示例

从 npm 安装的客户端配置示例

{
  "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 查询
• inspect database status：检查 PolarDB - X 的状态
• show all commands：显示 PolarDB - X 的所有 SQL 命令

资源

服务器为数据库中的每个表提供模式信息：

• 表模式（polardbx://<database_name>/<table_name>）
  • 每个表的 JSON 模式信息
  • 包括列名和数据类型