Inspect portfolio state
Read net liquidation, cash, margin, buying power, positions, P&L, option legs, Greek coverage and per-underlying exposure.
IBKR / Interactive Brokers MCP server
Connect IB Gateway or TWS to Claude Desktop, Claude Code, Cursor, Zed and other MCP hosts. Read-only tools cover your account and positions, the daily brief, the rulebook, a check that your limits add up, the Action Queue, Edge, FX and lending reports, borrowing and short-interest research and the quality of each source.
{
"mcpServers": {
"canary": {
"command": "/ABSOLUTE/PATH/TO/canary",
"args": ["mcp"]
}
}
}
The MCP server is one adapter over a larger local engine. Canary's daemon evaluates account, statement, market, calendar, event, breadth, gamma, regime, stress, rulebook, proposal and opportunity inputs. MCP keeps to a smaller set of current and retrospective reads that matter for decisions, so not every sensor needs a tool of its own.
Everything runs through your own TWS or IB Gateway session. Coverage follows your IBKR subscriptions, market hours and the health of upstream sources. Inputs that are unavailable, stale, delayed or held stay labelled as such.
Read net liquidation, cash, margin, buying power, positions, P&L, option legs, Greek coverage and per-underlying exposure.
Review market and session context, source health, the daily brief and the combined Action Queue.
Inspect stock and ETF decisions that have enough samples, against fixed market context. Broker-reported option evidence, realised and dated open, is kept separate.
Read the verdict on all 19 rules, with each unknown or degraded input kept in view. A policy check reads the limits themselves against each other and the account.
Read protection and option-exercise candidates. The tools grant no preview or execution authority.
Request daily trend, relative strength, ATR and liquidity evidence for stocks or ETFs you name explicitly.
Read statement-backed performance, the FX contribution for each period and the net fees your lent shares earned. Missing days stay marked, and lending fees stay out of P&L.
Compare dated borrowing fees, price and liquidity, and screen FINRA’s twice-monthly short-interest report. Borrowing fees are a cost to borrowers, not a lender’s yield.
Inspect open and past orders in the local journal. Nothing here places, changes or cancels an order.
The MCP server offers read-only tools and nothing else. It has no resources, settings writes, previews or execution tools. Each release also publishes a separate, clearly marked canary-trading binary for constrained, opt-in order management in the CLI and app. MCP stays read-only.
Claude Desktop takes the MCPB. For Cursor, Continue, Zed, the terminal or any other local MCP host, use the shell install.
Download MCPB for Claude Desktop
Open the .mcpb file with Claude Desktop, drag it into the app or install it from its settings. You need IB Gateway 10.37+ or TWS running locally and an IBKR Pro account with TWS API access.
# Shell, Cursor, Continue, Zed, generic MCP hosts
curl -fsSL https://raw.githubusercontent.com/osauer/canary/main/install.sh | sh
canary setup claude-desktop
For Cursor, Continue, Zed or another local MCP host, give the absolute path to the binary. exec does not expand ~.
{
"mcpServers": {
"canary": {
"command": "/Users/you/.local/bin/canary",
"args": ["mcp"]
}
}
}
The MCP tool descriptions are written to route requests like these to the right tool.
Start with Claude Desktop if that is where you will ask your questions. The other pages cover TWS, IB Gateway, safety and portfolio review in more depth.
A short overview of IBKR MCP, with exact setup notes.
Use Trader Workstation as the local Interactive Brokers API process.
Use IB Gateway as the lighter local account and market-data bridge.
Install the MCPB and connect Claude Desktop to the local IBKR session.
Compare IBKR MCP servers by local execution, tool coverage and fit with Claude Code.
A prompt-led review of exposures, option risks, data freshness and the next checks to run.
The local MCP tools expose account and market data, not trading authority.
Brokerage data is sensitive. canary keeps the broker connection on the machine that already runs IB Gateway or TWS, and gives the AI host a narrow, local, read-only interface.
Yes. canary mcp runs locally as a stdio MCP server and reads account and market data from Interactive Brokers through IB Gateway or TWS.
Claude Desktop, Claude Code, Cursor, Zed, Continue and other local stdio MCP hosts can launch it.
Not in the standard downloads. The MCP bundle and the plain canary tarballs are read-only builds, compiled without tools to place, modify or cancel orders. Each release also publishes a clearly marked canary-trading tarball for users who explicitly opt into order management. It ships with warnings and layered safeguards.