List Story Comments

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 states 'List' which implies a read operation, but it does not mention pagination, ordering, authentication, or any side effects. This is minimal behavioral context, similar to the 'update_drive' example.

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, concise sentence that front-loads the verb and resource. It contains no filler and is appropriately sized for a simple list operation.

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 simple list tool, the description gives the core functionality, but it lacks explanation of the dry_run parameter and provides no usage context. There is no output schema, and the description does not describe the return format, though 'comments' is implied. It is minimally viable but has clear gaps.

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%, and the description only clarifies that story_id refers to a Shortcut story. The dry_run parameter is completely unexplained. Since the schema provides no descriptions, the description should compensate but does not.

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 'List comments for a Shortcut story' clearly identifies the action (list), the resource (comments), and the scope (for a Shortcut story). This distinguishes it from sibling tools like list_epic_comments or list_story_tasks, making the purpose unambiguous.

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 implies when to use the tool (when you need comments for a story), but it provides no explicit guidance, exclusions, or alternatives. It does not mention when not to use it or how it differs from similar tools like list_epic_comments.

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