Developer docs

Connect Warm to your AI tools. Read-only. One command.

Install the package, add your API key, and ask questions about your Warm data.

Terminal shell
npx -y @warmio/mcp@latest

Public discovery

Two MCP surfaces

The public endpoint exposes documentation and service metadata. Private financial context comes from the local package and your Warm API key.

Public MCP endpoint text
https://warm.io/mcp

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

Get started

Install the local MCP package

Create an API key, run the installer, then reload your client.

Terminal shell
npx -y @warmio/mcp@latest

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

  1. Create a Warm API key in Settings.
  2. Run npx -y @warmio/mcp@latest in your terminal.
  3. Let the installer detect supported clients found on your machine.
  4. Reload your client and ask a finance question.

The package also supports warmio mcp for the local MCP server, warmio http, and direct context and transaction commands.

Clients

Works with supported MCP clients

The installer configures the supported clients it finds on your machine.

  • Claude Code Ask Claude Code: "Show my Warm accounts."
  • Cursor Ask Cursor Agent: "Show my recent transactions."
  • 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."
  • Claude Desktop Use the installer to add Warm, then ask about your financial context.
  • Antigravity Use the installer to add Warm, then verify your API key.

Tools

Read-only tool surface

  • get_financial_context Read normalized financial context beyond raw transactions, including connected accounts at status.accounts.
  • get_transactions Pull transactions for month YYYY-MM or latest:true; bare calls use the fixed 10-day latest window.
  • 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.
  • User-scoped Each API key reaches only its owner's Warm data; Warm does not offer granular permission scopes.
  • Revocable Delete a key in Settings and access stops immediately.