ib-gateway-mcp

Search symbols

search_symbols

Read-only

Find instruments by ticker prefix or company name, returning con_id, symbol, and exchange details. Use it to discover a symbol before requesting exact contract details.

Instructions

Find instruments by ticker prefix or company name (IBKR's symbol search).

Returns up to `limit` matches (default 16, IBKR rarely sends more): each with its
con_id, symbol, sec_type, primary exchange, currency, name (`description`) and the
derivative types listed on it (OPT, FUT, WAR...). Use it to discover a symbol or its
con_id, then call qualify_contract or get_contract_details for the exact contract.

Limits: discovery only, not exhaustive (no options or futures months in the results;
use get_option_chain or get_contract_details for those). IBKR allows about one search
per second, so back-to-back searches are spaced out. Errors: not_found when nothing
matches; request_timeout when IBKR did not answer within 4 seconds.

Input Schema

TableJSON Schema

Name	Required	Description	Default
`limit`	No	Maximum number of items to return. Omit for the tool's default; larger values are capped. The result's truncated flag says whether more were available.
`pattern`	Yes	The first letters of a ticker (e.g. 'AAP') or a word from the company or instrument name (e.g. 'apple').

Output Schema

TableJSON Schema

Name	Required	Description
`total`	Yes	How many matches IBKR returned before the limit.
`matches`	Yes
`pattern`	Yes
`truncated`	No	True when the result was cut to the limit.

Schema Changelog

Changes observed during successful MCP inspections.

First observedv0.1.0Sep 23, 2026

TDQS

A4.9/5.0

Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint and openWorldHint, lowering the bar, but the description adds substantial behavioral detail: default and typical limit of 16 matches, the truncated flag, exact fields returned, per-second rate spacing, and specific error cases (not_found, request_timeout with a 4-second threshold). This goes well beyond the annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is dense but every sentence earns its place: the first line states the core function, the second explains return shape and next steps, and the third covers limits, rate behavior, and error semantics. It is front-loaded with the most important information and contains no filler.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a search/discovery tool with read-only and open-world annotations, this description is complete. It covers what the tool returns, what it does not return, how to handle rate limits, what errors to expect, and how to proceed after discovery. An agent has everything needed to invoke it correctly and interpret results.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3, but the description adds meaning beyond the schema by explaining the default limit behavior, that IBKR rarely sends more than 16, and that the result's truncated flag indicates additional matches. The pattern parameter is already well described in the schema, so the description does not need to repeat it.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb and resource: find instruments by ticker prefix or company name. It also distinguishes this tool from siblings by positioning it as the discovery step before qualify_contract or get_contract_details, and by noting it is not exhaustive for options/futures months unlike get_option_chain. This makes the tool's scope unmistakable.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description gives explicit when-to-use guidance: use it to discover a symbol or con_id, then switch to qualify_contract or get_contract_details. It also names exclusions (no options/futures months, use get_option_chain or get_contract_details) and warns about the one-search-per-second IBKR rate limit, so an agent knows how to sequence calls.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server