List Entity Templates

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

Without annotations, the description carries the burden of behavioral disclosure. It conveys a read-only listing action, but it does not mention the dry_run parameter or any side effects, return format, or access requirements. The verb 'list' gives a basic safety signal, but more context would be beneficial.

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, front-loaded sentence that succinctly states the action and resource. Every word is useful, and there is no redundancy or filler.

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 captures the core purpose, but it omits any explanation of the dry_run parameter and the return structure. Given no annotations and no output schema, the description should provide more information to make the tool fully self-contained. It is minimally adequate 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?

The schema defines a single boolean parameter, dry_run, with no description (0% schema coverage). The tool description does not explain this parameter at all, so an agent cannot determine the effect or valid values of dry_run. This is a significant gap that the description fails to compensate for.

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 tool lists all story/epic templates in the Shortcut workspace, using a specific verb and resource. It distinguishes itself from sibling tools like list_projects or list_epics, which focus on different resource types.

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 a user needs to retrieve all story/epic templates. Although no explicit alternatives or exclusions are mentioned, the tool's unique resource among siblings makes the appropriate context clear.

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