create_comment

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

No annotations provided. Description discloses automatic author assignment, server-side user_id injection, and return value. Missing permission requirements but sufficient for a create tool.

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?

Three sentences, each with a clear purpose: what it does, behavioral constraint, return value. No wasted words.

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 4 parameters with full schema coverage and no output schema, description covers creation action, automatic author, return format. Lacks error handling details but adequate for a create tool.

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%. Description adds meaning by warning against passing user_id (not in schema) and emphasizing content is non-empty required. Also states return format.

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 explicitly states 'Create a comment on a Kanboard task' with a clear verb and resource. It differentiates from siblings like delete_comment or update_comment.

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?

Includes critical guidance: author is automatically set to authenticated user, do not pass user_id (injected server-side), and return format { comment_id }. Does not explicitly contrast with update_comment but the purpose is distinct.

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