Get Comment

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the agent knows it's safe. The description adds value by detailing the returned data (author, timestamp, moderation flags) and noting platform-specific differences in flags (can_hide/can_remove vs. hidden). No contradictions.

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?

Two sentences, each earning its place: first states the core action and returned data, second provides critical usage guidance. No filler or redundancy.

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?

No output schema exists, but the description compensates by naming specific return fields (author, timestamp, moderation flags). However, it omits any mention of error states (e.g., comment not found) or whether additional fields are returned. Still adequate for a simple read tool.

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 100%, so each parameter is already documented in the schema. The tool description does not add further meaning beyond the schema; it merely references the auto-detection behavior already described in the platform parameter's schema description. Thus baseline score of 3.

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?

Explicitly states it reads a single comment by ID and returns author, timestamp, and moderation flags. Clearly distinguishes from sibling tools like list_comments, hide_comment, and delete_comment by specifying it's the read-before-modification step.

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?

Provides explicit guidance: 'Call this before hiding or deleting so the decision is made on the real text.' Also explains platform auto-detection behavior, giving clear context on when to use and what not to skip.

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