Keitaro MCP

🚀 Keitaro TDS API MCP 插件

本插件用於與 Keitaro TDS API 集成的 MCP 服務器，為處理活動、流、優惠以及其他 Keitaro 實體提供了便捷工具。

🚀 快速開始

本插件可幫助您在 Cursor 中集成 Keitaro TDS API，讓您能夠輕鬆處理 Keitaro 相關的各類實體。

✨ 主要特性

• 提供了豐富的工具，可處理活動、流量流、流量來源、優惠、點擊和轉化、報告、域名等 Keitaro 實體。
• 支持在 Cursor 中便捷安裝和使用，同時也提供手動配置的替代方案。

📦 安裝指南

在 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({
  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"]
})

📚 詳細文檔

可用工具

活動

• 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 - 獲取特定域名的信息

🔧 技術細節

開發

運行開發模式

npm run dev

測試服務器

node server.js