Skip to main content
Glama

YESbusiness

Export a report file

export_report

Produces a downloadable FILE of a report and returns its link: the balance sheet, the income statement or the account statement as CSV, XLS (a real .xlsx workbook) or PDF, and the journal (every leg of every booking in the period, chronological) as PDF only. Use it when the user wants the report itself to download, print, send or open in a spreadsheet; for the figures, call the matching get_* tool instead. date_to is the balance sheet's report date and every other report's period end; date_from is required for the three period reports. The account statement takes the same scope / account inputs as get_account_statement. The result is {status, url, file_name}: give the user the url as a link to click. The link is signed and short-lived — hours, not days — so do not store or repeat it later; if it has expired, export again. status 'processing' means the statement was too large to build in one request: it is prepared in the background, the download link is e-mailed to the user and it also appears under their personal settings, My exports. Amounts in the file are in the company's home currency.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "report": "<report>",
      "format": "<format>",
      "date_to": "<date_to>",
      "company_id": "<company_id>"
    },
    "name": "export_report"
  }
}

Input Schema

NameRequiredDescriptionDefault
scopeNoaccount_statement only: 'single' for one account, 'range' for a band of account numbers, 'all' (default) for every account.
formatYesFile format. The journal is PDF only.
reportYesWhich report to export.
accountNoaccount_statement, scope 'single': the account's number.
date_toYesEnd of the period, YYYY-MM-DD, inclusive; for the balance sheet the report date (balances up to and including it).
date_fromNoStart of the period, YYYY-MM-DD, inclusive — required for every report except the balance sheet.
company_idYesThe company to work on — one of list_my_companies' company_id values.
compare_toNobalance_sheet: a second report date; income_statement: end of the compare period (with compare_from). YYYY-MM-DD.
to_accountNoaccount_statement, scope 'range': the last account number.
compare_fromNoincome_statement only: start of the compare period, YYYY-MM-DD; only with compare_to.
from_accountNoaccount_statement, scope 'range': the first account number.
show_all_accountsNobalance_sheet / income_statement: include accounts with no bookings.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.8/5.0
Behavior5/5

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

Beyond the annotations (readOnlyHint=false, idempotentHint=false, destructiveHint=false), the description discloses the real operational traits: the link is signed and short-lived (hours), must not be stored or repeated, and must be re-exported if expired. It also explains the asynchronous 'processing' path — background build, e-mail delivery, visibility under My exports — and that file amounts are in the company's home currency.

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?

A dense but well-ordered block: artifact and report/format matrix first, routing guidance second, parameter rules third, return value and lifecycle caveats last. Every sentence carries information; it is long only because the tool genuinely has many format- and report-specific rules, though the single unbroken paragraph is slightly harder to scan than a bulleted form.

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 12 parameters, conditional per-report requirements and no output schema, the description does the work the missing output schema would: it spells out the {status, url, file_name} result, what to do with the url, and what 'processing' means. Nothing an agent needs to call it correctly or interpret the response is missing.

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

Parameters4/5

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

Schema coverage is already 100%, so the baseline is 3; the description still adds meaning by explaining that date_to means report date for the balance sheet but period end elsewhere, and that date_from is mandatory for the three period reports. It also tells the agent the scope/account inputs behave identically to get_account_statement, which the schema alone does not convey.

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?

"Produces a downloadable FILE of a report and returns its link" names a concrete verb, resource and artifact, then enumerates exactly which reports exist (balance sheet, income statement, account statement, journal) and which formats each supports. It explicitly contrasts itself with the get_* siblings, so an agent can separate it from get_balance_sheet/get_journal without opening either schema.

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?

"Use it when the user wants the report itself to download, print, send or open in a spreadsheet; for the figures, call the matching get_* tool instead" gives an explicit when, an explicit when-not, and names the alternative class. The conditional rules (date_from required for the three period reports, journal PDF-only, account statement mirroring get_account_statement's inputs) further pin down valid usage.

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