EasyTopic: add comment

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

With no annotations, the description discloses the core behavior (adds a comment, notifies human). It does not address potential side effects or reversibility, but for a simple write tool this is reasonable. The description adds meaningful context beyond the bare schema.

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, well-structured sentence that immediately states the primary action, followed by essential context. No unnecessary words; every part adds value.

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 tool with two required parameters and no output schema, the description covers the action and its primary effect (notification) but omits parameter guidance and any constraints. It is minimally viable but incomplete for an agent to use correctly without additional inference.

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 does not explicitly explain the two parameters ('topicId' and 'body'). While the purpose sentence implies their roles ('posts a comment on a Topic'), it lacks explicit details like format, length constraints, or examples. The description should compensate more given no schema descriptions.

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?

Clearly states the action ('posts a comment'), the resource ('Topic'), and explicitly frames it as the exclusive communication channel with the human, differentiating it from sibling tools like 'easytopic_transition_status' or 'easytopic_write_plan'.

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?

Describes the tool as 'the only channel to communicate with the human' and lists specific use cases (questions, progress notes, completion summaries), providing strong context for when to use it. The automatic notification detail reinforces its role. No explicit exclusions are needed given its exclusive framing.

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