Keitaro MCP

🚀 Keitaro TDS API MCP プラグイン

このプラグインは、Keitaro TDS API と統合するための MCP サーバーです。キャンペーン、トラフィックストリーム、オファーなどの Keitaro エンティティを処理するツールを提供します。

🚀 クイックスタート

このセクションでは、Keitaro TDS API MCP プラグインのインストール、設定、および使用方法について説明します。

📦 インストール

Cursor でのプラグインのインストール

1. リポジトリをクローンします。

git clone <repository-url>
cd mcp-keitaro-tds

2. 依存関係をインストールします。

npm install

3. パッケージをグローバルにインストールします。

npm install -g .

4. Cursor でプラグインをインストールします。

node install-cursor-plugin.js

5. Cursor を再起動します。

代替方法：Cursor での手動設定

Keitaro MCP サーバーを直接 Cursor の設定に追加することもできます。

1. Cursor MCP 設定ファイルを開きます。

# macOS の場合
open ~/.cursor/mcp.json

# Windows の場合
notepad %USERPROFILE%\.cursor\mcp.json

# Linux の場合
nano ~/.cursor/mcp.json

2. "mcpServers" オブジェクトに以下のエントリを追加します。

"Keitaro": {
  "command": "mcp-keitaro-tds",
  "args": []
}

3. ファイルを保存し、Cursor を再起動します。

API Key の設定

プロジェクトのルートディレクトリに .env ファイルを作成し、以下のパラメータを追加します。

KEITARO_API_URL=http://your-keitaro-domain.com/admin_api/v1
KEITARO_API_KEY=your-api-key

💻 使用例

Cursor での使用方法

1. Cursor を起動します。
2. コマンドパネルを開きます（macOS では Cmd+P、Windows/Linux では Ctrl+P）。
3. "Keitaro" を検索して選択します。
4. これで、Cursor を通じて Keitaro API を使用できます。

利用可能なツール

キャンペーン

• list_campaigns - キャンペーンのリストを取得します。
• get_campaign - 特定のキャンペーンの情報を取得します。
• create_campaign - 新しいキャンペーンを作成します。
• update_campaign - 既存のキャンペーンを更新します。
• delete_campaign - キャンペーンを削除します。

トラフィックストリーム

• list_streams - キャンペーンのトラフィックストリームのリストを取得します。
• get_stream - 特定のトラフィックストリームの情報を取得します。

トラフィックソース

• list_traffic_sources - トラフィックソースのリストを取得します。
• get_traffic_source - 特定のトラフィックソースの情報を取得します。

オファー

• list_offers - オファーのリストを取得します。
• get_offer - 特定のオファーの情報を取得します。

クリックとコンバージョン

• list_clicks - クリックのリストを取得します。
• get_click - 特定のクリックの情報を取得します。
• list_conversions - コンバージョンのリストを取得します。
• get_conversion - 特定のコンバージョンの情報を取得します。

レポート

• get_report - 指定されたパラメータを使用してレポートを生成します。

ドメイン

• list_domains - ドメインのリストを取得します。
• get_domain - 特定のドメインの情報を取得します。

基本的な使用法

キャンペーンのリストを取得する

list_campaigns({
  limit: 10,
  page: 1,
  search: "搜索查询"
})

新しいキャンペーンを作成する

create_campaign({
  name: "新活动",
  type: "位置",
  cost_type: "CPC",
  cost_value: 1.5,
  group_id: 1,
  state: "active",
  traffic_source_id: 1
})

レポートを取得する

get_report({
  from: "2025-01-01",
  to: "2025-01-31",
  metrics: ["clicks", "impressions", "conversions"]
})

🔧 技術詳細

開発モードでの実行

npm run dev

サーバーのテスト

node server.js