返回 MCP 目录
public公开dns本地运行

Keitaro MCP

Keitaro TDS API的MCP插件,用于Cursor编辑器集成Keitaro的广告跟踪系统功能

article

README

🚀 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
  1. 安装依赖项:
npm install
  1. 将包全局安装:
npm install -g .
  1. 在 Cursor 中安装插件:
node install-cursor-plugin.js
  1. 重启 Cursor

替代方案:在 Cursor 中手动配置

您也可以直接将 Keitaro MCP 服务器添加到您的 Cursor 配置中:

  1. 打开 Cursor MCP 配置文件:
# 在 macOS 上
open ~/.cursor/mcp.json

# 在 Windows 上
notepad %USERPROFILE%\.cursor\mcp.json

# 在 Linux 上
nano ~/.cursor/mcp.json
  1. 将以下条目添加到 "mcpServers" 对象中:
"Keitaro": {
  "command": "mcp-keitaro-tds",
  "args": []
}
  1. 保存文件并重启 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
help

运行方式说明

cloud

托管运行

托管运行通常表示这个 MCP Server 由服务方环境承载,用户一般按页面提供的连接方式或授权流程接入,不需要在本地长期启动一个 MCP 进程

  1. 打开服务方连接页
  2. 完成授权或复制端点
  3. 在 MCP 客户端中连接
terminal

本地运行 / 其它方式

本地运行通常需要用户在自己的电脑或服务器上安装依赖,把 server_config 复制到 MCP 客户端,并按 env_schema 补齐环境变量、密钥或其它配置

  1. 复制 server_config
  2. 安装所需依赖
  3. 补齐环境变量后重启客户端