toggle_comment

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

The description explains the toggling behavior and line vs. block comment based on the parameter. However, it does not disclose edge cases like empty selection, multi-line handling, or any side effects. With no annotations, more detail would improve 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 a single, front-loaded sentence with no unnecessary words. It efficiently conveys the tool's core function and key parameter behavior.

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 one boolean parameter and no output schema, the description covers the essential behavior. It could address edge cases like no selection, but overall is mostly complete.

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 description explicitly states that setting block=True switches to block comment, which adds meaning beyond the schema's type and default. Since there is only one parameter, this compensation is effective.

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 action: toggle line or block comment on the current selection. It uses a specific verb and resource, and distinguishes itself from sibling tools like insert_snippet or replace_selection.

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 usage when commenting/uncommenting lines or selections, but lacks explicit guidance on when not to use it (e.g., for inline comments) or mention of alternatives. No when/when-not or alternative tool references are provided.

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