create_note

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

The description explains the creation behavior and parameters but lacks details on side effects (e.g., notifications), reversibility, or output. With no annotations, the description carries full burden but is not fully transparent.

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 concise sentences: first for purpose, second for optional parameters. No fluff, front-loaded, easy to parse.

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?

Covers all parameters with use context but misses explaining the output (an output schema exists but not described) and the need for a set active project. Adequate for a creation 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 0%, but the description adds clear meaning for each parameter: private, severity, page_url, assigned_to (as @mention by user ID). This compensates for missing 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?

The description clearly states the tool's function: creating a note on the current project, listing note types (observation, action item, issue), and optional fields. It distinguishes from sibling tools like list_notes and resolve_note.

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 for adding notes but does not explicitly state when to use this tool over alternatives like list_notes or resolve_note, nor does it mention prerequisites like setting the active project.

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