Interactive Brokers MCP Server
The Interactive Brokers MCP Server provides an unofficial Model Context Protocol interface that enables AI assistants to integrate with Interactive Brokers for automated account management and trading operations.
Key Capabilities:
Authentication: Secure OAuth authentication via web browser or headless mode with credentials
Account Management: Retrieve detailed account information and balances (
get_account_info)Position Tracking: View current positions and profit/loss details (
get_positions)Market Data: Access real-time market data for specific symbols with optional exchange specification (
get_market_data)Order Management: Place market, limit, and stop orders with full control over account ID, symbol, action (BUY/SELL), quantity, and pricing (
place_order)Order Monitoring: Check status and execution details of orders using order ID (
get_order_status)
Designed for local use only with a focus on security, the server supports both paper and live trading environments for interactive and automated operations.
Provides runtime environment for the MCP server to execute trading operations and communicate with Interactive Brokers Gateway
Click on "Install Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@Interactive Brokers MCP Servershow me my current portfolio positions"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
Interactive Brokers MCP Server
DISCLAIMER: This is an unofficial, community-developed MCP server and is NOT affiliated with or endorsed by Interactive Brokers. This software is in Alpha state and may not work perfectly.
A Model Context Protocol (MCP) server that provides integration with Interactive Brokers' trading platform. This server allows AI assistants to interact with your IB account to retrieve market data, check positions, and place trades.
🔒 Security Notice

