Get document metadata by docCode: title, fileName, hasPassword, viewerStyle, timestamps. Public — no API key needed. Content is not included; use postmd_get_document_raw for the Markdown source.
| Name | Required | Description | Default |
|---|---|---|---|
| docCode | Yes | Document code, e.g. P-123-456-789. |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations provide readOnlyHint=true, and the description adds useful behavior beyond that: no API key required and a negative scope ('content is not included'). It does not cover pagination (not applicable for a single-doc lookup), so a 4 is fair.
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?
Three tight clauses: what it returns, auth posture, and the sibling escape hatch. Zero waste and the resource and key field are front-loaded.
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?
With no output schema, the description enumerates the returned fields (title, fileName, hasPassword, viewerStyle, timestamps), states the auth model, and points to the sibling for content — everything an agent needs to call it 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 coverage is 100% and docCode already has an example (P-123-456-789) in the schema. The description only restates that lookup is by docCode, adding no syntax or format detail beyond the schema, so the baseline 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') and enumerates the returned fields, so the agent knows exactly what it retrieves. It also explicitly distinguishes itself from the sibling postmd_get_document_raw.
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?
Explicitly says content is not included and names the alternative (postmd_get_document_raw) for Markdown source, giving the exact condition that routes to the sibling. Also clarifies it is a public endpoint requiring no API key.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.