MCP Server

Connect AI clients directly to the Benji Pays API using the Model Context Protocol (MCP).

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

ToolDescription
list-endpointsList available API paths, methods, and summaries
get-endpointInspect a specific endpoint — parameters, descriptions, and security requirements
search-endpointsSearch API paths, operations, and schemas
execute-requestMake 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"
      }
    }
  }
}

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.