Update Story Comment

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It only states that the tool updates text; it does not disclose side effects, permission requirements, overwrite semantics, or the role of confirm and dry_run parameters. This is a mutation tool with no safety signals.

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 with no filler or redundancy. It is front-loaded with the action and object, making it very concise and readable.

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 no output schema, no annotations, and a schema with required confirm/dry_run semantics, the description is severely incomplete. It fails to mention that confirm must be CONFIRM_WRITE, what dry_run does, or what happens on execution, making safe invocation impossible without external knowledge.

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 only 20% (only 'confirm' has a description). The tool description adds no parameter context beyond the word 'text,' leaving story_id, comment_id, dry_run, and confirm semantics mostly unexplained beyond their names.

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 the specific verb 'Update' and identifies the exact resource ('the text of a comment on a Shortcut story'). This clearly distinguishes it from sibling tools like create_story_comment, delete_story_comment, and list_story_comments.

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 provides no guidance on when to use this tool versus alternatives such as create_story_comment or delete_story_comment. There is no mention of prerequisites, how to obtain comment_id, or scenarios where updating is appropriate.

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