read_apic_doc

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

With no annotations provided, the description carries the full behavioral disclosure burden. It does disclose the core behavior—reading a documentation page and returning Markdown—but says nothing about failure modes, access requirements, or side effects. For a simple read-only tool this is adequate but not rich.

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 efficient sentence that states the action, target, and output format, followed by a practical instruction for obtaining the parameter. Every word earns its place.

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 one-parameter tool with no output schema and no annotations, the description covers the essential information: what the tool does, what it returns, and where the href comes from. It is slightly lean on potential edge cases like invalid hrefs, but not enough to be called incomplete for typical use.

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 already fully describes the 'href' parameter with 100% coverage, so the baseline is 3. The description adds meaningful value by telling the agent that the href comes from search results or TOC, which clarifies the parameter source and validates the expected value format.

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 ('Read'), identifies the exact resource (a specific IBM API Connect documentation page), and specifies the output format (Markdown). It is clearly distinguished from sibling tools by explaining that its input comes from search results or TOC, making its role in the workflow clear.

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 instruction to use the 'href' from search results or TOC gives direct guidance on when and how to invoke this tool relative to its siblings. It does not explicitly name the alternative tools or state when not to use it, but the provenance guidance strongly implies the intended workflow.

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