ib-gateway-mcp

News article

get_news_article

Read-only

Retrieve the full text of a news article using its provider code and article ID, with optional plain-text conversion and character limits.

Instructions

Return the full text of a news article, given its provider code and article id.

Take both from a headline (get_historical_news or a news subscription). HTML
articles are converted to plain text unless plain_text is false. Text longer than
max_chars (default 20000) is cut and truncated is true; total_chars gives the full
length. Binary articles (PDFs) are reported with article_type=binary and their
size, not returned. Needs a subscription to the provider.
Errors: ib_api_error with IBKR's message when the article is unknown or not
permitted; not_found when IBKR sends an empty article.

Input Schema

TableJSON Schema

Name	Required	Description
`max_chars`	No	Longest article text to return, in characters (at most 200,000); a longer article is cut and truncated is true.
`article_id`	Yes	Article id from the headline, e.g. BRFG$12345.
`plain_text`	No	Convert HTML articles to plain text (fewer characters).
`provider_code`	Yes	Provider code from the headline, e.g. BRFG.

Output Schema

TableJSON Schema

Name	Required	Description
`note`	No	Why the text is missing or was converted.
`text`	No	The article; null for binary articles.
`format`	No	Whether text is plain text or HTML; null for binary articles.
`truncated`	No	True when the result was cut to the limit.
`article_id`	Yes
`total_chars`	No	Length of the whole text before truncation.
`article_type`	Yes	text (plain text or HTML) or binary (a PDF, which is not returned).
`binary_bytes`	No	Approximate size of a binary (PDF) article, in bytes.
`binary_base64`	No	The binary document, base64-encoded as IBKR sent it. Only for library callers that ask for it (``include_binary``); the MCP tool never returns it.
`provider_code`	Yes

Schema Changelog

Changes observed during successful MCP inspections.

First observedv0.1.0Sep 23, 2026

TDQS

A4.7/5.0

Behavior5/5

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

The description goes well beyond the readOnly/openWorld annotations: it discloses HTML-to-plain-text conversion, truncation behavior with truncated and total_chars, binary article handling via article_type=binary, and the two error modes ib_api_error and not_found. This gives the agent a precise model of the tool's behavior.

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 definition is front-loaded with the core purpose, followed by a compact paragraph of behavioral details and a final error list. Every sentence carries useful information; there is no filler or repetition of schema titles.

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 read-only retrieval tool with an output schema, the description covers everything an agent needs to call it correctly: input provenance, content transformation, truncation, binary edge cases, subscription requirement, and expected errors. Nothing material is missing.

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 schema already documents all four parameters at 100% coverage, so the baseline is 3. The description adds value by connecting provider_code and article_id to headline sources, explaining the max_chars default and truncation semantics, and noting the effect of plain_text for HTML articles.

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 opens with the specific operation: 'Return the full text of a news article, given its provider code and article id.' This clearly identifies the resource and inputs, and the mention of get_historical_news as the source of headers distinguishes this retrieval tool from headline-listing siblings.

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?

It explicitly says where to obtain the inputs ('Take both from a headline (get_historical_news or a news subscription)') and notes the prerequisite that the user needs a subscription to the provider. It does not enumerate exclusions or alternative retrieval tools, but the call context is clear.

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

Deploy Server