Skip to main content
Glama
shuji-bonji

s1000d-brex-mcp

by shuji-bonji
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

explain_brex

Lists BREX rules and header details with targets, allowed values, severity, and schema context, so you can inspect S1000D constraints and filter by rule kind or context.

Instructions

List the rules of a BREX data module in readable form: for each rule, the target (XPath), whether it is forbidden / required / optional, the allowed values with their meanings, severity, and the schema context it applies to. Also returns the BREX header (DMC, parent BREX, counts). Use "kind" and "context" to narrow, "offset"/"limit" to page.

Input Schema

NameRequiredDescriptionDefault
brexNoWhich BREX to use: a file path to a BREX data module (.xml), or a DMC (e.g. "KENBAIKI-A-00-00-00-00A-022A-D", "DMC-" prefix optional) searched in csdbDirs / S1000D_CSDB_DIR / S1000D_SPEC_DIR. Omit to use the S1000D default BREX found under S1000D_SPEC_DIR.
kindNoRule kind to list (default: all).all
limitNoMaximum rules to return (default 50, max 500).
offsetNoIndex of the first rule to return (default 0).
searchNoCase-insensitive text to find in objectPath, objectUse, rule id or value meanings.
contextNoOnly rules that apply to this schema (file name such as "descript", "proced", "pm") plus the common rules. Omit for all contexts.
csdbDirsNoExtra folders to search for data modules and BREX by DMC (in addition to S1000D_CSDB_DIR and S1000D_SPEC_DIR).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.4.0

TDQS

A3.6/5.0
Behavior3/5

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

With no annotations, the description carries the full burden, and it does disclose the return payload in useful detail (per-rule fields plus the BREX header with DMC, parent BREX and counts) and the pagination model. It never states that the operation is read-only, nor what happens when the DMC lookup fails or the default BREX under S1000D_SPEC_DIR is missing, which matters for a 7-parameter tool with a filesystem search path.

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?

Two sentences, front-loaded with the purpose, no filler. The long enumeration of per-rule fields is dense but each item is meaningful content, so it earns its space.

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?

There is no output schema, and the description compensates by describing the returned rule structure and header, so an agent knows what it will get back. Combined with 100% schema coverage on all 7 optional parameters, nothing essential for calling it correctly is missing.

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 the baseline is 3. The description adds only the narrowing/paging roles for kind, context, offset and limit; it says nothing extra about 'brex' resolution or the 'search' matching semantics beyond what the schema already documents.

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 states a specific verb and resource ('List the rules of a BREX data module') and enumerates exactly what each rule entry contains (XPath target, forbidden/required/optional status, allowed values, severity, schema context) plus the header. It is clear on its own, but it never distinguishes itself from the sibling check_against_brex, which is the obvious alternative an agent would weigh.

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

Usage Guidelines3/5

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

Guidance exists but is aimed at parameters, not at tool selection: 'Use kind and context to narrow, offset/limit to page' tells the agent how to shape the call. There is no statement of when to use this versus check_against_brex (inspect rules vs. validate a document), so the usage context is only implied.

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

Deploy Server

Other Tools