Canary

繁體中文：網站及入門指南 · 简体中文：网站及入门指南

A risk desk for your Interactive Brokers account. It reads your account for you and your AI agent, checks it against your limits, and, in the trading build, places the trades you authorise.

Canary runs beside your IB Gateway or TWS and nothing runs on a server of mine. It tells you what needs attention today. It runs twenty discipline checks against limits you set and names the ones your positions breach. It shows exposure by underlying. Canary Edge shows what the price did 1, 5 and 20 sessions after your past stock and ETF trades, from your broker statements, where a decision repeated often enough to count. The same readings come as text, as JSON, in a paired phone app, and as MCP tools for Claude Desktop, Claude Code, Cursor or Zed.

It comes in two builds. The standard binary reads; it has no compiled order path. The trading binary, a separate download, also executes orders, and only the ones you authorised: a transaction you confirmed, or a close or reduction the daemon runs under a bucket you listed in your written policy, a list that ships empty. Every order is pinned to one account, client ID and mode, consumes a preview token for that exact draft, is journaled with its origin before it is sent, and passes the risk policy's order limits, the mandate gate and the freeze. An agent trades only through the gated CLI. The MCP server has no order or preview tool in any build. Canary never decides a trade on its own.

Documentation · Install · First session · Agentic trading · Canary Edge · MCP tools · Safety · Privacy

Start

You need IB Gateway 10.37+ or TWS with API socket access enabled, an IBKR Pro account, and macOS or Linux on arm64 or amd64. Paper and live both work. There is no Windows build; use WSL.

Terminal, and every MCP host. One signed binary in ~/.local/bin:

curl -fsSL https://raw.githubusercontent.com/osauer/canary/main/install.sh | sh
canary status    # show which Gateway and account Canary reached
canary brief     # review what changed and what needs attention

The install guide shows how to inspect the script first and covers every other installation path.

Claude Desktop. Download the MCP Bundle, canary.mcpb, open it with Claude Desktop, then quit and relaunch Claude. The walkthrough covers the first connection.

Any other MCP host. Install the binary as above, then point the host at its absolute path; which canary prints it.

{
  "mcpServers": {
    "canary": {
      "command": "/ABSOLUTE/PATH/TO/canary",
      "args": ["mcp"]
    }
  }
}

A first question that works in any host:

What needs attention today, and which data is missing or stale?

Canary Edge in the paired app, rendered from synthetic data: what the price did after past decisions, and how much evidence supports each row.

Ways in

You want to…	Start with	What you get
Ask an agent about the account	The MCP Bundle, or canary mcp from any local framework that can launch a stdio MCP server	Read-only tools; the MCP server has no order or preview tool
Work in a terminal or script	canary brief, canary positions --by underlying, and --json	Every reading as text or JSON, from the same source as the app and the MCP tools
Check the desk from a phone	canary app, then canary app pair	A paired web app on your phone; local by default, remote access optional
Read Canary from your own Go program	github.com/osauer/canary/v2, the daemon client, at your release's tag (how)	The daemon's read methods over its local socket; its one submit method is served by a trading daemon only
Build directly on the TWS protocol	github.com/osauer/canary/v2/pkg/ibkr	A low-level transport; it carries no policy, authorisation or journal, those stay in your program

MCP hosts

Ask plain questions rather than naming tools. The host guide covers Claude Code, Cursor, Zed, continuously running agents, logs, and connection checks. The generated MCP reference lists every tool and its schema.

Terminal and paired app

Every data command supports --json:

canary account
canary positions --by underlying
canary edge
canary rules
canary regime --explain
canary stress --details

Run canary status first for connection problems and canary data health for missing or stale data. canary --help and the CLI reference list every command and flag.

For the paired app, run canary app on the machine that owns the Gateway or TWS session, then run canary app pair and scan the QR code. The app guide covers pairing, remote access, and push notifications.

This is the beginning of the README. Read the rest at the original. Read the full README ↗