hedgedoc_publish_url

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

With no annotations provided, the description carries the burden of behavioral disclosure. It explains that publish mode renders without the editor UI and is read-only, but does not mention side effects, error conditions, permissions, or whether this is a pure retrieval operation. This is adequate but not rich.

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 compact and front-loaded with the core purpose. Each sentence earns its place: the what, the why, the parameter detail, and the return value. No redundancy or fluff.

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 simple single-parameter URL-getter, the description covers the main purpose, the use case, the parameter meaning, and the return value. The presence of an output schema means return details are handled elsewhere. Missing edge cases like nonexistent note IDs are not covered, but this is acceptable for a low-complexity 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 description coverage is 0%, and the schema only provides the parameter name and type. The description compensates by explaining that note_id is 'The note ID or alias (the slug from the URL),' adding meaningful context beyond the structured field.

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 a specific verb and resource: 'Get the published (read-only) URL of a HedgeDoc note.' It clearly distinguishes from siblings like hedgedoc_slide_url and hedgedoc_read by focusing on the publish/read-only URL concept.

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 states the intended use case: 'ideal for sharing with viewers who should not edit the content.' This gives clear context but does not explicitly name alternative tools or exclusions, so it stops short of full when-to-use/not-use guidance.

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