topic.read

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

As a read operation, the core behavior is safe and non-destructive, which is implied by the verb. However, with no annotations, the description carries the full burden and does not disclose potential error conditions, whether it returns raw file content, or any special handling of the TOPIC.md file. It is adequate but lacks depth.

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 sentence, six words, with no filler or redundancy. It is front-loaded and appropriately sized for the simple operation it describes.

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 has one parameter with zero semantic explanation, and the description does not provide context about what constitutes a 'topic' or how 'dir' is interpreted. While an output schema exists (covering return values), the missing parameter semantics and lack of usage context leave the tool incomplete for an agent to invoke reliably.

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 only parameter, 'dir', is completely undocumented in both the schema (0% coverage) and the description. The description does not hint at what 'dir' represents (e.g., a filesystem path, a topic identifier, or a workspace). This is a critical gap for correct usage.

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 clearly states the verb 'Read' and the resource 'a topic's TOPIC.md description', providing a specific and unambiguous purpose. It distinguishes from sibling tools like topic.write and postit.read by naming the exact file and operation.

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 description gives no indication of when to use this tool versus alternatives such as topic.create or postit.read. There is no mention of context, prerequisites, or exclusions, leaving the agent without strategic guidance.

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