Skip to main content
Glama
SignalEDI

SignalEDI MCP Server

Official
by SignalEDI
OverviewSchemaSourceRelated ServersDiscussionsAdmin
JavaScript
Remote

Lookup Element Definition

lookup_element_definition
Read-onlyIdempotent

Search X12 EDI segment maps and acknowledgment codes by element name, keyword, or code to instantly identify definitions for 850, 810, 856, and 837 documents.

Instructions

Alias for lookup_x12 — search segment maps and ack codes (850/810/856/837 dictionaries). Local read-only operation.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
queryNoSegment id, element keyword, or ack code.
elementNoAlias for query when prompting by element name.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
queryYes
matchesYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed8 schema fields changedv0.4.1
    • addedInput schema / anyOf
      Added value: +[
+  {
+    "required": [
+      "query"
+    ],
+    "type": "object"
+  },
+  {
+    "required": [
+      "element"
+    ],
+    "type": "object"
+  }
+]
    • addedInput schema / properties / element / maxLength
      Added value: +200
    • addedInput schema / properties / element / minLength
      Added value: +1
    • addedInput schema / properties / element / pattern
      Added value: +"\\S"
    • addedInput schema / properties / query / maxLength
      Added value: +200
    • addedInput schema / properties / query / minLength
      Added value: +1
    • addedInput schema / properties / query / pattern
      Added value: +"\\S"
    • 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.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and idempotentHint=true, and the description adds 'Local read-only operation,' which is consistent and adds minor context (local implies no remote calls). It also specifies the covered dictionaries, but does not disclose additional behaviors like error handling or response format, which are partly covered by the output schema.

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 a single, compact sentence that leads with the alias and then the core purpose. Every word adds value, with no redundancy or 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?

Given the presence of an output schema and comprehensive annotations, the description is mostly complete. It specifies the exact dictionaries and notes it is local and read-only, which is sufficient for an agent to call it correctly. It does not mention that either 'query' or 'element' is required, but that is already encoded in the schema via anyOf.

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%, with both 'query' and 'element' parameters having detailed descriptions in the schema. The tool description adds no extra parameter semantics beyond what the schema already provides, so the baseline score of 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?

The description clearly states the tool is an alias for lookup_x12 and specifies its function: searching segment maps and ack codes within 850/810/856/837 dictionaries. It uses a specific verb ('search') and resource ('segment maps and ack codes'), and the mention of being an alias distinguishes it from other tools like search_docs or explain_edi_error.

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

Usage Guidelines2/5

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

The description notes it is an alias for lookup_x12 but provides no guidance on when to use this tool versus alternatives. It does not mention conditions for choosing it over search_docs, get_document_schema, or other siblings, nor does it offer exclusions or preferred scenarios.

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