affinity_read_sdk_documentation_topic

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so the safety profile is fully covered elsewhere. The description adds nothing beyond that: it does not say whether the filename must match exactly, whether an unknown filename errors or returns empty, or what the returned content looks like.

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?

One front-loaded sentence with zero padding — nothing is wasted. However, the brevity reflects under-specification rather than disciplined compression, so it falls short of a 5.

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?

The tool is structurally simple (one string parameter, no output schema), which lowers the bar, but the two things an agent actually needs — the filename format and the discovery path via affinity_list_sdk_documentation — are both absent. Annotations cover the safety profile, yet the core invocation guidance is missing.

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?

Schema description coverage is 0%, so the description carries the burden for the single required parameter, but it only restates 'by filename.' It does not specify the filename format (extension? path? slug?) or how to discover valid values, leaving the agent unable to construct a valid call without trial and error.

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?

States a specific verb and resource: 'Read an Affinity SDK documentation topic by filename.' This is clearly distinguishable from affinity_list_sdk_documentation (which enumerates topics) and affinity_search_sdk_hints (which searches hints), though the description never explicitly names those siblings.

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?

There is no when-to-use guidance, no mention of calling affinity_list_sdk_documentation first to obtain a valid filename, and no exclusion relative to affinity_search_sdk_hints. An agent must infer the workflow entirely from sibling names.

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