hedgedoc_create_with_alias

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

With no annotations, the description carries the full burden of behavior disclosure. It discloses the requirement for FreeURL mode, explains that the title will be 'added as level-1 heading', and states that the tool 'Returns the note ID and URL'. It does not cover conflict behavior or other edge cases, but the key side effects and return values are well documented.

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 concise and well-structured. It opens with the one-sentence purpose, follows with the prerequisite, then lists parameters in a bulleted format, and closes with the return value. Every sentence adds value with no redundancy.

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 tool with 3 required scalar parameters, the description fully covers the purpose, prerequisite, parameter meanings, and return values. Output schema is present but the description still mentions what is returned (ID and URL). It is complete enough for an agent to select and invoke the tool 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 description coverage is 0%, so the description fully compensates by providing explicit semantics for each parameter: alias is a 'custom URL slug', title will be 'added as level-1 heading', and content is 'markdown body content'. This adds meaning beyond the bare schema types and titles.

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 specific action: 'Create a new HedgeDoc note with a custom URL alias.' It uses a specific verb and resource, and the emphasis on 'custom URL alias' differentiates it from sibling tools like hedgedoc_create and hedgedoc_create_blank.

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 provides clear context by specifying the prerequisite that 'HedgeDoc's FreeURL mode' must be enabled, along with the exact environment variable. It implies the use case (custom alias creation) but does not explicitly state when to choose this tool over alternatives. This aligns with 'clear context, no exclusions'.

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