Skip to main content
Glama

read_icn_metadata

Reads ICN metadata from the S1000D CSDB, returning identifiers, status, security, and source/originator details with related ICN files.

Instructions

Read an ICN metadata file (IMF, icnmetadata.xsd): ICN, issue, title, keywords, security, source/originator and other status items as a flat list, plus the related ICN files found in the CSDB.

Input Schema

NameRequiredDescriptionDefault
icnNoICN whose IMF to read from the CSDB (e.g. "C0419-S1000D0360-001-01" or "ICN-C0419-…").
xmlNoThe document as an XML string (alternative to path; max 5 MB).
pathNoFile path of the document.
csdbDirsNoExtra CSDB folders to search (in addition to S1000D_CSDB_DIR) for data modules by DMC, referenced objects, ACT/CCT/PCT and BREX.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.7.0

TDQS

B3.1/5.0
Behavior2/5

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

No annotations are provided, so the description carries the behavioral-disclosure burden. "Read" implies a non-mutating operation, and the return contents are briefly described, but there is no information about permissions, error behavior, missing files, or how the alternative input parameters interact.

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

Conciseness5/5

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

The definition is a single front-loaded sentence with no wasted text. The main action and return description come first, followed by supporting details about related ICN files.

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

Completeness3/5

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

For a read-only tool with no output schema and no annotations, the description provides an adequate sketch of returned metadata and related files. However, it does not cover usage selection among the optional input modes or behavioral edge cases, leaving meaningful gaps.

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 the parameters already include useful examples and constraints such as the 5 MB XML limit. The description adds no additional parameter semantics, so this sits at the baseline for fully documented schemas.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description gives a specific verb and resource: "Read an ICN metadata file," and enumerates the metadata fields returned. It is clearly distinguishable from generic data-module tools, though it does not explicitly contrast itself with sibling tools such as read_data_module or read_publication_module.

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

Usage Guidelines2/5

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

The description states what the tool reads but gives no guidance on when to use it instead of sibling tools, nor when to choose the icn, path, or xml input modes. No prerequisites or exclusions are mentioned.

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