Skip to main content
Glama
SignalEDI

SignalEDI MCP Server

Official
by SignalEDI

Lookup X12

lookup_x12
Read-onlyIdempotent

Search the local X12 dictionary by segment ID, acknowledgment code, or keyword to identify EDI elements and purposes.

Instructions

Search the local X12 dictionary by segment id, ack code, or free text (segment names and purposes). Local only; works in the docs profile. Local read-only operation.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
queryYesSegment id, ack code, or keyword.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
queryYes
matchesYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.4.1
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "additionalProperties": false,
      +  "properties": {
      +    "matches": {
      +      "items": {
      +        "additionalProperties": true,
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "query": {
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "query",
      +    "matches"
      +  ],
      +  "type": "object"
      +}
  2. First observedv0.4.0

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint, so the safety profile is covered. The description adds useful context about execution scope ('local only') and environment ('works in the docs profile'), and notes it's a read-only operation. This goes beyond what annotations provide, so it earns a 4.

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

Conciseness3/5

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

The first sentence is crisp and informative. The second and third sentences overlap ('local only' vs 'local read-only operation'), creating mild redundancy. The description could be tightened without losing meaning, so it's acceptable but not exemplary.

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?

The description is sufficient for a single-parameter read-only lookup tool with an output schema. It covers query types, scope, and environment; the output schema handles return value details. It doesn't address differentiating from siblings, but that's not essential for calling the tool correctly.

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?

The schema's 100% description coverage sets a baseline of 3. The description adds value by specifying that the query can be free text for segment names and purposes, which expands on the schema's 'keyword' and clarifies that searches are not limited to exact codes.

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 clearly states the tool searches a local X12 dictionary with specific query types (segment id, ack code, free text). It distinguishes its scope with 'local only' and 'works in the docs profile,' but it doesn't explicitly name sibling tools to prevent confusion, so it's clear but not maximally differentiating.

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 implies usage by describing the search and local scope, but it doesn't provide explicit guidance on when to use this tool instead of siblings like lookup_element_definition or search_docs. It mentions 'local only' and 'docs profile' as context for availability, but there is no when-not-to-use guidance.

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