List Epic Comments

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

No annotations are provided, so the description must carry the full burden. It only says 'List comments' without disclosing whether the operation is read-only, paginated, or requires specific permissions. The presence of a 'dry_run' parameter in the schema is not mentioned, introducing ambiguity about the tool's actual behavior.

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, clear sentence that conveys the core purpose without fluff. It is appropriately sized for a simple list operation, though it could include more detail without being verbose.

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?

Given the tool has two parameters (one required) and no output schema, the description fails to explain return values, pagination, or the meaning of 'dry_run'. It is too minimal to fully inform an agent about the tool's behavior and edge cases.

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 must explain parameters. It does not mention 'epic_id' or 'dry_run'. The parameter names are somewhat self-explanatory (epic_id is likely the epic's ID), but 'dry_run' is unclear for a listing operation and the description provides no guidance.

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 'List' and a clear resource 'comments on a Shortcut epic', which precisely identifies the tool's function and distinguishes it from siblings like list_story_comments (comments on stories) and list_epic_stories (stories in an epic).

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 is concise but clearly states the context: listing comments on an epic. This implicitly tells the agent when to use it versus related tools, though it does not explicitly name alternatives or exclusions. The resource (epic) is clear enough for correct selection.

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