Quickstart - Everflow API

MCP must be enabled for your network before any connection attempt will succeed. Email support@everflow.io to request access. See the Overview for full availability details.

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

Prerequisites

A Network API key with access to your network. See Authentication.
MCP access enabled for your network (see the Overview for server URL, transport, and availability details).

Connect your client

Each setup takes under 5 minutes. Depending on where your account is hosted, choose the appropriate server URL:

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

All clients authenticate with the X-Eflow-API-Key header — the config format varies by client, and some clients like Claude.ai web don’t support API-key headers at all. If you’re unsure where to start, use Claude Desktop — it has the most straightforward setup and the best out-of-the-box MCP experience.

Open your Claude Desktop config file

macOS

open ~/Library/Application\ Support/Claude/claude_desktop_config.json

Windows

notepad %APPDATA%\Claude\claude_desktop_config.json

Add the Everflow server to the mcpServers block

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

Claude Desktop currently requires the mcp-remote stdio bridge to connect to remote MCP servers. The npx -y prefix auto-installs the package on first launch — no separate install step is needed. For the latest on native remote MCP support in Claude Desktop, see Anthropic’s changelog.

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

Save the file and restart Claude Desktop

Quit and reopen the app so it picks up the new MCP server.

Test the connection

Open a new conversation. You should see an Everflow tools indicator in the input area. Ask:

“What is my network’s name and default currency?”

Claude Code is Anthropic’s CLI agent, with native support for remote MCP servers over HTTP.

Add the Everflow server

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

Verify the connection

Run /mcp inside Claude Code to confirm the everflow server is connected, then ask:

“Call get_account_info and tell me my network name and default currency.”

Claude.ai web doesn’t support API-key headers. Its connector UI is OAuth-only, and Everflow MCP authenticates with the X-Eflow-API-Key header — there’s no field for it. Use Claude Desktop, Claude Code, or Cursor instead.

Anthropic has marked header support for the Claude.ai connector UI as not planned. Until that changes, connect through one of the other clients in the tabs above.

Open Cursor's MCP settings

Go to Cursor Settings → MCP, or press Cmd+Shift+P → MCP: Edit Configuration.

Add the Everflow server

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

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

Save and reload the window

The Everflow tools will appear in the Cursor Agent chat.

Gemini CLI is Google’s open-source terminal agent with native MCP support.

Install Gemini CLI

npm install -g @google/gemini-cli

Open the Gemini CLI config file

open ~/.gemini/settings.json

Create the file if it doesn’t exist yet.

Add the Everflow server

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

Start a session and verify the connection

gemini

“Call get_account_info and tell me my network name and default currency.”

VS Code requires an active GitHub Copilot Chat subscription and the Copilot Chat extension. The config format also differs from the other clients — note the servers key instead of mcpServers.

Install the GitHub Copilot Chat extension

Install it from the VS Code marketplace if you don’t have it already.

Open your MCP configuration

Open VS Code settings (Cmd+,) and search for MCP Servers, or edit .vscode/mcp.json directly in your workspace:

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

.vscode/mcp.json holds your network API key in plaintext and often lives inside a repo. Add it to .gitignore so the key is never committed.

Open Copilot Chat in Agent mode

The Everflow tools will appear in the tool picker.

Verify the connection

Once connected in any client, run this prompt to confirm everything is working:

“Call get_account_info and tell me my network name, default timezone, and default currency.”

A successful response confirms your API key is valid, your network has MCP access enabled, and the MCP server is reachable.

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`
Header name	`X-Eflow-API-Key`
Header value	`your-network-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
Connection refused or timeout	MCP not enabled for your network	Email support@everflow.io to request access
`401 Unauthorized`	Invalid or missing API key	Verify the key in Control Center → Security
`403 Forbidden`	Key is not a Network key	Affiliate and advertiser keys are not accepted
Tools not appearing in client	Config file syntax error	Validate your JSON — trailing commas are invalid
`not valid MCP server configurations and were skipped` on Claude Desktop launch	Claude Desktop does not accept the `url` + `headers` (Streamable HTTP) format	Use the `mcp-remote` stdio config shown in the Claude Desktop tab above
Partial data returned	Limited affiliate scope on your key	Employees with scoped access only see their assigned affiliates
`npx` fails with “command not found” or hangs	Node.js not installed	Install Node.js from nodejs.org, then retry

What’s next

Prompt Library

Ready-to-use prompts for reporting, partner health checks, and traffic investigation.

Agentic Examples

End-to-end multi-step workflow traces showing exactly what the agent does.

​Prerequisites

​Connect your client

​Verify the connection

​Debug with MCP Inspector

​Troubleshooting

​What’s next

Prompt Library

Agentic Examples

Prerequisites

Connect your client

Verify the connection

Debug with MCP Inspector

Troubleshooting

What’s next