Skip to main content
Glama

Report DOCX Generate

report_docx_generate
Read-only

Return an inline DOCX artifact from supplied report_meta, tables, metrics, and summary content; this read-only renderer does not persist hosted files. Use this only when a structured report payload already exists; use report_pdf_generate for fixed-layout output or compliance_edd_report to build the memo first.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultNoOptional raw result payload attached for audit or downstream use.
tablesYesNamed tables rendered into the report artifact.
report_metaYes
export_artifactsNoOptional prior export metadata carried alongside the report payload.
headline_metricsNoOptional headline metrics rendered near the top of the report.
executive_summaryNoOptional executive summary bullets.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataNoPrimary structured result payload for the tool.
errorNoMachine-readable error code or message when the tool fails.
outputNoNested renderer output when a workflow bundles an artifact render.
reportNoReport-shaped payload when available; null for status-only retrieval responses.
sourceNoSource label, route, dataset, or execution metadata for the result.
messageNoHuman-readable error or status message.
successNoWhether the tool completed successfully.
artifactNoInline generated file artifact. The service does not persist a hosted download URL.
artifactsNoArtifact rendering hints keyed by format.
artifact_summaryNoDelivery and rendering metadata for an inline generated artifact.

TDQS

A4.4/5.0
Behavior4/5

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

The description adds behavioral context by stating 'this read-only renderer does not persist hosted files,' which complements the readOnlyHint=true annotation. It clarifies that the tool is safe and non-destructive without needing to infer from the annotation alone.

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 concise sentences with no unnecessary words. First sentence states core functionality, second provides usage context and alternatives. Every word earns its place.

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?

Given the complexity (6 params, nested objects, output schema exists), the description covers purpose, guidelines, and behavioral traits well. It mentions the output is an 'inline DOCX artifact' but does not detail the output structure; however, the output schema likely provides that, so it's acceptable. Minor missing detail on what 'inline' means specifically, but overall 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 description coverage is 83%, so the schema already documents most parameter details. The description enumerates the key content parameters (report_meta, tables, metrics, summary) which groups them meaningfully, but does not add significant new semantics beyond what's in the schema.

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?

The description clearly states the action ('Return an inline DOCX artifact') and the required inputs ('report_meta, tables, metrics, and summary content'). It also distinguishes from siblings by naming report_pdf_generate and compliance_edd_report, so the agent knows exactly when to use this tool.

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

Usage Guidelines5/5

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

The second sentence provides explicit usage guidance: 'Use this only when a structured report payload already exists' and directs to alternatives for different scenarios (report_pdf_generate for fixed-layout, compliance_edd_report to build memo first). This is clear and actionable.

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.

TDQS

A4.1/5.0
Disambiguation4/5

Tools are generally distinct, with clear differentiators like single vs batch vs report output. The queue_saved_list and report_saved_retrieve could be confused but descriptions clarify their separate domains.

Naming Consistency4/5

Prefixes like compliance_, wallet_ofac_, report_, queue_ provide consistency within subdomains, though verb order varies (e.g., report_docx_generate vs queue_saved_list).

Tool Count4/5

11 tools are appropriate for a compliance server covering screening, reporting, and optimization. Slightly on the higher side but each tool serves a unique purpose.

Completeness4/5

Covers core workflows: screening, batch, reporting, EDD memos, exposure forecasting, queue optimization, and status checks. Minor gaps like no wallet set management, but overall comprehensive.