Related MCP server: Interactive Brokers MCP Server
Features
Interactive Brokers API Integration: Full trading capabilities including account management, position tracking, real-time market data, and order management (market, limit, and stop orders)
Flex Query Support: Execute Flex Queries to retrieve account statements, trade confirmations, and historical data. Queries are automatically remembered for easy reuse
Flexible Authentication: Choose between browser-based OAuth authentication or headless mode with credentials for automated environments, including fully automated TOTP 2FA override. See TOTP 2FA Strategy Document for detailed configuration and important risk warnings.
Simple Setup: Run directly with
npx- no Docker or additional installations required. Includes pre-configured IB Gateway and Java runtime for all platforms
Security Notice
IMPORTANT WARNINGS:
Financial Risk: Trading involves substantial risk of loss. Always test with paper trading first.
Security: This software handles sensitive financial data. Only run locally, never on public servers.
No Warranty: This unofficial software comes with no warranties. Use at your own risk.
Not Financial Advice: This tool is for automation only, not financial advice.
Prerequisites
No additional installations required for mainstream platforms. This package includes:
Pre-configured IB Gateway for all platforms (Linux, macOS, Windows)
Java Runtime Environment (JRE) for macOS, Windows, and standard Linux builds
Automatic first-run musl JRE download for Alpine-based containers (e.g.
node:lts-alpine, supergateway)All necessary dependencies
You only need:
Interactive Brokers account (paper or live trading)
Node.js 18+ (for running the MCP server)
Quick Start
Add this MCP server to your Cursor/Claude configuration:
{
"mcpServers": {
"interactive-brokers": {
"command": "npx",
"args": ["-y", "interactive-brokers-mcp"]
}
}
}When you first use the server, a web browser window will automatically open for the Interactive Brokers OAuth authentication flow. Log in with your IB credentials to authorize the connection.
Headless Mode Configuration
For automated environments or when you prefer not to use a browser for authentication, you can enable headless mode by configuring it in your MCP server configuration:
{
"mcpServers": {
"interactive-brokers": {
"command": "npx",
"args": ["-y", "interactive-brokers-mcp"],
"env": {
"IB_HEADLESS_MODE": "true",
"IB_USERNAME": "your_ib_username",
"IB_PASSWORD_AUTH": "your_ib_password"
}
}
}
}
In headless mode, the server will automatically authenticate using your credentials without opening a browser window. This is useful for:
Automated trading systems
Server environments without a display
CI/CD pipelines
Situations where browser interaction is not desired
Important: Even in headless mode, Interactive Brokers may still require
two-factor authentication (2FA). When 2FA is triggered, the headless
authentication will wait up to 60 seconds for you to complete the 2FA process
through your configured method (mobile app, SMS, etc.) before returning an
AUTHENTICATION_PENDING response. Wait for approval to complete, then check
account info again.
To enable paper trading, add "IB_PAPER_TRADING": "true" to your environment variables:
{
"mcpServers": {
"interactive-brokers": {
"command": "npx",
"args": ["-y", "interactive-brokers-mcp"],
"env": {
"IB_HEADLESS_MODE": "true",
"IB_USERNAME": "your_ib_username",
"IB_PASSWORD_AUTH": "your_ib_password",
"IB_PAPER_TRADING": "true"
}
}
}
}Security Note: Store credentials securely and never commit them to version control. Consider using environment variable files or secure credential management systems.
Flex Query Configuration (Optional)
To use Flex Queries for retrieving account statements and historical data, you need to configure your Flex Web Service Token:
{
"mcpServers": {
"interactive-brokers": {
"command": "npx",
"args": ["-y", "interactive-brokers-mcp"],
"env": {
"IB_FLEX_TOKEN": "your_flex_token_here"
}
}
}
}How to Get Your Flex Token:
Log in to Interactive Brokers Account Management
Go to Settings → Account Settings
Navigate to Reporting → Flex Web Service
Generate or retrieve your Flex Web Service Token
For detailed instructions on enabling Flex Web Service, see the IB Flex Web Service Guide.
Creating Flex Queries:
Go to Reports → Flex Queries in Account Management
Create or customize your query template
Click the info icon next to your query to find its Query ID
For a complete guide on creating and customizing Flex Queries, see the IB Flex Queries Guide.
Note: When you execute a Flex Query for the first time, the MCP server automatically saves it with its name from the API. Future executions can reference the query by either its ID or its saved name.
Flex Query Features:
Automatic Memory: When you execute a Flex Query, it's automatically saved for future use
Easy Reuse: Previously used queries are remembered - no need to copy query IDs repeatedly
Friendly Names: Optionally provide a friendly name when first executing a query
Forget Queries: Remove queries you no longer need with the
forget_flex_querytool
Configuration Variables
Feature | Environment Variable | Command Line Argument |
Username |
|
|
Password |
|
|
Headless Mode |
|
|
Paper Trading |
|
|
Auth Timeout |
|
|
Auth Wait Seconds |
|
|
Auth Poll Seconds |
|
|
Force standalone bundled gateway |
| N/A |
Flex Token |
| N/A |
Read-only mode |
|
|
2FA Strategy |
| N/A |
TOTP Secret Key |
| N/A |
Login page selector overrides |
| N/A |
TOTP form selector overrides |
| N/A |
See the TOTP 2FA Strategy Document for details on the 2FA and selector-override variables.
Gateway Lifecycle
On startup, the MCP first probes reachable local Gateway endpoints on the configured port and common Client Portal Gateway ports. If a healthy existing Gateway is found, the MCP attaches to it and does not start another bundled Gateway.
When no suitable existing Gateway is reachable, the MCP starts the bundled Java Gateway as a durable detached process. Runtime coordination files are stored under ib-gateway/.runtime/:
gateway-session.jsonrecords the MCP-managed Gateway pid, port, version, and log paths.gateway-session.lockprevents two MCP processes from starting duplicate managed Gateways at the same time.gateway.stdout.logandgateway.stderr.logreceive the Gateway process output.
Normal MCP shutdown detaches from the Gateway and leaves it running so later MCP runs can reuse it. If IB_FORCE_STANDALONE_GATEWAY=true is set, the MCP skips unrelated external Gateway discovery, but it still reuses or coordinates through the durable MCP-managed session metadata and lock files.
To reset the managed Gateway session, stop the Gateway process recorded in ib-gateway/.runtime/gateway-session.json, then remove ib-gateway/.runtime/gateway-session.json and any stale ib-gateway/.runtime/gateway-session.lock. The MCP automatically removes stale metadata when the recorded pid no longer exists.
Available MCP Tools
Trading & Account Management
Tool | Description |
| Retrieve account information and balances |
| Get current positions and P&L |
| Real-time market data for symbols |
| Place market, limit, or stop orders (only if read-only mode is disabled) |
| Check order execution status |
| Get all live/open orders for monitoring |
Flex Queries (Requires IB_FLEX_TOKEN)
Tool | Description |
| Execute a Flex Query and retrieve statements (auto-saves for reuse) |
| List all previously used Flex Queries |
| Remove a saved Flex Query from memory |
Troubleshooting
Authentication Problems:
Use the web interface that opens automatically
Complete any required two-factor authentication
Try paper trading mode if live trading fails
Gateway Discovery Problems:
If another IB Gateway is already listening on a local port but should not be reused, set
IB_FORCE_STANDALONE_GATEWAY=trueExisting gateways are only reused when the MCP process can reach them over HTTPS; otherwise the bundled standalone gateway is started on an available port
For MCP-managed Gateway startup issues, inspect
ib-gateway/.runtime/gateway.stdout.log,ib-gateway/.runtime/gateway.stderr.log, andib-gateway/.runtime/gateway-session.jsonTo clear a stale managed startup lock, confirm no MCP process is currently starting Gateway, then remove
ib-gateway/.runtime/gateway-session.lock
Support
This Server: Open an issue in this repository.
License
MIT License - see LICENSE file for details.
Thanks to our contributors
A big thank you to everyone who has contributed to making this project better.
Available Tools
14 toolsactivate_alertA
Activate a previously created alert. Usage: { "accountId": "<id>", "alertId": "<alertId>" }.
| Name | Required | Description | Default |
|---|---|---|---|
| alertId | Yes | ||
| accountId | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description bears the full burden of behavioral disclosure. It only states 'activate' and gives a usage example. It does not describe side effects, authentication needs, idempotency, or what happens if the alert is already active. The lack of detail limits transparency.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is extremely concise: one sentence and a code block. It is front-loaded with the purpose. Every part earns its place; the code block helps agent understand the exact structure expected, which is useful despite schema repetition.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple tool with two string parameters and no output schema, the description is minimally adequate. It states the action and gives a usage example, which covers basic usage. However, it omits details like response format, error conditions, and prerequisites (e.g., alert must exist). Given the lack of annotations, it feels slightly incomplete.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema has no descriptions for parameters, and the schema description coverage is 0%. The description only provides a usage example with placeholders (`<id>`, `<alertId>`) but adds no semantic meaning about what these IDs represent or their format. This adds minimal value beyond the parameter names.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the action: 'Activate a previously created alert.' It uses a specific verb ('activate') and resource ('alert'). The sibling tools (create_alert, delete_alert, get_alerts) are distinct, so the agent can differentiate this tool for activation only.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly mentions that the alert must be 'previously created,' providing context for when to use the tool. It includes a usage example with the required JSON structure. However, it does not specify when not to use it (e.g., if the alert is already active) or mention alternatives, but the sibling names fill some gaps.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
authenticateA
Authenticate with Interactive Brokers. Usage: { "confirm": true }.
| Name | Required | Description | Default |
|---|---|---|---|
| confirm | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description must fully disclose behaviors. It only states 'Authenticate' and gives a usage example, omitting what happens upon success (e.g., session token), error states, or side effects. This is insufficient for understanding the tool's full impact.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is extremely concise with two short sentences. No extraneous information is included. Every element (action, target, usage example) serves a clear purpose.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's low complexity (single parameter, no output schema), the description provides the essential action and parameter usage. However, it lacks details on return values or post-authentication state, which would be helpful for an authentication tool. It is minimally adequate.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0%, so the description must compensate. It does so partially by providing a usage example (`{"confirm": true}`) that clarifies the parameter's purpose as a confirmation flag. However, it does not explain why confirmation is required or what it safeguards against.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description explicitly states the tool's action ('Authenticate') and target ('Interactive Brokers'). This is a specific verb+resource combination that distinguishes it from sibling tools like 'activate_alert' or 'place_order'.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies usage for initial authentication but provides no explicit guidance on when to use versus alternatives (e.g., re-authentication). No exclusion conditions or prerequisites are mentioned.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
confirm_orderB
Manually confirm an order that requires confirmation. Usage: { "replyId": "742a95a7-55f6-4d67-861b-2fd3e2b61e3c", "messageIds": ["o10151", "o10153"] }.
| Name | Required | Description | Default |
|---|---|---|---|
| replyId | Yes | ||
| messageIds | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided. Description only says 'manually confirm' without explaining side effects, required permissions, or what happens upon success/failure. The example only shows parameter structure, not behavior.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Very concise, two sentences. No unnecessary words. Could be slightly improved by separating example from usage context, but still efficient.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Lacks critical context: no output schema, no prerequisites, no error handling details. Given the tool modifies state (confirms order), description should be more comprehensive.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 0%. Description provides an example mapping replyId and messageIds but does not explain their meanings or constraints beyond the schema definition.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Clearly states verb 'confirm' and resource 'order', specifying that it is for orders requiring manual confirmation. Distinguishes from sibling tools like place_order, get_order_status, etc.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Implies usage when an order needs confirmation, but does not explicitly state when to use or avoid this tool. No mention of alternatives or prerequisites.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
create_alertC
Create a new trading alert. Usage: { "accountId": "<id>", "alertRequest": { "alertName": "Price Alert", "conditions": [{ "conidex": "265598", "type": "price", "operator": ">", "triggerMethod": "last", "value": "150" }] } }.
| Name | Required | Description | Default |
|---|---|---|---|
| accountId | Yes | ||
| alertRequest | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description must fully disclose behavior. It only says 'Create a new trading alert' with an example, but does not mention side effects (e.g., duplicate handling, permissions, or any irreversible changes). The description is minimal.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is one short sentence with an illustrative code block. It is front-loaded and concise, though the example is lengthy. It could be slightly more structured, but it is effective.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
No output schema is present, and the description does not mention return values, error conditions, or behavior with optional fields. Given the nested object complexity, more context is needed for complete understanding.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema has 0% description coverage, so the description must compensate. The usage example partially explains parameters (e.g., accountId, alertRequest with conditions), but many fields in the schema (e.g., alertMessage, expireTime) are not described. The example provides a concrete pattern but lacks full semantics.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool's purpose: 'Create a new trading alert.' The usage example provides concrete context, making the action unmistakable. However, it does not differentiate from sibling tools like activate_alert or delete_alert, though those are distinct actions.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance is given on when to use this tool versus alternatives (e.g., modify_alert or activate_alert). There is no mention of prerequisites, constraints, or when not to use it. A user must infer from context alone.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
delete_alertC
Delete an alert. Usage: { "accountId": "<id>", "alertId": "<alertId>" }.
| Name | Required | Description | Default |
|---|---|---|---|
| alertId | Yes | ||
| accountId | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description must carry the full burden. It only states 'Delete an alert', implying a destructive action, but omits details on side effects, permissions, or reversibility.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is extremely concise with two short sentences. It is front-loaded with the action and followed by a usage example. No unnecessary words.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's simplicity (2 required params, no output schema), the description is insufficient. It lacks parameter semantics, usage guidelines, and behavioral details, leaving the agent with minimal decision support.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema has 0% description coverage, and the description only repeats the structure without explaining the purpose or acceptable values of accountId and alertId.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states 'Delete an alert' with a verb and resource. It distinguishes from sibling tools like create_alert and activate_alert. However, it lacks context on scope or irreversibility.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance on when to use this tool versus alternatives (e.g., deactivating an alert). The description only provides a usage example but no situational advice.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_account_infoB
Get account information and balances. Usage: { "confirm": true }.
| Name | Required | Description | Default |
|---|---|---|---|
| confirm | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, and the description does not disclose behavioral traits such as whether confirmation is required for safety, side effects, or permissions needed. The example implies a confirmation step but does not explain its implications.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two sentences, concise and front-loaded with the purpose. However, it could be slightly expanded without losing conciseness to include more context or usage hints.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the lack of output schema and annotations, the description is too brief. It does not specify what account information or balances are returned, prerequisites, or any other details necessary for an agent to use the tool confidently.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The schema has 0% description coverage for parameters, so the burden falls on the description. The description shows the usage format with `confirm: true`, adding minimal meaning beyond the schema's const requirement. It does not explain why confirm is needed or any constraints.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description explicitly states 'Get account information and balances', which is a specific verb and resource. This clearly distinguishes it from sibling tools like get_positions and get_order_status, which focus on different aspects.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides a usage example but gives no guidance on when to use this tool versus alternatives. With many sibling tools, this omission makes it difficult for an AI agent to select the correct tool without additional context.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_alertsC
Get all trading alerts for an account. Usage: { "accountId": "<id>" }.
| Name | Required | Description | Default |
|---|---|---|---|
| accountId | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the full burden. It only states that alerts are retrieved, with no mention of side effects, authentication requirements, rate limits, or behavior details. For a read operation, this is minimal.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is very short and front-loaded with the purpose. The usage example is clearly formatted. However, it could include more context without being overly verbose.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With no output schema and no annotations, the description lacks completeness. It doesn't describe return values, error conditions, or pagination. For a simple parameter tool, some additional context is expected.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The schema has 0% description coverage, and the description only gives a usage example for accountId without explaining what it represents, its format, or constraints. This adds minimal meaning beyond the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description uses a specific verb ('Get') and resource ('trading alerts'), clearly stating what the tool does and distinguishing it from sibling tools like create_alert or delete_alert.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides a usage example but offers no guidance on when to use this tool versus alternatives like get_account_info or get_live_orders. No when-not-to-use context is given.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_live_ordersA
Get all live/open orders for monitoring and validation. Usage: {} for all accounts or { "accountId": "<id>" } for a specific account. This is the recommended way to validate that market orders were executed successfully after placing them.
| Name | Required | Description | Default |
|---|---|---|---|
| accountId | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided, so description must cover behavioral traits. It implies read-only but does not explicitly state safety, authentication needs, or rate limits. Lacks disclosure of side effects or limitations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences with a usage example, no wasted words. Front-loaded with the primary purpose and immediately usable information.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given no output schema, the description does not describe the return format. It covers the core functionality well but omits details on response structure and edge cases. Acceptable for a simple list tool but incomplete for richer context.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
With 0% schema description coverage, the description compensates by explaining the optional 'accountId' parameter and its effect (all accounts vs. specific). Adds clear meaning beyond the schema's type-only specification.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the verb 'get' and the resource 'live/open orders' with a defined purpose 'for monitoring and validation.' It distinguishes from 'get_order_status' by focusing on live orders, though not explicitly differentiating from all siblings.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Provides concrete usage examples and a specific recommendation for validating market orders after placement. Does not explicitly state when not to use or list alternatives, but the context is clear.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_market_dataA
Get real-time market data. Usage: { "symbol": "AAPL" } or { "symbol": "AAPL", "exchange": "NASDAQ" }.
| Name | Required | Description | Default |
|---|---|---|---|
| symbol | Yes | ||
| exchange | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided, so the description carries full burden. It mentions 'real-time' but lacks details on rate limits, data freshness, or error handling. Behavioral transparency is minimal.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two short sentences, front-loaded with purpose followed by examples. No wasted words.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple 2-parameter tool with no output schema, the description covers the essential purpose and usage. Could add return format or error information, but sufficient for basic understanding.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
With 0% schema coverage, the description must compensate. It shows usage examples but adds no additional semantics beyond parameter names and types. No format or constraints explained.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool retrieves real-time market data, with the verb 'Get' and specific resource. It is distinct from sibling tools like place_order or get_account_info.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides explicit usage examples showing required and optional parameters. It implies when to use the tool but does not specify when not to use or mention alternatives.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_option_chainA
Get option expirations and strikes for an underlying symbol. Usage: { "symbol": "AAPL" } or { "symbol": "AAPL", "exchange": "SMART" }.
| Name | Required | Description | Default |
|---|---|---|---|
| symbol | Yes | ||
| exchange | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided, so description carries full burden. It does not disclose behavioral traits such as whether the tool is read-only, data freshness, rate limits, or what exactly is returned beyond 'expirations and strikes'. This is a significant gap for a read operation.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
One sentence plus a concise code block. Purpose is front-loaded in the first sentence. Every part is essential and no extra verbiage.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple tool with 2 parameters and no output schema, the description is minimally adequate. It specifies the core functionality and gives examples, but does not fully describe the return structure (e.g., whether it returns separate lists for calls/puts) or edge cases. Could be more complete given no annotations.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0%, but the description adds value by providing example values ('AAPL', 'SMART') which help clarify parameter usage. However, it does not explain what 'symbol' or 'exchange' mean beyond their names, and lacks details on expected formats or constraints.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Description clearly states the verb 'Get' and the resource 'option expirations and strikes for an underlying symbol'. It distinguishes from sibling tools like get_market_data and get_positions, which serve different purposes. Usage examples further clarify the tool's scope.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Provides explicit usage examples with common parameters, showing how to invoke the tool (e.g., with symbol alone or with exchange). However, no when-not-to-use or alternative tool suggestions are given, though sibling tools like resolve_option_conid exist.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_order_statusA
Get the status of a specific order. Usage: { "orderId": "12345" }.
| Name | Required | Description | Default |
|---|---|---|---|
| orderId | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, and the description only states the basic functionality. It does not disclose potential behaviors such as required permissions, rate limits, or that it is a read-only operation.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is extremely concise, consisting of a single sentence and an example. It is front-loaded and wastes no words.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With no output schema and no annotations, the description fails to explain the return format or any additional context about the response, leaving the agent uninformed about what to expect.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The example usage adds context for the 'orderId' parameter, but with 0% schema description coverage, the description could elaborate on the expected format or origin of the order ID.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the verb 'Get' and the resource 'status of a specific order', distinguishing it from siblings like 'get_live_orders' which would return all orders.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Provides a concrete usage example with the correct JSON format, but does not explicitly state when to use this over other tools or mention any prerequisites.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_positionsC
Get current positions. Usage: {} or { "accountId": "<id>" }.
| Name | Required | Description | Default |
|---|---|---|---|
| accountId | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, and the description fails to disclose side effects, permissions, required authentication, or what 'positions' entails. The usage examples are misleading, indicating lack of behavioral clarity.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is very short, which is concise, but the usage examples are potentially incorrect and could be better formatted. It earns its place but is flawed.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given no output schema, no annotations, and a single undocumented required parameter, the description is severely incomplete. It does not explain return values, error conditions, or what 'positions' means, making it inadequate for an agent to use effectively.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
With 0% schema description coverage, the description must compensate but only shows usage patterns without explaining the meaning of accountId (e.g., whose positions). The description adds minimal semantic value beyond the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states 'Get current positions,' providing a specific verb and resource. However, it does not distinguish this tool from siblings like 'get_account_info' or 'get_alerts', which may overlap in functionality.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The usage examples show both an empty object and an object with accountId, but the schema requires accountId, making the empty object invalid. No guidance is given on when to use this tool versus alternatives.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
place_orderA
Place a trading order. Examples:
Market buy:
{ "accountId":"abc","symbol":"AAPL","action":"BUY","orderType":"MKT","quantity":1 }Limit sell:
{ "accountId":"abc","symbol":"AAPL","action":"SELL","orderType":"LMT","quantity":1,"price":185.5 }Stop sell:
{ "accountId":"abc","symbol":"AAPL","action":"SELL","orderType":"STP","quantity":1,"stopPrice":180 }Option buy:
{ "accountId":"abc","symbol":"AAPL","secType":"OPT","expiry":"JAN27","strike":200,"right":"C","action":"BUY","orderType":"LMT","quantity":1,"price":4.5 }Option by conid:
{ "accountId":"abc","conid":123456789,"secType":"OPT","action":"BUY","orderType":"MKT","quantity":1 }Suppress confirmations:
{ "accountId":"abc","symbol":"AAPL","action":"BUY","orderType":"MKT","quantity":1,"suppressConfirmations":true }
| Name | Required | Description | Default |
|---|---|---|---|
| tif | No | ||
| conid | No | ||
| price | No | ||
| right | No | ||
| action | Yes | ||
| expiry | No | ||
| strike | No | ||
| symbol | No | ||
| secType | No | ||
| exchange | No | ||
| quantity | Yes | ||
| accountId | Yes | ||
| orderType | Yes | ||
| stopPrice | No | ||
| suppressConfirmations | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description must disclose behavioral traits. It mentions suppressConfirmations but does not explain execution latency, cancellation policies, success/failure responses, or rate limits. The description lacks critical behavioral context for a mutation tool.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single sentence followed by 6 concise examples. The examples are well-organized and add significant value without redundancy. It could be slightly more structured with a summary line, but overall it's efficient and front-loaded.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given 15 parameters, 4 required, no output schema, and no annotations, the description covers common order types and key parameters. However, it lacks details on return values, error handling, and some parameters (exchange, tif). For the complexity, it is moderately complete but has notable omissions.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 0% (no field descriptions), so the description must compensate. The examples effectively illustrate parameter relationships (e.g., symbol vs conid, secType and expiry for options, suppressConfirmations). However, some parameters like exchange and tif are not demonstrated, leaving minor gaps.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states 'Place a trading order' and provides multiple examples covering various order types (market, limit, stop, options). This makes the purpose explicit and distinguishes it from sibling tools like confirm_order or get_order_status.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description does not explicitly state when to use this tool versus alternatives (e.g., confirm_order, get_order_status). Usage context is implied through examples, but there is no guidance on exclusion criteria or prerequisites (e.g., authentication or account validation).
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
resolve_option_conidA
Resolve a specific option contract conid. Usage: { "symbol": "AAPL", "expiry": "JAN27", "strike": 200, "right": "C" } or add { "exchange": "SMART" }.
| Name | Required | Description | Default |
|---|---|---|---|
| right | Yes | ||
| expiry | Yes | ||
| strike | Yes | ||
| symbol | Yes | ||
| exchange | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description must disclose behavioral traits. It only gives a usage example, failing to mention error cases, rate limits, or any side effects. This is insufficient for a tool with no annotation support.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is extremely concise with two sentences: purpose first, then usage example. Every word is necessary; no fluff.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given 5 parameters, no output schema, and no schema descriptions, the description is adequate but incomplete. It lacks explanation of the return value (what is a conid?), and does not cover all parameter details (e.g., strike formats, expiry patterns). The usage example partially compensates.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The schema has 0% description coverage, but the example shows expected formats (e.g., 'JAN27' for expiry, number for strike, 'C'/'P' for right, optional exchange). This adds significant meaning beyond the schema types, though it only illustrates one format per parameter.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool resolves a specific option contract conid, with a verb and resource. It distinguishes from siblings like get_option_chain, which returns option chains, not a single conid.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides a usage example with parameter details, implying when to use it (to resolve an option conid), but lacks explicit guidance on when not to use it or alternatives among sibling tools.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
TDQS
Each tool targets a distinct action/entity: authentication, account info, alerts (create, get, activate, delete), orders (place, confirm, get live, get status), positions, and market data. No overlap or ambiguity.
All tools follow a consistent verb_noun pattern in snake_case, e.g., activate_alert, get_account_info, place_order. The naming is uniform and predictable.
12 tools cover the core operations for a trading server: authentication, account/position queries, order management, alerts, and market data. This is well-scoped and not excessive.
Essential operations like placing and viewing orders are covered, but critical actions like canceling or modifying an order are missing. Also lacks historical market data and order history, creating notable gaps.
Maintenance
Resources
Unclaimed servers have limited discoverability.
Looking for Admin?
If you are the server author, to access and configure the admin panel.
Related MCP Connectors
Connect AI agents to bank accounts, transactions, balances, and investments.
Connect your AI to a funded trading account. Read & trade a simulated funded challenge.
Build, backtest, and deploy quantitative trading strategies from your AI agent.
Institutional financial data with SEC filing citations, for every AI agent. OAuth 2.1.
Related MCP Servers
- AlicenseNot gradedqualityDmaintenanceProvides AI models with secure access to Interactive Brokers trading data and functionality, enabling account management, market data retrieval, and trading operations through natural language interactions.18MIT
- FlicenseNot gradedqualityDmaintenanceConnects AI assistants to Interactive Brokers for intelligent portfolio management, options analysis, risk monitoring, and automated trading strategy suggestions. Enables real-time account tracking, Greeks calculations, option chain analysis, and playbook-based risk adjustments through natural language.5
- FlicenseNot gradedqualityDmaintenanceEnables interaction with Interactive Brokers via the TWS API or IB Gateway to manage accounts, retrieve market data, and execute trades. It supports features like real-time market data, historical data queries, and order management for stocks and options.4
- AlicenseAqualityAmaintenanceEnables AI agents to trade on Interactive Brokers: check quotes, balance, positions, and execute buy/sell orders (including fractional shares by dollar amount) via the Client Portal API.2012MIT
Latest Blog Posts
- Who's Calling? MCP Hosts Are an Identity Blind Spot (And the Spec Knows It)By Om-Shree-0709 on .mcpAgent IdentityOAuth 2.1
- Your AI Chatbot Just Exposed Your CEO's Salary to an InternBy Om-Shree-0709 on .Agent IdentityMCP SecurityOAuth Delegation
- Why MCP Servers Need Execution Sandboxing (And Why Your Current Stack Isn't Enough)By Om-Shree-0709 on .Agentic AiPrompt InjectionWebAssembly
MCP directory API
We provide all the information about MCP servers via our MCP API.
curl -X GET 'https://glama.ai/api/mcp/v1/servers/code-rabi/interactive-brokers-mcp'
If you have feedback or need assistance with the MCP directory API, please join our Discord server