Keitaro TDS API MCP 插件

描述

用于与 Keitaro TDS API 集成的 MCP 服务器，提供工具来处理活动、流量流、优惠以及其他 Keitaro 实体。

安装

在 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 密钥配置

在项目根目录创建一个 .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: 1
, page: 1
, search: "搜索查询"
})

创建新活动

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

获取报告

get_report({
  from: "2025-01-01"
, to: "2025-01-31"
, group: "活动"
, filters: {
    campaign_id: 123
  }
})

开发

在开发模式下运行

npm run dev

测试 MCP 服务器

npm run inspect