addLinearComment

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

Annotations already declare readOnlyHint=false, indicating write operation. Description adds no further behavioral traits (e.g., whether comment is appended or replaces, required permissions). Annotations carry the burden; description is adequate but adds no extra context.

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?

Two sentences, no wasted words. Essential information only. Perfectly concise for this simple tool.

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 tool simplicity, schema coverage, and annotations, description is nearly complete. Could optionally mention return value, but not required. Adequate for an agent to select and invoke correctly.

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 coverage is 100% with descriptions for both params (id, body). Baseline is 3. Description adds no additional meaning beyond what schema provides (e.g., no format hints beyond what's in schema).

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?

Description clearly states the verb 'Add a comment' to a specific resource 'Linear issue'. It distinguishes from sibling tools like createLinearIssue (create issue) and fetchLinearIssue (fetch issue) by focusing on adding a comment to an existing issue.

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?

States prerequisite 'Requires Linear connector connected.' Implies when to use: when you want to add a comment to an existing Linear issue. Does not explicitly mention when not to use or alternatives, but sibling names provide differentiation.

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