PI API MCP サーバー

Name: PI API MCP Server
Author: mingzilla

鍛冶屋のバッジ

PI Dashboard APIと連携するための標準化されたツールとリソースを提供するModel Context Protocol（MCP）サーバー。この実装により、ClaudeをはじめとするMCP対応AIアシスタントは、カテゴリやチャートなどのPI Dashboardリソースに安全にアクセスし、管理できるようになります。

MCPでPIを活用する

以下は、セットアップ完了後のこの MCP サーバーの一般的な使用シナリオを示しています。

初期認証:

接続を確立するには、次の手順を実行してください。

Ensure the PI API MCP server is running Set the API URL to http://localhost:8224/pi/api/v2 Use the authenticate tool for authentication guidance Check the connection status to verify everything is working List two charts from the dashboard

チャート分析:

チャート ID 450 にメタデータ情報が含まれている場合は、次のプロンプトを使用します。

Retrieve the metadata from chart ID 450 Extract the chart JSON data from ID 450 Identify chart IDs associated with claims Obtain JSON data for the identified charts Analyze the data to generate actionable insights

出力例:

例の応答.png

インストール

Smithery経由でインストール

Smithery経由で Claude Desktop 用の pi-api-mcp-server を自動的にインストールするには:

npx -y @smithery/cli install @mingzilla/pi-api-mcp-server --client claude

Related MCP server: Hass-MCP

インストール - Docker の使用 (推奨)

MCPサーバーの設定は不要
MCP クライアント構成ファイルのセットアップ:

{ "mcpServers": { "pi-api": { "command": "docker", "args": [ "run", "-i", "--rm", "-e", "API_URL=http://localhost:8224/pi/api/v2", "-e", "PI_API_KEY=XXXXXXXX", "mingzilla/pi-api-mcp-server" ], "disabled": false, "autoApprove": [ "keep-session-alive", "check-connection", "authenticate", "list-categories", "get-category", "list-charts", "get-chart", "export-chart", "get-filterable-attributes", "export-chart" ] } } }

重要事項：初期化時に--api-urlパラメータが指定されていない場合、サーバーは操作を実行する前にset-api-urlツールを使用して API URL を設定するよう要求します。この設計により、起動時に URL が事前に決定されていない環境でも柔軟な設定が可能になります。

設定ファイルの場所

Claude for Desktop アプリケーションの構成には次の場所からアクセスします。

macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
Windows: %APPDATA%\Claude\claude_desktop_config.json
Linux: 今のところは他のツールを使ってください。例えば、Cline に MCP 構成ファイルを表示するように依頼してください。

利用可能なツール

スキーマ検出

get-filterable-attributes : サンプルエンティティを調べてフィルタリングに使用できる属性のリストを取得します。
Get the filterable attributes for chart entities

接続管理

check-connection : 現在のAPI URLと認証が有効かどうかを確認します
set-api-url : すべてのリクエストのベースAPI URLを設定する
Set the API URL to http://localhost:8224/pi/api/v2

認証

認証: 認証オプションに関するガイダンスを取得する
authenticate-with-credentials : ユーザー名とパスワードで認証する（最後の手段）
keep-session-alive : 現在の認証トークンを検証して更新します（トークンベースの認証にも使用されます）
ログアウト: 現在のトークンを無効にしてセッションを終了する
set-organization : 後続のリクエストの組織IDを設定する

チャート

list-charts : フィルタリングをサポートするすべてのチャートを一覧表示します
get-chart : IDでチャートを取得する
delete-chart : チャートを削除する
export-chart : さまざまな形式でチャートをエクスポートする

利用可能なリソース

auth://status : 認証ステータスを取得する
Categories://list : すべてのカテゴリを一覧表示する
Categories://{id} : 特定のカテゴリを取得する
Categories://{categoryId}/objects : 特定のカテゴリのオブジェクトを取得する
charts://list : すべてのチャートを一覧表示する
charts://{id} : 特定のチャートを取得する
charts://{id}/export/{format} : 特定の形式でチャートをエクスポートする

利用可能なプロンプト

analyze-categories : ダッシュボードでカテゴリを分析する
analyze-charts : ダッシュボードのチャートを分析する
compare-charts : 2つのチャートのデータを比較する
カテゴリ使用分析: チャートでカテゴリがどのように使用されているかを分析する
use-filters : この API でフィルターを効果的に使用する方法を示します

クロード統合例

サーバーに接続した後、Claude で使用するクエリの例を次に示します。

API URLを設定する

Please use the set-api-url tool to set the PI API URL to http://localhost:8224/pi/api/v2

認証

Please help me authenticate to the PI API.

I have a token. Please use the keep-session-alive tool with my token: [YOUR_TOKEN_HERE]

Please check if my connection to the PI API is working properly.

カテゴリーの操作

List all categories in the dashboard.

Get details about category with ID 123.

チャートの操作

List all the charts available in the dashboard.

Export chart with ID 456 as a PDF.

フィルターの使用

Get the filterable attributes for chart entities to understand what fields I can filter on.

List charts with description containing "revenue" using the filter option.

分析プロンプトの使用

Analyze the categories in the dashboard.

Compare data between charts 123 and 456.

Show me how to use filters effectively with this API.

発達

ローカル実行

注: start.shを使用して開発サーバーを実行することもできます。

# Clone the repository (SSH or HTTPS option) git clone git@github.com:mingzilla/pi-api-mcp-server.git cd pi-api-mcp-server # Install dependencies npm install ./dependencies.sh # Installs global dependencies to enable MCP client connection via "@mingzilla/pi-api-mcp-server" # Build the project npm run build # Execute the server npm start

NPMのインストール

# Global installation npm install -g @mingzilla/pi-api-mcp-server # Direct execution via npx npx @mingzilla/pi-api-mcp-server --api-url "http://localhost:8224/pi/api/v2" --auth-token "XXXXXXXX"

MCP クライアント構成

Claude for Desktop との統合:

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" ] } } }

地域開発

./start.shを使用してサーバーを実行する
build/index.jsファイルへのパスを設定してください

./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" ] } } }

開発チェックリスト

コードを更新 -> ローカルサーバーを起動 -> index.js へのファイルパスでローカルサーバーをテスト
readme.md ファイルを更新 -> mcpServers 構成セクションを変更: docker + node + npx
./publish.sh - npm に公開する
./dockerBuild.sh -> ./dockerPublish.sh (package.json と一致するようにバージョン番号を編集) -> docker 構成のテスト
コードをgithubにプッシュする

ライセンス

MITライセンス

著者

ミン・ファン（mingzilla）