Skip to main content
Glama
SignalEDI

SignalEDI MCP Server

Official
by SignalEDI
OverviewSchemaSourceRelated ServersDiscussionsAdmin
JavaScript
Remote

Explain Edi Error

explain_edi_error
Read-onlyIdempotent

Explains EDI validation and functional-ack errors using the local X12 dictionary, providing meaning, likely cause, and fix. Works offline as a read-only lookup.

Instructions

Explain an EDI validation or functional-ack error using the local X12 dictionary (meaning, typical cause, fix, lookup_x12 cross-refs). Never calls the network; works in the docs profile. Local read-only operation.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
codeNoAck or validation code (e.g. R, 4, 7).
segmentNoSegment id near the error (e.g. SE, PO1).
rawErrorNoOptional raw error text from validate_edi or a 997/999.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
fixYes
meaningYes
rawErrorNo
lookup_x12Yes
typicalCauseYes

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": {
+    "fix": {
+      "type": "string"
+    },
+    "lookup_x12": {
+      "items": {
+        "additionalProperties": true,
+        "type": "object"
+      },
+      "type": "array"
+    },
+    "meaning": {
+      "type": "string"
+    },
+    "rawError": {
+      "type": "string"
+    },
+    "typicalCause": {
+      "type": "string"
+    }
+  },
+  "required": [
+    "meaning",
+    "typicalCause",
+    "fix",
+    "lookup_x12"
+  ],
+  "type": "object"
+}
  2. First observedv0.4.0

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so the safety profile is covered. The description adds valuable behavioral context: it is a local operation, never calls the network, and works in the docs profile. This goes beyond the annotations and helps an agent understand execution constraints.

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 two sentences with no wasted words. It front-loads the core purpose, then adds the key constraints (local, no network, docs profile). Every sentence earns its place.

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 tool has an output schema, so return values are already documented. The description covers the tool's scope, constraints, and relationship to the X12 dictionary. It could mention what happens when no match is found or how the cross-refs are presented, but given the output schema and annotations, the description is sufficiently complete for an agent to select and invoke the tool correctly.

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%, so the schema already documents all three parameters. The description does not add additional meaning beyond the schema, but it does mention 'lookup_x12 cross-refs' which hints at how the code parameter relates to the dictionary. Baseline 3 is appropriate since the schema carries the parameter documentation burden.

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 states a specific verb ('Explain') and resource ('EDI validation or functional-ack error') and explicitly distinguishes itself from siblings by mentioning 'lookup_x12 cross-refs' and 'local X12 dictionary'. It clearly identifies what the tool does and how it differs from related tools.

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

Usage Guidelines4/5

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

The description provides clear context for when to use the tool: for EDI validation or functional-ack errors, using the local X12 dictionary. It also states what it does not do ('Never calls the network') and where it works ('docs profile'). However, it does not explicitly name alternative tools or conditions for when not to use it, though the sibling list and cross-ref mention imply alternatives.

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