Keitaro MCP

🚀 Keitaro TDS API MCP 插件

本插件用于与 Keitaro TDS API 集成的 MCP 服务器，提供了处理活动、流、优惠和其他 Keitaro 实体的工具，能帮助开发者更便捷地与 Keitaro 系统进行交互。

🚀 快速开始

本插件可助力开发者轻松与 Keitaro TDS API 集成，以下是详细的使用步骤。

✨ 主要特性

• 功能丰富：提供了处理活动、流量流、流量来源、优惠、点击和转化、报告、域名等多种 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

💻 使用示例

基础用法

获取活动列表

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",
  filter: "特定过滤条件"
})

🔧 技术细节

在开发模式下运行

npm run dev

测试 MCP 服务器

npm test

📚 详细文档

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