canary

# Canary

Updated: 2026-09-26

Version 3.13 adds a descriptive daily market tape, issuer-loss concentration
checks and exact reviewed proposals. Policy document revisions and labels do
not grant trading permission. Existing files remain readable and unchanged;
reviewed conversions preserve effective settings and keep backups. Alert sources
commission independently, and push status distinguishes transport from device
receipts. Installation does not enable automatic submission.

Canary is a local Interactive Brokers risk desk: a daemon, shell CLI, read-only
MCP server, paired app, and a public Go module with a daemon client and the TWS
wire protocol. The daemon
owns account scope, market sensors, rulebook evaluation, protection proposals,
option-exercise opportunities, and typed source quality. The CLI, MCP server,
and app are adapters over that authority.

Use it for:

- account, position, daily P&L, exposure, technical, and order-lifecycle reads;
- the Action Queue and daemon-composed daily brief;
- the 18-rule desk rulebook, operator-authored risk policy, and Flex-backed
  reconciliation;
- current option-strategy grouping, read-only protection proposals, and
  option-exercise opportunity review;
- explicit freshness, entitlement, source-health, warning-code, and session
  context; and
- Go programs reading the daemon through `github.com/osauer/canary/v2`, or
  building on the clean-room `pkg/ibkr` protocol package.

The MCP server exposes read-only tools for status, trading status, settings,
open orders, order history, one-order status, account, positions, option
strategies, named-symbol technical analysis, detailed regime and portfolio stress, brief, broker-reporting status and the
statement performance series, Edge, rules, proposals, opportunities, portfolio allocation, reconciliation status,
market quotes and price history, exchange sessions, and official macro calendars
and publications. It has no MCP resources, settings writes, order previews, or
execution tools. Breadth and gamma remain daemon inputs. Use
`canary_regime` for the eight-indicator market dashboard and `canary_stress` for
full portfolio-risk evidence; the daily brief remains the summary.

Standard downloads cannot place, modify, cancel, or exercise orders. A separate
opt-in `canary-trading` binary exposes constrained CLI and app order actions with
fresh confirmation/preflight, account and mode pins, journaling, daemon policy,
and the runtime freeze gate. Trading builds also support explicitly pre-authorised defensive proposals within the existing policy and execution gates.

Product v3 releases ship as signed binaries, installer output, MCPB, and app
assets. The public Go module deliberately remains `/v2`; its `@latest` resolves
to the maintained v2 module line and does not install the product v3 binary.

## Authoritative links

- [GitHub and install](https://github.com/osauer/canary#readme)
- [Full LLM context](https://osauer.dev/canary/llms-full.txt)
- [Documentation](https://osauer.dev/canary/docs/)
- [MCP tools](https://osauer.dev/canary/docs/reference/mcp-tools.html)
- [CLI reference](https://osauer.dev/canary/docs/reference/cli.html)
- [Install](https://osauer.dev/canary/docs/start/install.html)
- [First session](https://osauer.dev/canary/docs/start/first-session.html)
- [Daily desk](https://osauer.dev/canary/docs/operate/daily-desk.html)
- [Releases and support](https://osauer.dev/canary/docs/reference/releases.html)
- [Architecture](https://osauer.dev/canary/docs/internals/architecture.html)
- [Market data and entitlements](https://osauer.dev/canary/docs/understand/market-data.html)
- [GitHub releases](https://github.com/osauer/canary/releases)