Skip to main content
Glama

generate_document

Fill one of the workspace's document templates (by name or id) for a record, e.g. {job_id: 42}, and get a PDF link. The link is public — anyone with it can open the file — so share it only where the user intends.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
filenameNo
templateYes
argumentsNoThe template's arguments, e.g. {job_id: 42}

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4/5.0
Behavior4/5

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

Beyond the annotations (readOnlyHint=false, destructiveHint=false, openWorldHint=true), the description discloses a genuinely important behavioral trait: the generated link is public and anyone with it can open the file, so sharing must be deliberate. That is real value added that structured fields do not capture, though it says nothing about persistence or idempotency.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two tight sentences, verb and resource front-loaded, with the sharing caveat placed at the end where it belongs as a warning. Nothing is redundant.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With no output schema, the description usefully discloses the return value (a PDF link) and the key safety nuance. Gaps remain around the undocumented filename parameter and any need to enumerate templates first, but for a 3-param tool this is close to complete.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is only 33%, so the description must compensate; it clarifies the two most important parameters (template by name or id, and the arguments object via the {job_id: 42} example). The filename parameter is left undocumented in both schema and description, so compensation is incomplete.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb (fill) and resource (workspace document template) plus the output (PDF link), with a concrete example argument. An agent can distinguish this from siblings like list_document_templates, preview_proposal, or generate_estimate without opening any schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Implies usage by explaining that the template can be passed by name or id and that a record is supplied via arguments, which hints at the list_document_templates -> generate flow. However, it never explicitly says when to use this tool versus alternatives such as preview_proposal, nor states any prerequisites.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.