ib-async-mcp

Overview Schema Source Related Servers Discussions Admin

get_contract_details

Retrieve detailed contract specifications for trading instruments, including symbol, exchange, and currency information, to support market analysis and trade execution.

Instructions

Get detailed contract information.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "contract_type": "<contract_type>",
      "symbol": "<symbol>"
    },
    "name": "get_contract_details"
  }
}

Input Schema

Name	Required	Default
`contract_type`	Yes
`symbol`	Yes
`exchange`	No	SMART
`currency`	No	USD

Implementation Reference

src/ib_async_mcp/server.py:540-548 (handler)

The handler logic for 'get_contract_details' that creates a contract object and calls `ib.reqContractDetailsAsync`.

if name == "get_contract_details":
    contract = create_contract(
        args["contract_type"],
        symbol=args["symbol"],
        exchange=args.get("exchange", "SMART"),
        currency=args.get("currency", "USD"),
    )
    details = await ib.reqContractDetailsAsync(contract)
    return [serialize_object(d) for d in details]

src/ib_async_mcp/server.py:179-192 (schema)

The tool definition and schema for 'get_contract_details'.

Tool(
    name="get_contract_details",
    description="Get detailed contract information.",
    inputSchema={
        "type": "object",
        "properties": {
            "contract_type": {"type": "string"},
            "symbol": {"type": "string"},
            "exchange": {"type": "string", "default": "SMART"},
            "currency": {"type": "string", "default": "USD"},
        },
        "required": ["contract_type", "symbol"],
    },
),

Schema Changelog

Changes observed during successful MCP inspections.

First observedv0.1.0Mar 25, 2026

TDQS

C2.3/5.0

Behavior2/5

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

Without annotations, the description carries full burden but only states 'get,' implying read-only. It does not disclose potential errors, network calls, or what 'detailed information' entails (e.g., contract conditions, trading hours).

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

Conciseness4/5

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

The description is a single sentence, concise and free of fluff. However, it sacrifices informativeness for brevity; slightly more detail would be beneficial.

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

Completeness2/5

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

Given 4 parameters (2 required), no output schema, and no annotations, the description is insufficient. It fails to explain the return structure, parameter co-constraints (e.g., exchange and currency defaults), or any side effects.

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

Parameters1/5

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 adds no meaning to parameters like contract_type, symbol, exchange, or currency. The agent gains no understanding of how these fields affect the query.

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

Purpose3/5

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

The description 'Get detailed contract information' clearly indicates the tool retrieves contract details, but it is generic and does not distinguish it from sibling tools like get_option_chain or qualify_contracts. A more specific description would improve clarity.

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

Usage Guidelines2/5

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

The description provides no guidance on when to use this tool versus alternatives or any prerequisites. For example, it doesn't mention that contract_type and symbol are required or when exchange or currency defaults apply.

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