Export Sop Pdf
export_sop_pdfGenerate an SOP PDF.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sopId | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |
export_sop_pdfGenerate an SOP PDF.
| Name | Required | Description | Default |
|---|---|---|---|
| sopId | Yes |
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint, idempotentHint, non-destructive, and closed-world, so the safety profile is covered. The description adds nothing behavioral beyond that: it doesn't say whether the call returns a URL, bytes, or an async job, nor whether the export is synchronous. The readOnly annotation is not contradicted, so this is a thin description rather than a contradiction.
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?
A single four-word sentence with zero waste and the resource front-loaded. But the brevity stems from shortchanging important content, not from disciplined editing.
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?
An output schema exists, so return values needn't be explained. But with a mutation-adjacent export of one undocumented identifier, a thin annotation set, and 0% parameter coverage, the agent still lacks the details needed to invoke this confidently or distinguish it from the Word and policy export siblings.
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?
There is one parameter, sopId, with 0% schema description coverage — only a regex pattern and a length bound are documented. The description says nothing about what sopId refers to, whether it is the SOP's numeric id or a slug, or what happens if it's invalid, so it fails to compensate for the coverage gap.
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 reads 'Generate an SOP PDF', which is essentially the tool name 'export_sop_pdf' restated in sentence form. It does name a verb and a resource, but adds no scope, no sibling differentiation, and nothing an agent couldn't infer from the name alone.
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?
No when-to-use guidance at all. Siblings such as export_sop_word, export_policy_pdf, and export_policy_word exist, yet the description never indicates when a PDF is preferred over Word, or when one should use get_sop instead of exporting.
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.