hedgedoc_info

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

With no annotations provided, the description carries the full burden, but it does not disclose whether the operation is read-only, side effects, error conditions, or any other behavioral context. It only says 'Get metadata' without stating that no modifications occur.

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 exceptionally concise, with a single sentence and a bullet point. Every piece of content is relevant and front-loaded, with no filler or 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?

The tool is simple and has an output schema, so return values are covered. However, the description lacks usage guidance and behavioral transparency, leaving some context gaps despite the low complexity.

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?

The schema only lists note_id as a string with no description. The tool description compensates by explaining that note_id is 'the note ID or alias (the slug from the URL)', adding crucial semantic meaning beyond the schema.

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 states 'Get metadata of a HedgeDoc note' and enumerates specific fields (title, description, timestamps, viewcount), making the tool's purpose distinct from sibling tools like hedgedoc_read or hedgedoc_create.

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?

Usage context is only implied by the tool name and the phrase 'Get metadata'. No explicit guidance on when to use this tool versus alternatives, nor any exclusions, is provided.

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