Skip to main content
Glama
ohneben

Buchhaltungsbutler MCP

Reports: get bwa report

reports_get_bwa
Read-onlyIdempotent

Fetch a completed BWA report that was generated previously. Returns the report data, with optional files when requested.

Instructions

🟢 READ-ONLY: Fetches data. Makes no changes to the accounting records.

get bwa report

Returns a previously created BWA report ("Betriebswirtschaftliche Auswertung").

Reports are generated asynchronously, so a report is only available once its generation has been finished. Note that creating a new report of the same type replaces the previously created one.

Use to read a BWA that reports_create_bwa has finished generating. Step two of two.

Returns nothing useful until generation has finished. If the report is not ready, wait and retry rather than requesting a new one, since a new request replaces the pending one.

Endpoint: POST /reports/get/bwa

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
get_filesNoIf true, the report's files will be included as base64 encoded strings. If specified, the field will be validated.
report_id_by_customerYesThe id_by_customer of the report, as returned when the report was created

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
filesNoOnly contained if get_files has been specified. Provides the keys 'csv' and 'pdf', each holding the base64 encoded content of the report's file, or null if the file is not available – because it has not been requested when the report was created, because it is still being created or because it is not available anymore.
reportNoThe report's data, containing the keys 'integrityError', 'standardChart', 'usedCostLocations', 'usedPostingaccountsNumbers', 'postingsRecordsCount', 'uncompletedPostingsCount', 'groups' and 'totals'. The groups hold their classes, which in turn hold their postingaccounts. Every group, class, postingaccount and total provides its amount as the unformatted value 'amountsSum'.
messageNoblank
successYesSuccess boolean

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.1.2
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "properties": {
      +    "files": {
      +      "description": "Only contained if get_files has been specified. Provides the keys 'csv' and 'pdf', each holding the base64 encoded content of the report's file, or null if the file is not available – because it has not been requested when the report was created, because it is still being created or because it is not available anymore.",
      +      "type": "object"
      +    },
      +    "message": {
      +      "description": "blank",
      +      "type": "string"
      +    },
      +    "report": {
      +      "description": "The report's data, containing the keys 'integrityError', 'standardChart', 'usedCostLocations', 'usedPostingaccountsNumbers', 'postingsRecordsCount', 'uncompletedPostingsCount', 'groups' and 'totals'.\n\nThe groups hold their classes, which in turn hold their postingaccounts. Every group, class, postingaccount and total provides its amount as the unformatted value 'amountsSum'.",
      +      "type": "object"
      +    },
      +    "success": {
      +      "description": "Success boolean",
      +      "type": "boolean"
      +    }
      +  },
      +  "required": [
      +    "success"
      +  ],
      +  "type": "object"
      +}
  2. Changed1 schema field changedv1.1.0
    • removedInput schema / properties / api_key
      Removed value: -{
      -  "description": "Optional. The BB customer api_key to act on. Defaults to the BB_API_KEY configured on the server — only set this to target a different customer.",
      -  "type": "string"
      -}
  3. Addedv1.0.2

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so the safety profile is covered. The description adds valuable behavioral context beyond annotations: reports are generated asynchronously, the report is only available after generation finishes, and a new creation request replaces the previous report. It also notes that the endpoint returns nothing useful until generation has finished. This is strong added context, though it doesn't detail the exact response structure or error behavior.

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?

The description is well-structured with a clear READ-ONLY banner, a bolded title, and short paragraphs. It front-loads the most important behavioral facts (read-only, async generation, replacement behavior) and includes the endpoint. It is slightly repetitive in places (e.g., 'Returns nothing useful until generation has finished' restates the async point), but overall every sentence 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 tool's complexity (async generation, replacement semantics, two-step workflow), the description covers the essential context: when the report is available, what to do if it isn't ready, and the relationship to reports_create_bwa. The output schema exists, so return values don't need explanation. Minor gap: it doesn't explicitly state what happens if the report_id_by_customer is invalid or not found, but this is not critical for correct invocation.

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%, so the schema already documents both parameters (report_id_by_customer and get_files). The description adds a small amount of context by explaining that report_id_by_customer is the id returned at creation time, but it doesn't add significant meaning beyond the schema. Baseline 3 is appropriate.

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 tool fetches a previously created BWA report, names the specific resource (BWA report), and explicitly distinguishes it from the creation step by calling it 'step two of two'. It also names the sibling tool reports_create_bwa, making the purpose unambiguous.

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 description explicitly says to use this tool to read a BWA that reports_create_bwa has finished generating, and provides clear guidance on when to wait and retry rather than requesting a new report. It also warns that creating a new report replaces the pending one, which is critical usage context.

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