Generate a watermarked preview PDF (no credits consumed). The preview PDF is available for one-time download via the returned URL, then deleted from storage.
| Name | Required | Description | Default |
|---|---|---|---|
| data | No | JSON string of template variable data (e.g. report info, holdings, allocation, performance arrays). Pass an empty object {} if omitted. | |
| templateId | Yes | The UUID of the template to use for generating the preview |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided, so description fully bears transparency burden. Discloses watermarking, zero credit cost, one-time download, and deletion after retrieval.
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 sentences cover purpose, behavior, and constraint (no credits). No wasted words, 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?
No output schema, but description explains the returned URL's behavior. Could mention size limits or format, but overall adequate for a preview 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 already covers both parameters with descriptions. The description adds minimal extra context (data as JSON template variables). Baseline 3 is appropriate.
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?
Clearly states the action (Generate), resource (preview PDF), and key differentiators: watermarked, no credits consumed. Distinguishes from sibling submit_job which likely consumes credits.
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?
Implicitly defines when to use (preview vs. actual job via no-credits hint). Lacks explicit when-not or alternatives, but context is clear enough.
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.