Quickstart - Everflow API

Private beta. The Affiliate MCP is in a private beta and is read-only. Your network enables it for your account, so ask them if your connection is refused (see Troubleshooting below).

EU Cluster Support: If your Everflow account is hosted in the EU, replace https://mcp.eflow.team/affiliate with https://mcp-eu.eflow.team/affiliate in any of the examples below.

Prerequisites

An Affiliate API key. You cannot create one yourself: your network issues it to you.
Your account enabled for the beta by your network.

Connect your client

Use the server URL that matches where your account is hosted:

US-Hosted Accounts: https://mcp.eflow.team/affiliate
EU-Hosted Accounts: https://mcp-eu.eflow.team/affiliate

Send your key in the X-Eflow-API-Key header. The server also accepts X-Api-Key, which is the name to use in a client that only accepts standard header names.

Claude Code
Claude Desktop
Cursor

claude mcp add --transport http everflow-partner https://mcp.eflow.team/affiliate \
  --header "X-Eflow-API-Key: your-affiliate-api-key"

Run /mcp inside Claude Code to confirm the everflow-partner server is connected.

Open your claude_desktop_config.json and add the server to the mcpServers block:

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

The --header value uses Name:Value with no space after the colon. X-Eflow-API-Key: your-affiliate-api-key (with a space) will fail.

Save the file, then quit and reopen Claude Desktop.

Go to Cursor Settings → MCP and add:

{
  "mcpServers": {
    "everflow-partner": {
      "url": "https://mcp.eflow.team/affiliate",
      "headers": {
        "X-Eflow-API-Key": "your-affiliate-api-key"
      }
    }
  }
}

This config holds your Affiliate API key in plaintext. If it lives in a workspace .cursor/mcp.json, add it to .gitignore so the key is never committed.

For any other client, follow the steps for that client in the Network MCP Quickstart, replacing the URL with the Affiliate MCP URL above and the key with your Affiliate API key. Use only its client steps: its advice on Network key permissions, its tool count, and the Slack and scheduled-task integrations are for the Network MCP.

Verify the connection

Ask your agent:

“Call get_account_info and tell me my partner name, the network I work with, and my currency and timezone.”

A good response contains:

a network object with your network’s currency and timezone, and its name when one is available
a partner object with your partner id, name, account status and currency
the network’s timezone and your currency, which reports default to; get_report_schema lists the dimensions, filters and metrics available to you
when they apply to your account, an account_manager and a billing object

You should also see the 12 tools listed in your client. You can read the same list over REST with GET https://mcp.eflow.team/affiliate/tools/list, sending the same header.

First questions to try

Ask in plain language:

“How did my offers perform last week?”
“Which offers can I run, and what is my payout on each?”
“Show my conversions from yesterday.”
“What is the balance on my latest invoice?”
“What payments have I received this year?”

Debug with MCP Inspector

If a client isn’t connecting or tools aren’t appearing, the MCP Inspector lets you test the server directly, independent of any AI client config.

Run the inspector

No install required:

npx @modelcontextprotocol/inspector

Configure the connection in the inspector UI

Field	Value
Transport	Streamable HTTP
URL	`https://mcp.eflow.team/affiliate`
Header name	`X-Eflow-API-Key`
Header value	`your-affiliate-api-key`

Connect and call a test tool

Click Connect, then call get_account_info from the Tools tab. A valid response confirms the server is reachable and your key is accepted. If this works but your AI client still can’t connect, the issue is in your client config, not the server.

Troubleshooting

Symptom	Likely cause	Fix
`403` with “MCP is not enabled for your account. Ask your network to enable it.”	Your account is not enabled for the private beta	Ask your network to enable it. Enabling can take up to a minute to apply, so retry after that
`401`	Missing or invalid key	Check that the header is present and holds your current Affiliate API key. A key in the URL is not accepted: send it in a header. Ask your network for a new one if needed
`503` with “Access could not be verified. Please try again.”	A temporary failure while checking your beta access	Retry after a few seconds
`403` on a key that is valid	The key and the server do not match: a Network API key sent to `/affiliate`, or an Affiliate API key sent to the root URL	Use `https://mcp.eflow.team/affiliate` (or the EU URL) with your Affiliate API key
Empty result	The window or filters match nothing	Widen the window (click search covers at most 14 days, conversion search up to 365 days) and remove filters; an id that is not yours or is outside the window also gives an empty result
`RESOURCE_EXHAUSTED` (“Reports on detail dimensions and click search are temporarily rate limited…”)	The reporting rate limit	Use a summary-dimension report meanwhile, or retry after the top of the hour (UTC)
`429 Too many requests`	Over 10 requests per second for your account	Retry after 1 second (see the `Retry-After` header)
Tools not appearing, or a tool seems out of date	The client cached the tool list at connect time	Restart the client or reconnect the server so it fetches the list again
Connection refused or timeout	Wrong URL or a firewall issue	Confirm the URL and that outbound HTTPS is allowed
`npx` fails with “command not found” or hangs	Node.js not installed	Install Node.js from nodejs.org, then retry

What’s next

Tools

Parameters, filters and responses for every tool.

Skills

Reusable skills for the Affiliate MCP.

Prompt Library

Ready-to-use prompts for performance, offers, activity and payments.

Examples

Multi-step workflow traces showing what the agent does.

Limits

Rate limits, windows and result caps.

FAQ

Common questions about the Affiliate MCP.

​Prerequisites

​Connect your client

​Verify the connection

​First questions to try

​Debug with MCP Inspector

​Troubleshooting

​What’s next

Tools

Skills

Prompt Library

Examples

Limits

FAQ

Prerequisites

Connect your client

Verify the connection

First questions to try

Debug with MCP Inspector

Troubleshooting

What’s next