Skip to main content
Glama

Generate workspace report

generate_report
Read-onlyIdempotent

Generates one complete, unfiltered machine view of the workspace — the audit tier, as JSON, so the full evidence chain behind the books can be extracted and inspected. report_type is the closed six: transaction_space, event_crosswalk, chart_requests, chart_accounts, chart_journal_entries, chart_journal_entry_lines.

For human-shaped questions use the dedicated tools instead: list_workspace_accounts and list_workspace_account_activity for workspace accounts, list_chart_accounts for a chart's tree, and generate_trial_balance, generate_balance_sheet, and generate_profit_and_loss for financial statements. Read-only and not metered.

Input Schema

NameRequiredDescriptionDefault
report_typeYesWhich audit view to generate.
workspace_tagYesActive workspace id (the workspace_tag create_workspace and list_workspaces return).

Output Schema

NameRequiredDescriptionDefault
rowsNoReport rows when tabular.
engineYesStamped engine build/version identity for the tool result.
statusYesreport_generated or report-specific status.
resourcesNoWorkspace resource links.
row_countNoReport row count when tabular.
report_typeNoGenerated report type.
workspace_tagYesWorkspace scoped by the tool call.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.4/5.0
Behavior4/5

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

Adds 'not metered' and 'unfiltered/complete' beyond the readOnlyHint/idempotentHint annotations, telling the agent the payload is full-fidelity and safe to call repeatedly at no cost. It does not warn about payload size or latency for what is clearly a bulk dump, which is the only meaningful gap given annotations already carry the safety profile.

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

Conciseness4/5

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

Purpose is front-loaded in the first clause and the alternative-tool routing follows immediately. The enumerated list of six report_type values duplicates the schema enum and is the one clearly redundant sentence.

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

Completeness5/5

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

With an output schema present, the description needn't detail return values, and it supplies what the structured fields cannot: the audit-tier framing, the unfiltered scope, and the routing to human-facing alternatives. Nothing needed to select or invoke it correctly is missing.

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 100% and each of the six constants already has a detailed description, so the schema does the heavy lifting. The description's 'closed six' enumeration largely restates the oneOf and adds only the framing that these are audit-tier views rather than user reports.

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?

Opens with a specific verb and artifact: 'Generates one complete, unfiltered machine view of the workspace — the audit tier, as JSON.' It also states what the output enables (extracting the evidence chain behind the books), which separates it from every reporting sibling in the list.

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?

Explicitly routes the agent away for human-shaped questions and names the exact alternatives by task: list_workspace_accounts/list_workspace_account_activity for accounts, list_chart_accounts for chart trees, and the three generate_* statements for financials. This is a clear when-to-use/when-not-to-use with named siblings.

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.

Resources