MCP server for QJ Trader — let an LLM inspect availability, watch Canadian and selected US data, and place simulated orders.
Project description
qjtrader-mcp
For Claude web, mobile, or another hosted assistant, prefer the hosted QJTrader OAuth connector offered inside QJ Gateway. It provides delegated per-user access without putting
QJ_CLIENT_SECRETin chat. This package is the local/stdio implementation for Claude Code and controlled local runtimes.
Model Context Protocol server for the QJ Trader AI Trading APIs. Point your LLM at your QJ credential and it can watch live Canadian and selected US market data and place simulated orders — no code, no manual API testing.
Built on the official qjtrader Python SDK. Talk to
it from Claude Code, Claude Desktop, or any MCP-capable client:
"Check market availability, then compare CA:RY, MX:CRAU26, and US:@ESU26 in the sandbox. Show the books and explain which production permissions would be separate."
Verifiable releases.
qjtrader-mcpis published straight from this repository via PyPI Trusted Publishing with signed PEP 740 provenance — no manual uploads, no stored tokens. Before you let an agent install it, you (or the agent) can confirm each release was built byQJTrader/qjtrader-mcpfrom the Provenance section on PyPI. See SECURITY.md.
Safety model — AI trades simulated by default
Order-mutating tools (place_order, cancel_order, replace_order, cancel_all) use the
Gateway's authenticated session response as the authority. Sandbox, paper, and shadow credentials
cannot be mistaken for live credentials by a stale local setting. Canary and live credentials are
refused unless you explicitly opt in.
| Server-declared order environment | Read tools (quotes/depth/status) | Order tools |
|---|---|---|
sandbox |
✅ | ✅ simulated |
paper / shadow |
✅ | ✅ non-exchange mutation path |
canary / live |
✅ | ⛔ unless QJ_MCP_ALLOW_LIVE=1 |
| unavailable or mismatched | ✅ where possible | ⛔ fail closed |
QJ_ENV is now an optional expected-environment assertion, not the source of truth. If it disagrees
with the Gateway, mutations stop with an explanation. Every tool result includes an environment tag,
and order quantity is capped client-side by QJ_MCP_MAX_QTY (default 25).
Install
Get a free sandbox credential (no approval) at gateway.qjtrader.ai.
The zero-install path is:
uvx qjtrader-mcp # or: pipx run qjtrader-mcp
For local development against the SDK checkout:
# from the qjtrader-mcp/ directory, with the qjtrader-python sibling checked out:
uv sync && uv run qjtrader-mcp # uv resolves qjtrader from ../qjtrader-python
# — or with pip —
pip install -e ../qjtrader-python -e .
qjtrader-mcp
Configure your client
Claude Code
claude mcp add qjtrader -- uvx qjtrader-mcp
# then set the credential + environment for the server:
claude mcp add qjtrader \
-e QJ_CLIENT_ID=your-client-id \
-e QJ_CLIENT_SECRET=your-client-secret \
-e QJ_ENV=sandbox \
-- uvx qjtrader-mcp
Claude Desktop / generic stdio
Add to your MCP config (claude_desktop_config.json or equivalent):
{
"mcpServers": {
"qjtrader": {
"command": "uvx",
"args": ["qjtrader-mcp"],
"env": {
"QJ_CLIENT_ID": "your-client-id",
"QJ_CLIENT_SECRET": "your-client-secret",
"QJ_ENV": "sandbox"
}
}
}
}
The console's "Connect your AI" panel generates these blocks pre-filled, including
QJ_ENV=sandbox.
Tools
| Tool | Kind | Description |
|---|---|---|
session_info |
read | Authoritative environment plus the Data products, Order Entry products, and trading accounts active on this key. Call first. |
market_availability |
read, offline | Product-by-product sandbox vs production data/order support, verified examples, and known gaps. Call before assuming a product has depth or order authority. |
access_status |
human account read | Shows products and requests after qjtrader login; machine trading keys do not grant this authority. |
request_production_access |
human request | Requests account-level Data or Order Entry access through the signed-in user API, or returns a safe browser handoff when login is absent. It cannot approve, promote, or choose internal routes. |
request_limit_change |
human request | Requests product-specific cloud API safeguards for a production key. Broker/Desktop risk controls remain independent and unchanged. |
search_universe |
read | Search current symbol forms and capability metadata by market or text |
describe_instrument |
read | Describe one symbol, its product identity, venue scope, and available operations |
market_availability also returns an observation_contract and source-aware
data_shapes. Agents must preserve null or silence as "unquoted now," treat
orders/venues on depth levels as optional, and never infer Greeks, NAV,
contract terms, depth, or order authority from the security type alone. Canadian
get_depth results include rounded Top5, odd/special-lot views, entitled
order_bids/order_asks QJ/TMX TL2 rows, and source timing/provenance.
| get_quote | read | Top-of-book (best bid/ask) for one or more symbols |
| get_depth | read | Level-2 order book for a symbol (venue-tagged on consolidated books) |
| watch | read | Sample the live stream for a bounded window; returns a digest + last messages |
| list_orders | read | Open orders + session state |
| get_positions | read | Broker-truth positions (broker + fill = total), cloud-route and Desktop-profile safeguards, estimated capital in current positions, and order plane |
| place_order | write | Submit a limit order and wait for a terminal state |
| cancel_order | write | Cancel a working order by cid |
| replace_order | write | Amend a working order's qty/price |
| cancel_all | write | Cancel every working order (kill switch) |
| explain_symbol | util | Parse/explain a symbol (prefix + root + venue), offline |
| read_events | read | Order journal — cross-order event history; post-trade analysis & strategy debugging |
| get_history | read | Historical OHLCV bars (1s/1m); sandbox = deterministic synthetic days |
| get_stats | read | Server digest for a symbol: VWAP, spread, volume, realized vol (a digest, not a dump) |
| get_chain | read | Options chain snapshot for an underlying/expiry (latest or historical) |
| compare | read | Rank a digest metric (vwap/volume/realized_vol/spread_mean) across symbols |
The read_*/get_* research tools make the LLM a quant developer: analyse the
market and debug the strategy it wrote, without touching the production order path.
Configuration reference
| Env var | Purpose | Default |
|---|---|---|
QJ_CLIENT_ID / QJ_CLIENT_SECRET |
credential | — (required) |
QJ_ENV |
Optional expected environment; mismatch refuses mutations | unset |
QJ_MCP_ALLOW_LIVE |
set 1 to authorize live order actions |
off |
QJ_MCP_MAX_QTY |
client-side max order quantity | 25 |
QJ_DATA_HOST / QJ_ORDERS_HOST |
endpoint overrides | public QJ hosts |
QJ_CA_FILE |
pin a CA/cert (pilot order endpoint) | none |
License
Apache-2.0. See LICENSE.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file qjtrader_mcp-0.4.6.tar.gz.
File metadata
- Download URL: qjtrader_mcp-0.4.6.tar.gz
- Upload date:
- Size: 27.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
132e66c421d00cd442817b26d71711cd554f8d43b223cbb410aad89a590a0eae
|
|
| MD5 |
28b194194e302ae84ba270f6ccab2631
|
|
| BLAKE2b-256 |
3c73fc1feba39c1e1f7c2f053ae02cad774c0d733af86e6e521e9557a4de5b47
|
Provenance
The following attestation bundles were made for qjtrader_mcp-0.4.6.tar.gz:
Publisher:
publish.yml on QJTrader/qjtrader-mcp
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
qjtrader_mcp-0.4.6.tar.gz -
Subject digest:
132e66c421d00cd442817b26d71711cd554f8d43b223cbb410aad89a590a0eae - Sigstore transparency entry: 2203419538
- Sigstore integration time:
-
Permalink:
QJTrader/qjtrader-mcp@241a5b2f5839fdac0d7c49b9cc773d22bfc45f11 -
Branch / Tag:
refs/tags/v0.4.6 - Owner: https://github.com/QJTrader
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@241a5b2f5839fdac0d7c49b9cc773d22bfc45f11 -
Trigger Event:
push
-
Statement type:
File details
Details for the file qjtrader_mcp-0.4.6-py3-none-any.whl.
File metadata
- Download URL: qjtrader_mcp-0.4.6-py3-none-any.whl
- Upload date:
- Size: 23.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
169ac04283f3b444cac319a895069c78438f9e1d3a1953cc45b91823d2f9c35d
|
|
| MD5 |
268995e67ace470ae066e377ce4e76f3
|
|
| BLAKE2b-256 |
fb7dd8a4ce87262fbb68bd4e973153cb0e4a10bb9006aba9ff92da036f8b2aca
|
Provenance
The following attestation bundles were made for qjtrader_mcp-0.4.6-py3-none-any.whl:
Publisher:
publish.yml on QJTrader/qjtrader-mcp
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
qjtrader_mcp-0.4.6-py3-none-any.whl -
Subject digest:
169ac04283f3b444cac319a895069c78438f9e1d3a1953cc45b91823d2f9c35d - Sigstore transparency entry: 2203419547
- Sigstore integration time:
-
Permalink:
QJTrader/qjtrader-mcp@241a5b2f5839fdac0d7c49b9cc773d22bfc45f11 -
Branch / Tag:
refs/tags/v0.4.6 - Owner: https://github.com/QJTrader
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@241a5b2f5839fdac0d7c49b9cc773d22bfc45f11 -
Trigger Event:
push
-
Statement type: