Back to AI Agent
Developer Documentation

PayHelm MCP Server

Connect any MCP-compatible coding agent — Replit Agent, Claude Code, OpenAI Codex, or your own app — to 336 live ecommerce tools across ads, email, stores, marketplaces, analytics, and shipping.

Endpoint & transport

The PayHelm MCP server speaks the Model Context Protocol over streamable HTTP (with SSE fallback). One endpoint serves every tool — your agent discovers them automatically via the standard tools/list handshake.

Transport : Streamable HTTP / SSE
Base URL  : https://api.payhelm.com/mcp
Auth      : Authorization: Bearer <YOUR_PAYHELM_API_KEY>

Get your API key from the PayHelm dashboard under Settings → API Keys. Each key is scoped to your account's connected platforms — tools only return data for stores and ad accounts you've connected.

Protocol basics

MCP is JSON-RPC 2.0. After initialize, list tools and call them:

List tools (curl)

curl -s https://api.payhelm.com/mcp \
  -H "Authorization: Bearer $PAYHELM_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/list"}'

Call a tool (curl)

curl -s https://api.payhelm.com/mcp \
  -H "Authorization: Bearer $PAYHELM_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "jsonrpc": "2.0",
    "id": 2,
    "method": "tools/call",
    "params": {
      "name": "get_trends_report",
      "arguments": { "date_range": "last_30d" }
    }
  }'

Tip: always call create_analysis_plan first — it analyzes the request and returns a step-by-step plan of which tools to call in what order.

Replit

Replit Agent supports custom MCP servers. Add PayHelm in your workspace's Agent → Integrations → MCP servers panel (or the .mcp.json file in your repl) and store the key as a Replit Secret:

.mcp.json

{
  "mcpServers": {
    "payhelm": {
      "type": "http",
      "url": "https://api.payhelm.com/mcp",
      "headers": {
        "Authorization": "Bearer ${PAYHELM_API_KEY}"
      }
    }
  }
}

Set PAYHELM_API_KEY in Replit Secrets (never hardcode it). The agent will list PayHelm tools automatically on its next run.

Claude Code

One command registers the server for your project or user scope:

CLI

claude mcp add payhelm --transport http https://api.payhelm.com/mcp \
  --header "Authorization: Bearer $PAYHELM_API_KEY"

Or add it to .mcp.json at your repo root (shared with your team via version control):

.mcp.json

{
  "mcpServers": {
    "payhelm": {
      "type": "http",
      "url": "https://api.payhelm.com/mcp",
      "headers": { "Authorization": "Bearer ${PAYHELM_API_KEY}" }
    }
  }
}

Verify with claude mcp list, then ask Claude Code things like "use payhelm to pull last month's revenue by channel."

OpenAI Codex

Codex CLI reads MCP servers from ~/.codex/config.toml:

~/.codex/config.toml

[mcp_servers.payhelm]
url = "https://api.payhelm.com/mcp"

[mcp_servers.payhelm.http_headers]
Authorization = "Bearer YOUR_PAYHELM_API_KEY"

Or register it from the command line:

CLI

codex mcp add payhelm --url https://api.payhelm.com/mcp \
  --header "Authorization: Bearer $PAYHELM_API_KEY"

GitHub Pages & static/browser apps

Static sites (GitHub Pages, Netlify, etc.) have no server, so never embed your API key in client-side JavaScript — anyone can read it from the page source. Two safe patterns:

  • Proxy through a serverless function (Cloudflare Worker, Vercel/Netlify function, or a GitHub Actions-deployed API) that holds the key server-side and forwards JSON-RPC calls to https://api.payhelm.com/mcp.
  • Build-time data: for dashboards published to GitHub Pages, fetch PayHelm data in a GitHub Actions workflow (key stored as an Actions secret) and commit the rendered JSON/HTML.

GitHub Actions example

# .github/workflows/refresh-data.yml
- name: Pull PayHelm report
  env:
    PAYHELM_API_KEY: ${{ secrets.PAYHELM_API_KEY }}
  run: |
    curl -s https://api.payhelm.com/mcp \
      -H "Authorization: Bearer $PAYHELM_API_KEY" \
      -H "Content-Type: application/json" \
      -d '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"get_trends_report","arguments":{"date_range":"last_30d"}}}' \
      > site/data/trends.json

Authentication & safety notes

  • Send the key as Authorization: Bearer <key>. Store it in secrets managers only.
  • Read-only tools (names starting with get_, list_, search_) never modify data. Action tools (create/update/delete/send/purchase) modify live platform data — gate them behind human approval in autonomous agents.
  • Rotate keys from the PayHelm dashboard at any time; old keys are invalidated immediately.

Tool catalog (336 tools)

Every tool group, with its PayHelm integration where one exists. See the full AI agent tools list for per-tool descriptions.

Core / meta

6 tools

Help docs

4 tools

Data backfill

4 tools

Shipping insurance / settings

8 tools

Website traffic

4 tools

Google Search Console

9 tools

Google PageSpeed / web search / BigQuery

6 tools

Google Merchant Center

22 tools

Reports

13 tools

Marketing mix model

6 tools

Order metadata

3 tools

ChannelAdvisor

6 tools

InkFrog

6 tools

Makeswift

4 tools

Feedonomics

21 tools

X / Twitter + X Ads

23 tools