Developer docs

Warm MCP developer docs Read-only finance context for AI clients.

Install the local package, add a scoped Warm API key, and connect supported MCP clients to your financial context.

Create API Key Client Guides
Terminal shell 
npx @warmio/mcp

Public discovery

Remote MCP for API metadata

Warm also exposes a public, unauthenticated MCP endpoint for agents that only need documentation, OpenAPI, and service-health metadata. It is discovery-only and does not expose account, transaction, budget, goal, or net-worth data.

Public MCP endpoint text 
https://warm.io/mcp
  • warm-get-api-catalog Returns Warm API discovery URLs and the API catalog document.
  • warm-get-openapi Returns the OpenAPI URL and companion developer docs URL.
  • warm-get-service-status Checks the public API verification endpoint without exposing user data.

Use npx @warmio/mcp with a Warm API key when an AI client needs your private, read-only finance context.

Get started

Install the local MCP package

Run the installer, paste your Warm API key when prompted, and let it configure supported MCP clients for you.

Terminal shell 
npx @warmio/mcp

Requires Node.js 18+, a Warm paid plan, and an API key from Settings - API Keys.

  1. Create a Warm API key in Settings.
  2. Run npx @warmio/mcp in your terminal.
  3. Select the clients you want to configure.
  4. Reload your AI client and ask a finance question.

Clients

Works with supported MCP clients

The installer handles supported clients automatically. Use the full guide links when you want client-specific details or manual setup.

  • Claude Code Ask Claude Code: "Show my Warm accounts."
  • Cursor Ask Cursor Agent: "What did I spend last week?"
  • Windsurf Ask Cascade: "List my recurring charges."
  • Codex CLI Ask Codex: "Is my Warm connection working?"
  • OpenCode Ask OpenCode: "What accounts do I have in Warm?"
  • Gemini CLI Ask Gemini CLI: "Show my financial state summary."

Tools

Read-only tool surface

  • get_accounts List connected accounts with balances and institutions.
  • get_transactions Pull transactions with strict cursor pagination.
  • get_financial_state Read snapshots, recurring payments, budgets, goals, and health.
  • verify_key Check whether your API key is valid.

Safety

Safe by design

  • Read-only MCP tools can query data, not move money or edit records.
  • Scoped API keys only access your Warm account data.
  • Revocable Delete a key in Settings and access stops immediately.

More

More MCP pages