Skip to main content
Glama

Check configuration

csv2zugferd_config_get
Read-onlyIdempotent

Loads a YAML config from a path or text and reports effective settings, field mappings, typos, invalid values with CLI fallbacks, missing sections, and optional CSV header checks.

Instructions

Loads a YAML configuration from configPath or configYaml and reports its structure: effective settings and modes, every mapped field with its sources, unknown keys (typos), values outside the allowed sets with the fallback the CLI would apply, and ignored or missing sections. With csvPath the referenced columns are compared with the CSV header (missing and unused columns). Does not read cell values and does not calculate totals; use csv2zugferd_invoice_get for a trial run. Read-only, writes no files.

Input Schema

NameRequiredDescriptionDefault
csvPathNoOptional CSV file whose header is compared with the referenced columns (structural check, no cell values are read).
configPathNoPath to an existing YAML configuration file. Use either configPath or configYaml, not both.
configYamlNoYAML configuration as text (the content of config.yml). Use either configPath or configYaml, not both.

Output Schema

NameRequiredDescriptionDefault
csvYesEffective CSV settings.
sourceYesWhere the configuration came from.
zugferdYesEffective output settings after fallbacks (canonical spelling).
warningsYesStructural findings: ignored or missing sections for the chosen modes, fallbacks of version, profile and format.
totalsModeYesEffective totals mode after fallback.
unknownKeysYesKeys in the YAML that no configuration key matches (typos); they are silently ignored by the CLI.
mappedFieldsYesEvery configured field mapping with its configured sources in resolution order.
columnsUnusedNoOnly with csvPath: header columns no mapping refers to.
invalidValuesYesConfigured values outside their value set (version, profile, format, modes, currency, country, unit code, tax codes, type codes, schemes).
lineItemsModeYesEffective line item mode after fallback.
columnsMissingNoOnly with csvPath: referenced columns without any match in the header (case-insensitive), neither direct nor indexed.
columnsReferencedYesCSV column names the configuration can read in the effective mode (direct names; in columns mode also the indexed names built from columnPattern).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint and destructiveHint=false, so 'Read-only, writes no files' adds little. The description does go beyond them with substantive behavior: structural-only checking (no cell values read), no totals computed, and reporting of typos/fallbacks rather than failing, which tells the agent to expect a diagnostic report rather than an error.

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?

Front-loaded with the action and the report contents, then exclusions, then the alternative and side effects — a sensible order. It is dense and the long enumerations make it slightly heavy, but no sentence is redundant except the mild overlap with the readOnly annotation.

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?

For a 3-parameter read tool with an output schema, the definition covers inputs, the shape of what is reported, the structural-only limitation, the sibling alternative, and side effects. An agent has everything needed to choose and invoke it correctly.

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 100%, so the baseline is 3, but the description adds real meaning about what each input yields: configPath/configYaml produce an effective-settings and field-mapping report, while csvPath triggers a header-vs-referenced-columns comparison listing missing and unused columns. That is more than the schema's generic 'structural check' note.

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 and resource ('Loads a YAML configuration ... and reports its structure') and enumerates exactly what the report contains (effective settings, mapped fields with sources, unknown keys, out-of-set values with CLI fallback, ignored/missing sections). It is clearly distinguishable from siblings such as config_schema_get and config_file_create, and even names the alternative invoice_get.

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

Usage Guidelines4/5

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

Gives explicit exclusions ('does not read cell values', 'does not calculate totals') and routes to csv2zugferd_invoice_get for a trial run. It does not, however, contrast with the closest sibling csv2zugferd_config_schema_get, so an agent must infer that boundary itself.

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