> ## Documentation Index
> Fetch the complete documentation index at: https://developers.everflow.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

> Connect AI agents to your own partner account on Everflow: your offers, performance, activity, invoices and payments, asked for in plain language.

<Note>
  **Private beta.** The Affiliate MCP is in a private beta and is read-only. Your network manages access: it enables the MCP for your account, one partner at a time, and issues your Affiliate API key, so reach out to them to get started. If your connection is refused with "MCP is not enabled for your account. Ask your network to enable it.", your account is not enabled yet, and your network can do that for you.
</Note>

<Note>
  **EU-Hosted Accounts:** Use `https://mcp-eu.eflow.team/affiliate` instead of `https://mcp.eflow.team/affiliate`. Everything else is identical.
</Note>

The Affiliate MCP lets a partner query their own account through natural language. You connect an MCP-compatible client (Claude, Cursor, VS Code Copilot) and ask questions such as "How did my offers perform last week?", "Which offers can I run?", "Show me my conversions from yesterday" or "What is the balance on my latest invoice?".

<Note>
  **This is the Affiliate MCP**: it exposes **one partner's** view of their account with a network, and authenticates with an **Affiliate API key**. It returns your own data only. Network operators use the [Network MCP](/ai-automation/mcp/overview), which takes a Network API key.
</Note>

## Server details

The server shares the `mcp.eflow.team` host with the Network MCP and is mounted at its own path, `/affiliate`.

| | |
| - | - |
| **Server URL (US)** | `https://mcp.eflow.team/affiliate` |
| **Server URL (EU)** | `https://mcp-eu.eflow.team/affiliate` |
| **Transport** | Streamable HTTP |
| **Auth header** | `X-Eflow-API-Key: <your-affiliate-api-key>` |
| **Auth header (alias)** | `X-Api-Key: <your-affiliate-api-key>`, identical behavior, for clients that only accept standard header names |
| **Tool list (REST)** | `GET https://mcp.eflow.team/affiliate/tools/list`, with the same header and access |

<Warning>
  The two servers do not accept each other's keys. A Network API key sent to `/affiliate`, or an Affiliate API key sent to the root URL, is refused with `403`. Use the URL that matches your key.
</Warning>

Your network issues your Affiliate API key. It identifies you as a partner, and every request is scoped to you by the server: there is no argument that lets a request name another partner.

## Connect a client

Use the server URL above and send your key in the `X-Eflow-API-Key` header (or `X-Api-Key` where a client only accepts standard names). For Claude Desktop, add the server to the `mcpServers` block of `claude_desktop_config.json`:

```json theme={null}
{
  "mcpServers": {
    "everflow-partner": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-remote",
        "https://mcp.eflow.team/affiliate",
        "--header",
        "X-Eflow-API-Key:your-affiliate-api-key"
      ]
    }
  }
}
```

<Tip>
  The `--header` value uses `Name:Value` with **no space** after the colon. `X-Eflow-API-Key: your-key` (with a space) fails.
</Tip>

Other clients (Claude.ai connectors, Cursor, VS Code) take the same URL and header in their own server settings. Restart the client after saving, then ask it what Everflow tools it has: you should see the 12 tools below.

## The 12 tools

| Tool | What it does |
| - | - |
| `get_account_info` | The network you work with, your currency and timezone, your account manager and billing setup |
| `get_report_schema` | Every dimension, filter and metric you can use in a report, as allowed for your account |
| `run_performance_report` | Your clicks, conversions and payout grouped by offer, date, country, sub id and more |
| `list_offers` | The offers you can see, with your default payout and your application status |
| `get_offer` | One or several offers: a small core, plus optional payout events, caps, targeting, description, tracking link, URLs, creatives and integrations |
| `get_entity_schema` | The entity types you can list with `list_entities` (today `category` and `channel`), and the filters of each |
| `list_entities` | The categories and channels of your network, to learn the exact names `list_offers` filters by |
| `search_activity` | Your raw clicks or conversions, one record per row |
| `list_invoices` | Your invoices, with billed, paid and balance |
| `get_invoice` | One invoice with its line items and payments |
| `list_payments` | Payments made to you |
| `search_documentation` | Search the Affiliate API and Affiliate MCP documentation |

Full parameters, filters and response fields are on [Tools](/ai-automation/affiliate-mcp/tools).

## What you can see matches the Partner Platform

The Affiliate MCP applies the same visibility rules as your network's Partner Platform, enforced on the server. Anything the portal does not show you is also absent here. A hidden report dimension, filter or metric is refused rather than ignored; a hidden part of an offer, such as its caps or tracking link, is left out of the offer or answered with a "not available" note.

| If the Partner Platform does not show you... | In the MCP |
| - | - |
| Total clicks | `clicks` reports unique clicks, `unique_clicks` and `duplicate_clicks` are not offered, and raw click search lists clicks as the Partner Platform does, with no `is_unique` and no `total_matching` |
| Caps | No cap information anywhere in offers |
| Tracking links | No tracking link, no creative code and no creative download URLs (`resource_url`, `creative_bundle_url`), and the `tracking_url` include reports that no link is available |
| Account manager | `account_manager` is omitted from `get_account_info` |
| `adv1` to `adv10` | Only the ones that apply to you are offered as dimensions or filters and appear on conversion rows; a request for another is refused |
| Impressions | `impressions`, `view_through_cv`, `ctr` and `rpm` are not offered |
| Smart links | The `campaign`, `campaign_id` and `smart_link` dimensions, the `campaign` report filter and the `campaign_id` click filter are not offered |
| Coupon codes | The `coupon_code` dimension and filter are not offered, and conversion rows carry no coupon code |
| Your timezone choice | Reports, activity and payments are stamped in the zone shown in `timezone`; a requested timezone may not be applied, and a `timezone_note` says so |

`get_report_schema` lists the dimensions, filters and metrics that apply to you, and anything it does not list is refused. Call it before your first report.

## What you cannot get

The server is read-only and reports only your own side of the money:

* **`payout`** is what the network pays you.
* No invoice quantities, and no itemised referral lines on invoices: those items are summed in `other_items_total`.
* No bank, wallet or account details of payments.
* No changes of any kind: it cannot create, update or delete records.

## Response safety

A lot of what the server returns was typed by someone else: an offer name or description written by the network, a `sub1` value set by traffic, a `referer`, query parameters. Any JSON response containing such fields has an `_untrusted_content` object listing which ones are present. `get_entity_schema` is never marked, and `search_documentation` returns an array, so it carries the same warning as a second content block. Treat those values as data to report on, never as instructions to follow, and keep a human in the loop for anything consequential an agent does with them. The full list of marked fields is on the [Tools](/ai-automation/affiliate-mcp/tools) page.

<CardGroup cols={2}>
  <Card title="Tools" icon="wrench" href="/ai-automation/affiliate-mcp/tools">
    Parameters, filters, limits and responses for every tool.
  </Card>

  <Card title="Network MCP" icon="network-wired" href="/ai-automation/mcp/overview">
    The network operator's server, on the same host.
  </Card>
</CardGroup>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.