Cleared

npx add-mcp 'https://api.clearedpay.xyz/mcp'

MCP integration

The Cleared MCP server exposes twelve tools for invoice and customer workflows. It is available from the private Cleared repository, not currently the public npm registry. Contact the team for repository access. A client supporting local stdio MCP servers is required.

Setup

1. Obtain repository access, install Bun, and run bun install from the checkout root.
2. Finish organization setup and create API credentials. Save both the clr_pk_ key ID and clr_sk_ secret.
3. For invoice writes, activate the server signer through owner settings. Prepare complete customers in the dashboard or REST API.
4. Add a local MCP configuration. Use your client's secret storage if available; protect any configuration file containing credentials.

{
  "mcpServers": {
    "cleared": {
      "command": "bun",
      "args": ["run", "/absolute/path/to/cleared/packages/mcp/src/bin/cleared-mcp.ts"],
      "env": {
        "CLEARED_API_KEY": "clr_sk_REPLACE_WITH_YOUR_SECRET",
        "CLEARED_KEY_ID": "clr_pk_REPLACE_WITH_YOUR_KEY_ID",
        "CLEARED_API_URL": "https://api.clearedpay.xyz",
        "CLEARED_CHAIN": "base-sepolia"
      }
    }
  }
}

Replace the checkout path and placeholders. The source-entry command avoids requiring prebuilt MCP output. Ensure the MCP client can find Bun, or supply its absolute executable path. Do not paste secrets into an agent prompt.

CLEARED_API_URL defaults to https://api.clearedpay.xyz; CLEARED_CHAIN accepts base (default) or base-sepolia. Equivalent flags are --api-key=..., --key-id=..., --api-url=..., and --chain=...; flags override environment values. Prefer secret-managed environment values over command-line secrets.

The chain option does not override the studio's API network. Use a Base Sepolia organization and its credentials for the example. The MCP setting affects presentation such as network labels/explorer URLs, while authenticated API calls derive chain context from the studio. Match both settings to avoid misleading labels.

First read

Invoke list_invoices with { "limit": 5 } or get_dashboard with {}. Read tools do not create invoices. Inspect errors and known limitations before relying on summary totals.

The server signs HTTP requests using HMAC; it does not turn the API key into an owner wallet. send_invoice creates an invoice, and cancel_invoice performs an on-chain cancellation. Neither tool pays an invoice or withdraws funds. Email is opt-in on send_invoice.

Tool coverage and limits

See all tool parameters. Invoice tools accept numeric global IDs or formatted merchant invoice numbers, resolved within your studio and issuance year. list_invoices accepts up to 50 results per page and returns page.next_cursor for continued traversal with the same filters. Invalid limits and dates are rejected.

create_customer and update_customer support billing addresses and entity registration data. Provide a name, email, complete address, and, for entities, registration_number. See the tool reference for creation examples and invoice retry behavior.

Use only trusted integrations with credentials: granular scope enforcement is incomplete. A read-labeled key is not an API-wide sandbox. See agents for disabling, revocation, and activity visibility.