MCP Server

The Benji Pays MCP server lets compatible AI clients connect directly to the Benji Pays API — all from within your favorite AI-powered editor or assistant.

What the Benji Pays MCP server can do

The Benji Pays MCP server exposes the following capabilities to supported AI clients.

OpenAPI Tools

Tool	Description
`list-endpoints`	List available API paths, methods, and summaries
`get-endpoint`	Inspect a specific endpoint — parameters, descriptions, and security requirements
`search-endpoints`	Search API paths, operations, and schemas
`execute-request`	Make a live API call

Authentication

📘
Required for live API calls

For live API execution via execute-request, configure your MCP client to forward the authentication header:

x-api-key: YOUR_BENJI_PAYS_API_KEY

When configured, this header is automatically forwarded to live API calls. Your x-api-key is issued from the merchant app. See Authentication for details.

Benji Pays MCP Server URL

📘
MCP Server Endpoint
https://benjipays.readme.io/mcp

Use this URL when configuring any of the clients below.

Client setup

Choose your AI client below and follow the setup instructions.

Add to ~/.cursor/mcp.json:

{
  "mcpServers": {
    "benjipays": {
      "url": "https://benjipays.readme.io/mcp",
      "headers": {
        "x-api-key": "YOUR_BENJI_PAYS_API_KEY"
      }
    }
  }
}

Add to ~/.codeium/windsurf/mcp_config.json:

{
  "mcpServers": {
    "benjipays": {
      "serverUrl": "https://benjipays.readme.io/mcp",
      "headers": {
        "x-api-key": "${env:BENJI_PAYS_API_KEY}"
      }
    }
  }
}

Create .vscode/mcp.json in your workspace:

{
  "inputs": [
    {
      "type": "promptString",
      "id": "benjipays-api-key",
      "description": "Benji Pays API key",
      "password": true
    }
  ],
  "servers": {
    "benjipays": {
      "type": "http",
      "url": "https://benjipays.readme.io/mcp",
      "headers": {
        "x-api-key": "${input:benjipays-api-key}"
      }
    }
  }
}

Claude Desktop uses the Developers UI for remote MCP servers.

Open Settings → Developer
Click Edit Config
Open claude_desktop_config.json
Enable the connector in the conversation where you want to use it

Local Claude Desktop config for remote MCP server (macOS / Linux):

{
  "mcpServers": {
    "benjipays": {
      "command": "npx",
      "args": [
        "mcp-remote",
        "https://benjipays.readme.io/mcp",
        "--header",
        "x-api-key: ${API_KEY}"
      ],
      "env": {
        "API_KEY": "YOUR_BENJI_PAYS_API_KEY"
      }
    }
  }
}

On Windows, npx resolves to npx.cmd, which Claude Desktop's process launcher can't execute directly — leaving the command as "npx" fails with spawn npx ENOENT. Wrap it with cmd /c:

{
  "mcpServers": {
    "benjipays": {
      "command": "cmd",
      "args": [
        "/c",
        "npx",
        "mcp-remote",
        "https://benjipays.readme.io/mcp",
        "--header",
        "x-api-key: ${API_KEY}"
      ],
      "env": {
        "API_KEY": "YOUR_BENJI_PAYS_API_KEY"
      }
    }
  }
}

macOS / Linux — run the following command:

claude mcp add --transport http benjipays https://benjipays.readme.io/mcp \
  --header "x-api-key: YOUR_BENJI_PAYS_API_KEY"

On Windows, the trailing \ line continuation isn't valid in PowerShell or Command Prompt. Run it as a single line instead (this also works in any shell):

claude mcp add --transport http benjipays https://benjipays.readme.io/mcp --header "x-api-key: YOUR_BENJI_PAYS_API_KEY"

Verify your .claude.json contains:

{
  "mcpServers": {
    "benjipays": {
      "url": "https://benjipays.readme.io/mcp",
      "headers": {
        "x-api-key": "YOUR_BENJI_PAYS_API_KEY"
      }
    }
  }
}

Add the Benji Pays MCP server as a tool in Microsoft Copilot Studio.

Open Microsoft Copilot Studio
In the left navigation, select Agents, then choose the agent you want to configure
Navigate to the Tools page for your agent (from the top nav or by scrolling down)
Select Add a tool → New tool → Model Context Protocol
Fill in the required fields:

Server name: Benji Pays
Server description: Benji Pays API and documentation
Server URL:

https://benjipays.readme.io/mcp

For authentication, select API key, then configure:

Type: Header
Header name: x-api-key

Select Create, then Add tool
When prompted, enter your Benji Pays API key value
The available tools (e.g. list-endpoints, search-endpoints, execute-request) are discovered automatically from the MCP server
Test the connection in the Test your copilot panel by asking something like "List all available Benji Pays API endpoints"

For full details, see Microsoft's documentation:

Connect your agent to an existing MCP server

Extend your agent with MCP

Add tools to a custom agent

Configure via the Roo Code sidebar:

Open the Roo Code panel in the VS Code sidebar
Click the MCP Servers icon (server plug icon at the top of the panel)
Click Edit MCP Settings to open mcp_settings.json
Add the following configuration:

macOS / Linux:

{
  "mcpServers": {
    "benjipays": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-remote",
        "https://benjipays.readme.io/mcp",
        "--header",
        "x-api-key: YOUR_BENJI_PAYS_API_KEY"
      ]
    }
  }
}

On Windows, npx resolves to npx.cmd, which can't be spawned directly — leaving the command as "npx" fails with spawn npx ENOENT. Wrap it with cmd /c:

{
  "mcpServers": {
    "benjipays": {
      "command": "cmd",
      "args": [
        "/c",
        "npx",
        "-y",
        "mcp-remote",
        "https://benjipays.readme.io/mcp",
        "--header",
        "x-api-key: YOUR_BENJI_PAYS_API_KEY"
      ]
    }
  }
}

Testing your MCP setup

Once configured, try any of these prompts in your AI client to verify the connection:

"List all available Benji Pays API endpoints"

Discovers API paths — list-endpoints

"Show me the details for the List Customers endpoint"

Inspects an endpoint — get-endpoint

"Search the Benji Pays API for anything related to invoices"

Searches specs — search-endpoints

"Get me a list of all my customers"

Makes a live API call — execute-request

Notes

For authenticated API execution, make sure your client is forwarding the required x-api-key header.
The MCP server reflects your API key's scopes — if a call returns 403 Forbidden, check that your key has the required scope (e.g. organizations:customers:read). See Authentication.
See Rate Limits for request limits that apply to MCP-executed calls just as they do to direct API calls.