Plainsignal MCP

🚀 PlainSignal MCP サーバー

このサーバーは、PlainSignal の分析データに対応した Model Context Protocol (MCP) の実装です。MCP プロトコルを通じて分析レポートや指標を取得するためのツールを提供します。

🚀 クイックスタート

この PlainSignal MCP サーバーは、分析データの取得に便利なツールです。以下に、インストール方法と使用方法を説明します。

📦 インストール

npm からのインストール（推奨）

# グローバルインストール
npm install -g @plainsignal/plainsignal-mcp

# または、プロジェクト内にローカルインストール
npm install @plainsignal/plainsignal-mcp

ソースコードからのインストール

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

npm install

このプロジェクトは ES モジュールを使用しており、CommonJS ではありません。Node.js 14 以上の ES モジュールをサポートするバージョンを使用してください。

💻 使用例

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

# グローバルインストールした場合
plainsignal-mcp --token <あなたのアクセストークン>

# プロジェクト内にローカルインストールした場合
npx plainsignal-mcp --token <あなたのアクセストークン>

# または、環境変数を使用する場合
export PLAINSIGNAL_TOKEN=<あなたのアクセストークン>
plainsignal-mcp

ソースコードから使用する場合

サーバーを起動し、アクセストークンを指定します。

node src/index.js --token <あなたのアクセストークン>

# または、環境変数を使用する場合
export PLAINSIGNAL_TOKEN=<あなたのアクセストークン>
node src/index.js

カスタムの API ベース URL を指定することもできます。

node src/index.js --token <あなたのアクセストークン> --api-base-url <api_base_url>

# または、短縮形式を使用する場合
node src/index.js -t <あなたのアクセストークン> -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

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

getDomains

すべての設定済みドメインをリストします。

インストールと使用の例

例 1：基本的なインストールと使用

# MCP サーバーをグローバルにインストール
npm install -g @plainsignal/plainsignal-mcp

# サーバーを起動し、PlainSignal 分析サービスに接続
node src/index.js --token your_api_token

例 2：カスタム設定

# MCP サーバーをインストール
npm install @plainsignal/plainsignal-mcp

# 設定ファイルを作成
echo '{
  "apiToken": "your_api_token",
  "baseUrl": "https://app.plainsignal.com/api/v1"
}' > config.json

# サーバーを起動
node src/index.js --config config.json

📄 ライセンス

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