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 模式信息
  • 包括列名和數據類型