hedgedoc_create_note

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

With no annotations provided, the description carries the full burden. It discloses the JSON return shape, the consequence of omitting alias (random ID, cannot be updated), and the server requirement (CMD_ALLOW_FREEURL=true). This is rich behavioral context beyond a mere 'create' statement.

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?

Four sentences, front-loaded with purpose and return info, then essential caveats. No redundant statements; every sentence contributes critical usage or behavioral detail.

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 two-parameter create tool with no output schema or annotations, the description fully covers purpose, return format, parameter semantics, limitations, and prerequisites. It is complete and self-sufficient.

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%, providing baseline 3. The description adds meaning beyond the schema by explaining the strategic implications of the alias parameter (update capability) and the FreeURL dependency, while content is straightforward.

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 opens with 'Create a new note on the HedgeDoc instance,' a specific verb+resource. It elaborates with return fields and differentiates from hedgedoc_update_note by explaining that alias-based notes can be overwritten while alias-less notes cannot be updated over HTTP.

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?

Provides explicit guidance on when to use an alias ('if you intend to update this note later') and explicitly names the alternative tool (hedgedoc_update_note). It also discloses the server prerequisite (FreeURL mode), giving the agent clear criteria for effective use.

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