Pi Api MCP Server

🚀 PI API コネクタサーバー

このプロジェクトは、PI API を接続するための MCP サーバーの実装です。ドキュメントには、完全なインストール、設定、および使用方法の説明が含まれています。

🚀 クイックスタート

このサーバーは、PI API との接続を容易にするための MCP サーバーです。以下の手順に従って、インストール、設定、および使用を行うことができます。

✨ 主な機能

• PI API との接続を実現する MCP サーバーの実装
• Docker を使用した簡単なデプロイ
• 複数の実行方法（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 までご連絡ください。