postmd_get_document

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

Annotations already declare readOnlyHint=true, so the description is not solely responsible for safety disclosure. It adds meaningful behavioral context: the tool returns only metadata, omits content, and requires no authentication. No contradiction with annotations.

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 compact sentences deliver the key facts first: what is returned, what is excluded, and which sibling to use instead. Every sentence earns its place with no filler or repetition.

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 one-parameter metadata fetch with no output schema, the description sufficiently explains the return scope, lists the returned fields, and routes to the raw-content counterpart. Nothing essential for correct invocation is missing.

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% and docCode already has a clear description with an example. The description only repeats that lookup is by docCode without adding new meaning, so the baseline of 3 applies.

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?

States a specific verb and resource: 'Get document metadata by docCode', then enumerates the exact fields returned. Explicitly distinguishes itself from postmd_get_document_raw by noting content is excluded, so an agent can immediately tell the two tools apart.

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?

Directs the agent to postmd_get_document_raw when Markdown source is needed, which is a clear alternative and selection condition. Also discloses that no API key is needed, giving concrete usage context without requiring the agent to infer prerequisites.

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