Pi Api MCP Server

🚀 PI API 連接器服務器

本項目是一個用於連接 PI API 的 MCP 服務器實現，文檔涵蓋了完整的安裝、配置和使用說明，能幫助用戶快速搭建並使用該服務器。

🚀 快速開始

本項目是用於連接 PI API 的 MCP 服務器實現，下面將為你介紹其安裝、配置和使用方法。

✨ 主要特性

• 提供多種部署方式，包括 Docker 部署、直接執行等。
• 支持不同客戶端配置，如 Node.js 和 Docker 實現。
• 提供常見使用場景的示例查詢。

📦 安裝指南

使用 Docker 部署

# 克隆倉庫（SSH 或 HTTPS）
git clone git@github.com:mingzilla/pi-api-mcp-server.git
cd pi-api-mcp-server

# 安裝依賴項
npm install
./dependencies.sh # 安裝全局依賴以支持 MCP 客戶端通過 "@mingzilla/pi-api-mcp-server" 連接

# 構建項目
npm run build

# 啟動服務器
npm start

直接執行

# 全局安裝
npm install -g @mingzilla/pi-api-mcp-server

# 通過 npx 執行
npx @mingzilla/pi-api-mcp-server --api-url "http://localhost:8224/pi/api/v2" --auth-token "XXXXXXXX"

MCP 客戶端配置

Node.js 實現

• 按照 "本地執行" 部分的說明運行開發服務器。
• 確保已執行 ./dependencies.sh 以安裝所需的全局依賴項。
• 使用以下配置（注意：@mingzilla/pi-api-mcp-server 引用通過 "本地執行" 安裝的包）

{
  "mcpServers": {
    "pi-api": {
      "command": "npx",
      "args": [
        "-y",
        "@mingzilla/pi-api-mcp-server",
        "--api-url",
        "http://localhost:8224/pi/api/v2",
        "--auth-token",
        "XXXXXXXX"
      ],
      "autoApprove": [
        "keep-session-alive",
        "check-connection",
        "authenticate",
        "list-categories",
        "get-category",
        "list-charts",
        "get-chart",
        "export-chart",
        "get-filterable-attributes",
        "export-chart"
      ]
    }
  }
}

Docker 實現

# 拉取鏡像（示例版本）
docker pull mingzilla/pi-api-mcp-server:<VERSION>

# 運行容器
docker run -it --name pi-api-mcp-server mingzilla/pi-api-mcp-server:<VERSION> --api-url "http://localhost:8224/pi/api/v2" --auth-token "XXXXXXXX"

本地開發

# 啟動本地服務器
./start.sh

配置文件示例：

{
  "mcpServers": {
    "pi-api": {
      "command": "node",
      "args": [
        "/home/mingzilla/dev/tool-mcp-pi-api-server/build/index.js",
        "--api-url",
        "http://localhost:8224/pi/api/v2",
        "--auth-token",
        "XXXXXXXX"
      ],
      "autoApprove": [
        "keep-session-alive",
        "check-connection",
        "authenticate",
        "list-categories",
        "get-category",
        "list-charts",
        "get-chart",
        "export-chart",
        "get-filterable-attributes",
        "export-chart"
      ]
    }
  }
}

💻 使用示例

基礎用法

設置 PI API 連接器

# 安裝依賴項
npm install @mingzilla/pi-api-mcp-server

# 創建配置文件
vi config.json

示例查詢

以下是一些常見的使用場景：

查詢分類數據

curl -X GET "http://localhost:8224/categories"

獲取單個分類

curl -X GET "http://localhost:8224/categories/123"

創建新分類

curl -X POST "http://localhost:8224/categories" -H "Content-Type: application/json" -d '{"name":"New Category"}'

📚 詳細文檔

項目結構

pi-api-mcp-server/
├── src/                 # 源代碼目錄
│   ├── index.js        # 入口文件
│   └── routes/         # 路由定義
├── build/              # 構建輸出目錄
├── config/             # 配置文件
└── package.json       # 項目依賴和腳本配置

常見問題

1. 如何安裝依賴項？ 使用以下命令安裝所有依賴項：

npm install

2. 如何啟動服務器？ 構建項目後運行：

npm start

3. 如何配置服務器？ 修改 config.json 文件並重新啟動服務器。

貢獻指南

1. ** Fork 倉庫**
2. ** 提交代碼**
3. ** 創建 Pull Request**

📄 許可證

本項目遵循 MIT 協議。請查看 LICENSE 文件以獲取詳細信息。

如有任何問題，請聯繫 mingzilla@example.com。