PlainSignal MCP Server

PlainSignal MCP サーバー

これは、PlainSignal の分析データ向けの Model Context Protocol（MCP）サーバー実装です。MCP プロトコルを通じて、分析レポートや指標を取得するツールを提供します。

セットアップ

インストール

npm から（推奨）

# Install globally
npm install -g @plainsignal/plainsignal-mcp

# Or install locally in your project
npm install @plainsignal/plainsignal-mcp

ソースから

1. このリポジトリをクローンします
2. 依存関係をインストールします。

npm install

このプロジェクトでは CommonJS ではなく ES モジュールを使用しています。ES モジュールに対応したバージョンの Node.js（Node.js 14 以降）を使用してください。

使用方法

npm からインストールした場合

# If installed globally
plainsignal-mcp --token <your_access_token>

# If installed locally
npx plainsignal-mcp --token <your_access_token>

# Or using an environment variable
export PLAINSIGNAL_TOKEN=<your_access_token>
plainsignal-mcp

ソースから使用する場合

アクセストークンを指定してサーバーを実行します。

node src/index.js --token <your_access_token>

# Or using an environment variable
export PLAINSIGNAL_TOKEN=<your_access_token>
node src/index.js

カスタム API ベース URL も指定できます。

node src/index.js --token <your_access_token> --api-base-url <api_base_url>

または、短縮形式を使用できます。

node src/index.js -t <your_access_token> -u <api_base_url>

代わりに、アクセストークンと API ベース URL を環境変数として設定し、テストスクリプトを使用することもできます。

export PLAINSIGNAL_TOKEN=your_access_token
export API_BASE_URL=https://app.plainsignal.com/api/v1
./test.sh

デフォルトでは、サーバーは https://app.plainsignal.com/api/v1 に接続します。

MCP サーバーの設定

Claude Desktop

このスニペットを claude_desktop_config.json に追加します。

{
  "mcpServers": {
    "plainsignal": {
      "command": "npx -y @plainsignal/plainsignal-mcp",
      "env": {
        "PLAINSIGNAL_TOKEN": "<YOUR_PLAINSIGNAL_TOKEN>"
      }
    }
  }
}

利用可能なツール

サーバーは次のツールを提供します。

getReport

指定したドメインと期間の分析レポートを取得します。

パラメーター：

• organizationID：組織 ID
• domainID：ドメイン ID
• periodFrom：RFC3339 形式のレポート開始日時
• periodTo：RFC3339 形式のレポート終了日時
• periodSelection：期間の種類（m：月、y：年、d：日）
• aggregationWindow：データの集計間隔（h：時間、d：日）
• filters：（任意）キーと値のペアで指定するフィルターのリスト

getSubReport

分析データの特定の項目に関する詳細な指標を取得します。

パラメーター：

• organizationID：組織 ID
• domainID：ドメイン ID
• periodFrom：RFC3339 形式のレポート開始日時
• periodTo：RFC3339 形式のレポート終了日時
• periodSelection：期間の種類（m：月、y：年、d：日）
• aggregationWindow：データの集計間隔（h：時間、d：日）
• subReportType：レポートの種類（1：ページ、2：ランディングページなど）
• filters：（任意）キーと値のペアで指定するフィルターのリスト
• pagination：（任意）件数制限とオフセットを指定するページネーション設定

API リファレンス

このサーバーは PlainSignal API と通信します。デフォルトでは https://app.plainsignal.com/api/v1 に接続しますが、API エンドポイントは次の方法で設定できます。

1. --api-base-url コマンドラインオプションを使用します。

   node src/index.js --token <your_token> --api-base-url https://app.plainsignal.com/api/v1
   

2. API_BASE_URL 環境変数を設定します。

   export API_BASE_URL=https://app.plainsignal.com/api/v1
   

3. プログラムからサーバーをインスタンス化する際に、コンストラクターへカスタム API ベース URL を渡します。

   const server = new PlainSignalStdioServer(token, 'https://app.plainsignal.com/api/v1');
   

開発者向け

このサーバーは MCP SDK を使用して実装されており、STDIO 経由で通信します。

例

MCP サーバーの使用方法を示すサンプルクライアントが用意されています。

# Set your access token
export PLAINSIGNAL_TOKEN=your_access_token

# Run the example client
npm run example

または、リソース用のサンプルクライアントを実行します。

# Set your access token
export PLAINSIGNAL_TOKEN=your_access_token

# Run the resources example client
npm run resources-example

サンプルクライアントでは、次の方法を紹介します。

1. MCP サーバーに接続する
2. 利用可能なツールを一覧表示する
3. サンプルパラメーターを使って getReport ツールを呼び出す
4. 結果を処理して表示する

リソース用のサンプルクライアントでは、次の方法を紹介します。

1. MCP サーバーに接続する
2. 利用可能なリソースを一覧表示する
3. listDomains リソースを読み取る
4. 結果を処理して表示する

ライセンス

このプロジェクトは MIT ライセンスのもとでライセンスされています。詳細については LICENSE ファイルを参照してください。