Skip to main content
Glama

read_data_module

Read one S1000D data module as structured information instead of raw XML, including body blocks, references, verification status, and product applicability.

Instructions

Read one data module as structure, not XML: identification and status (DMC, issue, language, title, BREX ref, QA, DM-level applicability), the body as a tree of blocks (sections, paragraphs, lists, tables, figures with ICN, warnings/cautions/notes, numbered steps, requirements; processes and fault isolation too), the references it makes, and ALWAYS a "verification" status (XSD by default). Applicability of each block is evaluated for the given product (applicable / notApplicable / undetermined); without a product, only display texts are returned — assert expressions are never returned.

Input Schema

NameRequiredDescriptionDefault
dmcNoDMC of the data module to read from the CSDB (e.g. "S1000DBIKE-AAA-D00-00-00-00AA-041A-A"; "DMC-" prefix optional). Alternative to path/xml.
xmlNoThe document as an XML string (alternative to path; max 5 MB).
pathNoFile path of the document.
verifyNoHow much to verify before reading: "schema" (default) runs XSD validation only; "full" also checks BREX along the brexDmRef chain and resolves references; "none" skips verification (reported as not-run).schema
productNoThe product to evaluate applicability for. attributes: ACT productAttribute id → value (e.g. {"model": "Brook trekker", "version": "Mk9"}); conditions: CCT cond id → value. Omit to get "undetermined" with display texts only. Use describe_applicability to learn the available ids and values.
sectionNoWhich part to return (default all).all
csdbDirsNoExtra CSDB folders to search (in addition to S1000D_CSDB_DIR) for data modules by DMC, referenced objects, ACT/CCT/PCT and BREX.
maxNodesNoCap on body nodes returned (default 5000).
omitNotApplicableNoDrop blocks that are notApplicable for the given product (default false: keep them, marked). The number dropped is reported.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.7.0

TDQS

A4.3/5.0
Behavior4/5

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

With no annotations the description carries the full burden and does well: it discloses that verification always runs (XSD by default), that applicability is evaluated per block as applicable/notApplicable/undetermined, that without a product only display texts come back, and that assert expressions are never returned. It omits failure modes for a missing DMC and any size/truncation behavior beyond the schema's 5 MB note.

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 purpose and the "not XML" contrast are front-loaded, and the dense enumeration of return contents is grouped logically. The long parenthetical content list is heavy but every clause carries information an agent needs to anticipate the output shape.

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?

For a 9-parameter, nested-object tool with no output schema, the description does the work of describing the return shape (status block, block tree, references, verification) and the applicability model. What it lacks is error/edge-case behavior (unknown DMC, unresolvable BREX) and any note on node capping interacting with the tree.

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; the description adds real meaning beyond it by explaining the consequence of omitting `product` (undetermined, display texts only) and the semantics of the applicability evaluation that `omitNotApplicable` and `product` control. The verify and section parameters are left entirely to 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?

States a specific verb and resource (read one data module) plus a differentiating scope ("as structure, not XML") and enumerates exactly what is returned: identification/status, body tree, references, and a verification status. An agent can distinguish it from list_data_modules and read_publication_module without opening any schema.

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?

Implies it is the structured-read counterpart to raw XML reading and points to describe_applicability for discovering product attribute/condition ids. It never explicitly names an alternative or a when-not-to-use condition, so routing is clear but not fully spelled out.

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