Keitaro MCP

by godzilladancer

2 stars
198 downloads
Not rated
GitHub

About

Integration with Keitaro TDS API, providing tools to work with campaigns, streams, offers, and other Keitaro entities.

Details

Author
godzilladancer
Repository
GodzillaDancer/keitaro-mcp
GitHub stars
2
Downloads
198
Categories
AI, API, Developer Tools
Tags
#integration

- List, create, update, and delete campaigns
- Fetch traffic streams and sources
- Manage offers and domains
- Access clicks and conversions
- Generate custom reports with filters
- Works as a standard MCP server with Cursor

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

  1. Download and install Highlight from highlightai.com/download
  2. Navigate to the plugins tab and select "Add Custom Plugin"
  3. Configure the plugin with the settings below
    Plugin Name Keitaro MCP
    Command (node, npx, python, etc.) mcp-keitaro-tds
    Environment
    • KEITARO_API_KEY your-api-key
    • KEITARO_API_URL http://your-keitaro-domain.com/admin_api/v1

    Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.

  4. Enable "Start Automatically" if you want the plugin to start when Highlight launches

From the repository

1. Clone the repository

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

2. Install dependencies

npm install

3. Install the package globally

npm install -g .

4. Install the plugin in Cursor

node install-cursor-plugin.js

5. Restart Cursor

You can also manually add the Keitaro MCP server to your Cursor configuration:

1. Open the Cursor MCP configuration file:


Create an .env file in the project root with the following parameters:


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

1. Launch Cursor
2. Open the command palette (Cmd+P on macOS or Ctrl+P on Windows/Linux)
3. Find "Keitaro" and select it
4. Now you can use the Keitaro API through Cursor

javascript
list_campaigns({
limit: 10,
page: 1,
search: "search query"
})

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

bash
npm run dev
```

list_campaigns

Get a list of campaigns.

get_campaign

Get information about a specific campaign.

create_campaign

Create a new campaign. Parameters: name (string), type (string), cost_type (string), cost_value (number), group_id (number), state (string), traffic_source_id (number).

update_campaign

Update an existing campaign.

delete_campaign

Delete a campaign.

list_streams

Get a list of traffic streams for a campaign.

get_stream

Get information about a specific stream.

list_traffic_sources

Get a list of traffic sources.

get_traffic_source

Get information about a specific traffic source.

list_offers

Get a list of offers.

get_offer

Get information about a specific offer.

list_clicks

Get a list of clicks.

get_click

Get information about a specific click.

list_conversions

Get a list of conversions.

get_conversion

Get information about a specific conversion.

get_report

Generate a report with specified parameters.

list_domains

Get a list of domains.

get_domain

Get information about a specific domain.

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

{
    "mcpServers": {
        "keitaro mcp": {
            "env": {
                "KEITARO_API_KEY": "your-api-key",
                "KEITARO_API_URL": "http://your-keitaro-domain.com/admin_api/v1"
            },
            "args": [],
            "command": "mcp-keitaro-tds"
        }
    }
}

Linux

{
    "env": {
        "KEITARO_API_KEY": "your-api-key",
        "KEITARO_API_URL": "http://your-keitaro-domain.com/admin_api/v1"
    },
    "args": [],
    "command": "mcp-keitaro-tds"
}

Macos

{
    "env": {
        "KEITARO_API_KEY": "your-api-key",
        "KEITARO_API_URL": "http://your-keitaro-domain.com/admin_api/v1"
    },
    "args": [],
    "command": "mcp-keitaro-tds"
}

Windows

{
    "env": {
        "KEITARO_API_KEY": "your-api-key",
        "KEITARO_API_URL": "http://your-keitaro-domain.com/admin_api/v1"
    },
    "args": [],
    "command": "mcp-keitaro-tds"
}

Keitaro TDS API MCP Plugin

Description

MCP server for integration with Keitaro TDS API, providing tools to work with campaigns, streams, offers, and other Keitaro entities.

Installation

Installing the plugin in Cursor

1. Clone the repository

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

2. Install dependencies

npm install

3. Install the package globally

npm install -g .

4. Install the plugin in Cursor

node install-cursor-plugin.js

5. Restart Cursor

Alternative: Manual configuration in Cursor

You can also manually add the Keitaro MCP server to your Cursor configuration:

1. Open the Cursor MCP configuration file:

# On macOS
open ~/.cursor/mcp.json

On Windows

notepad %USERPROFILE%\.cursor\mcp.json

On Linux

nano ~/.cursor/mcp.json

2. Add the following entry to the "mcpServers" object:

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

3. Save the file and restart Cursor

API Key Configuration

Create an .env file in the project root with the following parameters:

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

Usage in Cursor

1. Launch Cursor
2. Open the command palette (Cmd+P on macOS or Ctrl+P on Windows/Linux)
3. Find "Keitaro" and select it
4. Now you can use the Keitaro API through Cursor

Available Tools

Campaigns

- list_campaigns - get a list of campaigns - get_campaign - get information about a specific campaign - create_campaign - create a new campaign - update_campaign - update an existing campaign - delete_campaign - delete a campaign

Traffic Streams

- list_streams - get a list of traffic streams for a campaign - get_stream - get information about a specific stream

Traffic Sources

- list_traffic_sources - get a list of traffic sources - get_traffic_source - get information about a specific traffic source

Offers

- list_offers - get a list of offers - get_offer - get information about a specific offer

Clicks and Conversions

- list_clicks - get a list of clicks - get_click - get information about a specific click - list_conversions - get a list of conversions - get_conversion - get information about a specific conversion

Reports

- get_report - generate a report with specified parameters

Domains

- list_domains - get a list of domains - get_domain - get information about a specific domain

Usage Examples

Getting a list of campaigns

list_campaigns({
  limit: 10,
  page: 1,
  search: "search query"
})

Creating a new campaign

create_campaign({
  name: "New Campaign",
  type: "position",
  cost_type: "CPC",
  cost_value: 1.5,
  group_id: 1,
  state: "active",
  traffic_source_id: 1
})

Getting a report

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

Development

Running in development mode

npm run dev

Testing the MCP server

npm run inspect
No reviews yet — be the first

Sign in to leave a review

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.