ib-gateway-mcp

Connection details

get_connection_info

Read-only

Retrieve technical details of your IB Gateway API session, including endpoint, client ID, API versions, and sync status. Works even when disconnected, returning session fields as null.

Instructions

Return technical details of the API session: endpoint, client id, API versions.

Includes the negotiated server version, the API version range this client speaks,
whether open and completed orders were synced (`orders_synced`), when the session
started, and traffic counters. Works when disconnected too (the session fields are
then null).

Input Schema

TableJSON Schema

Name	Required	Description	Default
No arguments

Output Schema

TableJSON Schema

Name	Required	Description
`host`	Yes
`port`	Yes
`client_id`	Yes
`connected`	Yes
`bytes_sent`	No
`messages_sent`	No
`orders_synced`	No	Whether this session loaded the open and completed orders.
`bytes_received`	No
`server_version`	No	Negotiated TWS API server version.
`connected_since`	No
`ib_async_version`	Yes
`messages_received`	No
`client_version_range`	Yes	API versions this client speaks, 'min..max'.
`server_package_version`	Yes	Version of ib-gateway-mcp.

Schema Changelog

Changes observed during successful MCP inspections.

First observedv0.1.0Sep 23, 2026

TDQS

A4.5/5.0

Behavior4/5

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

Annotations already declare readOnlyHint=true and openWorldHint=true, and the description adds useful behavior beyond that: it lists what data is included and discloses that when disconnected the session fields are null. This gives the agent a realistic expectation of the result even in an offline state.

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 compact and front-loaded: the first sentence states the core purpose, and the second sentence efficiently enumerates the returned fields. No words are wasted, and every sentence adds meaningful information.

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 zero-parameter read-only tool with an output schema present, this description is complete. It explains the purpose, the returned content, and the edge case of being disconnected, so an agent has everything needed to select and invoke the tool correctly.

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?

The tool has no parameters, so there is no parameter semantics to clarify. The description appropriately focuses on what the tool returns instead, which is the correct use of description space here.

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 uses a specific verb ('Return') and a specific resource ('technical details of the API session'), then lists concrete fields like endpoint, client id, and API versions. This clearly distinguishes it from sibling get_* tools such as get_user_info or get_server_time, so an agent can identify its purpose without opening the schema.

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

Usage Guidelines4/5

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

The description gives clear context by stating the tool returns session-level technical details and explicitly notes it 'works when disconnected too.' It does not name sibling alternatives or state when not to use it, but for a zero-parameter diagnostic tool this level of context is largely sufficient.

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

Deploy Server