sdk_read

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It does disclose that the tool reads HTML content as text and includes linked topics for navigation, which is genuinely useful. However, it does not explain how offset and length affect output, what a not-found topic does, or how the linked topics are represented in the result.

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 well-structured sentence with no wasted words. It immediately states the action, the resource, the output format, and the notable navigation behavior. It is appropriately sized for the tool's complexity.

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 three-parameter tool with no output schema and no annotations, the description provides a reasonable starting point but leaves key details open: how linked topics appear, whether output is paginated by offset/length, and what happens for invalid topic values. It is adequate for basic invocation but not fully complete for confident agent 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 has 0% description coverage, and the tool description only clarifies 'topic' by calling it an 'exact SDK HTML topic.' The length and offset parameters are not mentioned in the description at all, leaving their semantics to inference from names and defaults. The description does not sufficiently compensate for the missing schema documentation on two of three parameters.

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 with a resource: 'Read an exact SDK HTML topic as text.' It also calls out 'exact' and 'including linked topics for navigation,' which differentiates it from sdk_search and the api_describe* siblings. This gives an agent a clear sense of what this tool does and what distinguishes it.

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 word 'exact' implies the agent should already know the specific topic, and the mention of navigation suggests this is for reading a known topic rather than searching for one. However, the description does not explicitly say 'use sdk_search to find a topic first' or otherwise contrast when to use this tool versus alternatives. Usage is implied rather than stated.

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