Skip to main content
Glama

describe_applicability

Describes a data module's applicability vocabulary—ACT attributes, CCT conditions, PCT products, and applic statements—so you can choose product values to pass to read_data_module.

Instructions

Describe the applicability vocabulary of a data module so a product can be chosen: the ACT product attributes (ids, names, enumerations/patterns, which one identifies the product), the CCT condition types and conditions, the PCT products (ready-made product values), the applic statements in the data module (ids and display texts), and which attributes used by the statements have no value in the PCT. Nothing is evaluated here; pass the chosen values as "product" to read_data_module.

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.
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

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 burden and does well: it explicitly declares this is a non-evaluating read/preparation operation, which prevents an agent from expecting it to compute applicability. It stops short of disclosing return shape details (e.g., structure/size of the vocabulary) but the enumerated content list compensates substantially.

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?

Single dense sentence with the core purpose front-loaded, followed by the enumerated return contents and the downstream routing note. The enumeration is long but each item earns its place by describing returned vocabulary; no filler.

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?

No output schema exists, so the description must explain returns—and it does by listing the vocabulary categories returned. For a 4-param, zero-annotation tool this is nearly complete; only the mutual exclusivity/precedence of dmc vs xml vs path is left unaddressed.

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 coverage is 100%, so dmc, xml, path, and csdbDirs are already documented in the schema. The description adds no syntax or precedence guidance beyond the schema (e.g., which source wins when multiple are provided), so the baseline 3 applies.

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 ('Describe the applicability vocabulary of a data module') and then enumerates the concrete contents returned: ACT attributes, CCT condition types, PCT products, applic statements, and attributes lacking PCT values. This is clearly distinguishable from siblings like read_data_module, which evaluates rather than describes.

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?

Gives an explicit purpose ('so a product can be chosen'), states what it does not do ('Nothing is evaluated here'), and routes to the correct alternative ('pass the chosen values as "product" to read_data_module'). The condition that selects each tool is fully spelled out.

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