Skip to main content
Glama

lookup_sns

Resolve a Standard Numbering System (SNS) code in S1000D BREX by DMC or system/subsystem codes, returning the matched hierarchy with titles and indicating prefix-only matches.

Instructions

Explain what a Standard Numbering System (SNS) code means in a BREX: pass a DMC (the system / subsystem / sub-subsystem / assembly codes are taken from it) or the codes directly. Returns the matched hierarchy with titles; "exact: false" means only a prefix matched.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "lookup_sns"
  }
}

Input Schema

NameRequiredDescriptionDefault
dmcNoA DMC whose SNS part should be looked up.
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.
assyCodeNoAssembly code (2 or 4 characters).
csdbDirsNoExtra folders to search for data modules and BREX by DMC (in addition to S1000D_CSDB_DIR and S1000D_SPEC_DIR).
systemCodeNoSystem code (2-3 characters), when not passing dmc.
subSystemCodeNoSubsystem code (1 character).
subSubSystemCodeNoSub-subsystem code (1 character).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.4.0

TDQS

A4.2/5.0
Behavior4/5

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

With no annotations provided, the description carries the burden and does disclose the return format ("matched hierarchy with titles") plus the meaning of "exact: false" as a prefix-only match. It implies a read-only lookup, though it does not explicitly state permission or side-effect behavior.

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 description is compact and front-loaded, starting with the core purpose and then covering input modes and return semantics. Every clause contributes useful information without repetition.

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 seven-parameter tool with no output schema, the description adequately explains the input alternatives and the key return-shape signal ("matched hierarchy with titles"). It could say more about edge cases such as missing input or default BREX selection, but the rich schema covers most parameter details.

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 schema already documents all seven parameters. The description still adds useful meaning by explaining that DMC supplies the system/subsystem/sub-subsystem/assembly codes and that "exact: false" indicates a prefix match.

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?

The description names a specific verb ("Explain") and a specific resource ("Standard Numbering System (SNS) code") within a BREX. It also clarifies the two input modes, DMC-based or direct code-based, making the tool's role distinct from generic lookup or BREX explanation siblings.

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?

The description states how to invoke the tool (pass a DMC or codes directly) but does not explicitly say when to use it versus siblings such as explain_brex or lookup_value. Usage is implied by the input alternatives rather than through clear inclusion/exclusion guidance.

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