alterios_add_comment

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

No annotations exist, so description must carry burden. It mentions 'returns readback' and 'requires explicit write gates' but does not disclose side effects, idempotency, or implications of 'plan' vs 'create'. Ambiguity reduces transparency.

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 short but poorly structured: 'Plan or create' is an awkward phrase and the sentence order doesn't prioritize key info. Could be more precise and front-loaded.

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 7 parameters and an output schema, the description fails to provide enough context. It doesn't explain the return value, parameter roles, or how 'plan' and 'create' differ. Incomplete for an 8-sibling tool set.

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 adds no parameter documentation. With 7 parameters and no explanations, the agent has no guidance on what each parameter means.

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 states 'Plan or create an Alterios comment' which gives a general action but is ambiguous about whether it plans or creates. It distinguishes from siblings like alterios_write_journal but lacks specificity about the comment's context.

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?

No guidance on when to use this tool vs alternatives. The mention of 'explicit write gates' is a prerequisite, not usage context. No when-not or sibling differentiation provided.

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