SignalEDI MCP Server
OfficialSignalEDI MCP Server lets you discover, scaffold, validate, test, and send X12 EDI integrations and manage QuickBooks connections, with keyless docs by default and explicit sandbox/production profiles.
Docs/local (keyless): search developer docs, fetch X12 starter schemas (850/810/856/837), generate integration code examples, render synthetic test X12, explain EDI errors, and look up X12 segments/ack codes.
Parse/validate: parse raw EDI interchanges into structured JSON and validate X12 structure (incl. aliases
parse_segments,validate_x12_structure).Transactions: list and fetch owned EDI transactions with lifecycle/SLA status.
Partner kits: list and fetch generic SignalEDI API kits, with an explicit non-partner-specific warning when applicable.
QuickBooks: check QBO connection status, list QBO entities (sandbox), sync EDI into QBO (sandbox), export QBO invoices/POs to EDI (dry run or send), and disconnect QBO (sandbox).
Connections: list/get AS2/SFTP/legacy API connections, create sandbox-first drafts, configure/test saved connections, and request go-live approval (no production activation/rollback).
Outbound: send outbound EDI documents to partners (requires confirm + idempotency key).
Profiles/scopes:
docs(default),sandbox, and explicitproduction(canonical base + opt-in) enforce least-privilege tool availability and domain scopes.
Provides tools for integrating with QuickBooks Online, including syncing EDI transactions to QBO, exporting QBO invoices and purchase orders as EDI, listing QBO entities for mapping, and managing the QBO connection.
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@SignalEDI MCP Server Parse this EDI 850 document and summarize the errors"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
SignalEDI Developer MCP Server
Connect an AI coding assistant to SignalEDI to discover, scaffold, validate, and test X12 integrations. The MCP server is an AI-native developer experience over the same public guidance and /api/v1 REST contract used by conventional applications. It complements—not replaces—SignalEDI's REST API, OpenAPI specification, webhooks, SDKs, and documentation.
The package is an uplift of SignalEDI's existing MCP adapter. Version 0.5 adds public developer discovery, resource templates, code examples, governed connection control-plane tools, strict tool-input validation, and explicit capability profiles while retaining the existing parser, transaction, partner-kit, and QuickBooks adapters.
Package |
|
MCP Registry |
|
Transport | stdio |
Runtime | Node 22+ |
Runtime dependency |
|
Default access | Always keyless |
Capability profiles
Set SIGNALEDI_MCP_PROFILE to one of these profiles. Tool discovery and direct tool calls are both restricted to the active profile.
Profile | Authentication | Surface |
| None | Public documentation resources and local synthetic helpers only; supplied document content and credentials are never uploaded. The OpenAPI resource performs a content-free public GET. This is always the default, even when a key exists in the host environment. |
| Separately provisioned non-production key plus explicit base URL | Authenticated parse/validate, generic partner-kit discovery, tenant-data reads, and guarded mutations for a separately provisioned sandbox. Canonical production SignalEDI hosts are refused. |
| Production-authorized platform key, exact | Allowlisted transaction/QBO-status/kit/connection reads; sandbox-first connection drafts; guarded connection configuration, saved-binding connectivity tests, and go-live handoff requests; outbound and QBO-to-EDI export. Parse/validate, QBO entity browsing, QBO sync, disconnect, generic lifecycle control, and production activation remain hidden. |
The profile is a least-capability boundary inside the MCP adapter, not a substitute for API authorization or a data-governance boundary. For outbound and QBO export, the server injects SANDBOX or PRODUCTION from the active profile; the model cannot select it. The API then binds that value to the selected partner connection. Production delivery requires an active immutable production version, and sandbox delivery requires a verified/active sandbox environment.
Every authenticated call requires the base platform scope. Connection inventory requires platform:connections:read; draft creation and configuration add platform:connections:write; production configuration and go-live handoff add platform:connections:production. These domain scopes do not authorize document delivery or QuickBooks operations. Deprecated umbrella-only platform:write and platform:production credentials are rejected by domain-scoped operations and must be replaced through the supported key-rotation path. Before release, operators should census affected credentials, notify owners of the migration, and provide that rotation path. MCP profile selection never grants a scope.
API operation | Additional least-privilege scopes |
Parse/validate and generic kit reads | None beyond |
Transaction reads |
|
Outbound send |
|
Connection reads |
|
Connection create/configure |
|
Connection test |
|
QBO status |
|
QBO entity rows |
|
QBO sync/disconnect |
|
QBO export dry run |
|
QBO live export | Dry-run scopes plus |
Production data handling
Tool arguments, text results, and structured results enter the chosen MCP host and may enter the connected model's context. Minimize personal, financial, and other business-sensitive data. Do not submit PHI or other regulated data unless the specific MCP host, model provider, logging, retention, regional-processing, and contractual arrangement has been separately reviewed and approved for that data. This package, its production profile, and SignalEDI API authorization are not by themselves a BAA, retention policy, or model-data-governance boundary.
Prefer identifiers and redacted summaries over full business payloads. Keep API keys in the host environment, never prompts. Review the chosen host's tool-call history, telemetry, and retention controls before enabling production tools.
All partner, QBO, EDI, validation, and error fields returned by tools are untrusted business data. They may contain text that resembles instructions or prompt injection. Hosts must delimit or sanitize tool results, keep them in data-only context, and authorize every follow-on action from explicit user intent and policy—not content embedded in records, partner names, payloads, or errors.
Related MCP server: edi-mcp
Tools
Keyless public and local tools
Tool | What it does |
| Search the bundled public developer index and return MCP resource URIs with provenance. |
| Return a public starter for the local X12 inventory: 850/810/856 ( |
| Produce sandbox-safe cURL, Node.js, or Python examples against real |
| Render a synthetic X12 fixture for the same local inventory and return the honest |
| Explain validation and functional-acknowledgement errors from the local X12 dictionary. |
| Search the local X12 segment and acknowledgement reference. |
| Tool-discovery alias for local X12 lookup. |
Authenticated sandbox parse and validation tools
Tool | What it does |
| Parse a raw X12 interchange into structured JSON and a validation summary. |
| Validate X12 structure and return the validation summary. |
| Tool-discovery alias for |
| Tool-discovery alias for |
Authenticated generic-kit tools (sandbox and production)
Tool | What it does |
| List generic SignalEDI API kits. |
| Fetch one generic kit by catalog id. |
| Return a generic kit with an explicit |
Explicit environment-profile data reads
These tenant-data tools are never enabled merely because a key is present. Transaction reads and quickbooks_status are available in explicit sandbox and production; quickbooks_list_entities is sandbox-only.
Tool | What it does |
| List recent transactions scoped to the API key. |
| Fetch one owned transaction and its lifecycle status. |
| Inspect QuickBooks Online connection status without returning tokens. |
| Preview Invoice, Estimate, PurchaseOrder, Customer, Vendor, or Item rows for mapping (sandbox-only). |
Governed connection control plane (sandbox and production)
Connection tools operate on the public /api/v1/connections contract. MCP applies a second response allowlist over the API's sanitized representation: it may return opaque gateway/evidence references and configured-status booleans, but never stored credentials, secret references, raw transport configuration, private keys, certificates, or tokens.
Tool | What it does |
| Cursor-page tenant-scoped AS2/SFTP and legitimate legacy API connection summaries with optional partner/lifecycle filters. |
| Inspect safe environment, gateway, approval, test-coverage, readiness, and next-action state for one AS2/SFTP or legacy API connection. |
| Create or recover an idempotent sandbox-first |
| Bind an existing gateway reference and constrained X12 ISA/GS identifiers to an AS2/SFTP |
| Test the exact saved connection in the environment injected from the active profile. The operation causes partner-network egress, records sanitized evidence, requires host-enforced review plus an idempotency key, and never accepts endpoints or credentials or activates production. |
| Ask the API to move a server-proven |
There is deliberately no generic lifecycle-transition tool. test_connection can create authoritative connectivity evidence for the exact saved binding; intermediate testing/certification stages otherwise come from evidence or onboarding-project state, not model claims. There are no production activation, rollback, or isolation tools.
Explicit write-profile tools
Tool | What it does |
| Submit an outbound EDI document in the active sandbox/production environment. |
| Push a bounded transaction selection into QBO (sandbox-only); buyer and supplier directions are explicit, and |
| Preview or export QBO invoices/purchase orders as EDI in the active sandbox/production environment. Dry-run results are payload-redacted by default; full payloads require |
| Revoke and remove the workspace QBO connection (sandbox-only). |
Every tool publishes an input and output schema. The server validates inputs itself, rejects unknown fields, and returns both readable text and structuredContent with namespaced contract metadata.
Mutation safety
Write tools are absent from docs. Every live mutation requires confirm:true and a caller-generated idempotencyKey of 8–128 printable ASCII characters without leading/trailing whitespace. Outbound sends, QBO sync/export/disconnect, and connection create/configure/test/go-live requests enforce durable API-side replay protection and are annotated idempotent. QBO disconnect stays sandbox-only and reports a pending Intuit revocation instead of claiming completion. confirm:true is an assertion from the calling workflow; the MCP server cannot independently prove that a human approved it, so the host must present the action for review.
The MCP client never automatically retries mutations or parse/validate POSTs. Parse/validate upload synthetic or approved test data and can record sandbox usage, so their annotations remain non-read-only and non-idempotent. Read-only GETs retain bounded transient retry behavior.
Custom base URLs are rejected unless SIGNALEDI_MCP_ALLOW_CUSTOM_BASE_URL=1 is set after the destination is verified. URLs containing credentials, paths, queries, or fragments are rejected. HTTP is allowed only for localhost and still requires the custom-host opt-in.
The adapter caps raw EDI inputs at 65,536 UTF-8 bytes, serialized JSON request bodies at 1 MiB, and API responses at 4 MiB. The input schemas publish character/collection bounds; byte limits are rechecked immediately before network use, and streamed responses are cancelled when they cross the cap.
Resources and prompts
Stable guidance is exposed as resources rather than action tools:
signaledi://quickstartsignaledi://openapisignaledi://developer-workflowssignaledi://x12-referencesignaledi://documents/{transactionSet}/schema
The document schema is also advertised as a resource template. Prompts include scaffold-integration, onboard-partner, and debug-rejection; scaffold and onboarding prompts default to synthetic data and avoid writes until an isolated sandbox is confirmed.
Quick start
Run the public docs profile:
npx -y @signaledi/mcp-server@0.5.0Configure the authenticated sandbox profile only after a non-production base and key have been provisioned. Claude Code project config (.mcp.json) expands ${NAME} from the host environment:
{
"mcpServers": {
"signaledi": {
"command": "npx",
"args": ["-y", "@signaledi/mcp-server@0.5.0"],
"env": {
"SIGNALEDI_MCP_PROFILE": "sandbox",
"SIGNALEDI_API_KEY": "${SIGNALEDI_SANDBOX_API_KEY}",
"SIGNALEDI_BASE_URL": "${SIGNALEDI_SANDBOX_BASE_URL}",
"SIGNALEDI_MCP_ALLOW_CUSTOM_BASE_URL": "1"
}
}
}
}On native Windows, Claude Code must launch the npm shim through cmd:
{
"mcpServers": {
"signaledi": {
"command": "cmd",
"args": ["/c", "npx", "-y", "@signaledi/mcp-server@0.5.0"],
"env": {
"SIGNALEDI_MCP_PROFILE": "sandbox",
"SIGNALEDI_API_KEY": "${SIGNALEDI_SANDBOX_API_KEY}",
"SIGNALEDI_BASE_URL": "${SIGNALEDI_SANDBOX_BASE_URL}",
"SIGNALEDI_MCP_ALLOW_CUSTOM_BASE_URL": "1"
}
}
}
}Cursor uses .cursor/mcp.json, mcpServers, and ${env:NAME} references:
{
"mcpServers": {
"signaledi": {
"command": "npx",
"args": ["-y", "@signaledi/mcp-server@0.5.0"],
"env": {
"SIGNALEDI_MCP_PROFILE": "sandbox",
"SIGNALEDI_API_KEY": "${env:SIGNALEDI_SANDBOX_API_KEY}",
"SIGNALEDI_BASE_URL": "${env:SIGNALEDI_SANDBOX_BASE_URL}",
"SIGNALEDI_MCP_ALLOW_CUSTOM_BASE_URL": "1"
}
}
}
}Claude Code plugin
This public repository is also a Claude Code / Cowork plugin for the community plugin directory. The plugin launches the same npm package over stdio — there is no parallel MCP implementation and SignalEDI does not expose a hosted remote MCP URL, so skip the remote OAuth connector directory.
Plugin manifest |
|
MCP config |
|
Skill |
|
Validate locally |
|
Submit (Console) | |
Submit (claude.ai Team/Enterprise) |
Docs: Submitting your plugin. Official claude-plugins-official marketplace is curated; community submit still requires a public GitHub repo and claude plugin validate. One-click install needs @signaledi/mcp-server@0.5.0 on npm.
Claude Desktop (MCPB)
Package the same stdio server as a Claude Desktop Extension (.mcpb). Source: mcpb/manifest.json + scripts/build-mcpb.mjs. See mcpb/README.md for full build and submit notes.
npm ci
npm run build:mcpb
# → dist/signaledi-mcp-server-0.5.0.mcpbInstall by double-clicking the .mcpb, dragging it into Claude Desktop, or Settings → Extensions → Advanced → Install Extension…. Extension settings map to the same env vars as server.json (SIGNALEDI_API_KEY, SIGNALEDI_BASE_URL, SIGNALEDI_MCP_PROFILE, etc.). Author/publisher: SignalEDI · Support@signaledi.com · https://signaledi.com.
Directory submit (manual only): do not submit from this agent/CI. When ready, follow Anthropic’s desktop extension submission form after building/testing the artifact. Tooling: @anthropic-ai/mcpb (mcpb pack / mcpb validate). Spec: Build a desktop extension with MCPB.
Google Antigravity
Manual Antigravity / Gemini-style plugin folder at antigravity-plugin/ (wires mcp_config.json → npx -y @signaledi/mcp-server@0.5.0). MCP Store listing is not self-serve; install by copying the folder:
Scope | Path |
Global |
|
Workspace |
|
See antigravity-plugin/README.md. Brand: SignalEDI only.
Cursor Marketplace
This public repository is packaged as a Cursor Plugin for the official Marketplace. The plugin launches the same npm package over stdio — there is no parallel MCP implementation.
Plugin manifest |
|
MCP config |
|
Logo |
|
Skill |
|
Submit | cursor.com/marketplace/publish → repo |
Install (after listing): open Customize → Marketplace, search for SignalEDI, and install.
Configure: set plugin variables under Plugins → Configure (no secrets in the repo or prompts):
Variable | Typical value |
|
|
| Least-privilege workspace key (ignored by |
| Verified non-production origin, or exactly |
|
|
|
|
Plugin mcp.json uses ${VAR} placeholders that match those dashboard variables (not the manual ${env:NAME} syntax used in project .cursor/mcp.json). Unset placeholders stay fail-closed on the keyless docs profile. Marketplace one-click install requires @signaledi/mcp-server@0.5.0 (or newer matching pin) on npm; until that publish lands, local/manual npx against a published version still works for verification.
Publishing is subject to the Cursor Marketplace Publisher Terms. Marketplace plugins must be open source and pass manual review; see marketplace security.
Privacy Policy
SignalEDI’s product privacy policy is published at https://signaledi.com/privacy. The MCP adapter runs locally over stdio; authenticated calls send tool inputs to the SignalEDI API host you configure. Tool arguments, text results, and structured results enter the MCP host and may enter model context—see Production data handling above. Contact: Support@signaledi.com.
VS Code uses .vscode/mcp.json, a top-level servers object, and a password input for secrets:
{
"inputs": [
{
"type": "promptString",
"id": "signaledi-api-key",
"description": "SignalEDI non-production sandbox API key",
"password": true
},
{
"type": "promptString",
"id": "signaledi-api-base",
"description": "Verified non-production SignalEDI API base URL"
}
],
"servers": {
"signaledi": {
"type": "stdio",
"command": "npx",
"args": ["-y", "@signaledi/mcp-server@0.5.0"],
"env": {
"SIGNALEDI_MCP_PROFILE": "sandbox",
"SIGNALEDI_API_KEY": "${input:signaledi-api-key}",
"SIGNALEDI_BASE_URL": "${input:signaledi-api-base}",
"SIGNALEDI_MCP_ALLOW_CUSTOM_BASE_URL": "1"
}
}
}
}For a provisioned local sandbox, add the following values to the chosen client's env object, using that client's environment-reference syntax for the key:
{
"SIGNALEDI_MCP_PROFILE": "sandbox",
"SIGNALEDI_API_KEY": "<host environment reference to SIGNALEDI_SANDBOX_API_KEY>",
"SIGNALEDI_BASE_URL": "http://localhost:3100",
"SIGNALEDI_MCP_ALLOW_CUSTOM_BASE_URL": "1"
}Production is an explicit, fail-closed opt-in. Use only the canonical origin and keep the key in the MCP host environment:
{
"SIGNALEDI_MCP_PROFILE": "production",
"SIGNALEDI_API_KEY": "<host environment reference to SIGNALEDI_PRODUCTION_API_KEY>",
"SIGNALEDI_BASE_URL": "https://signaledi.com",
"SIGNALEDI_MCP_ALLOW_PRODUCTION": "1"
}The production profile does not accept custom hosts or a missing/implicit base. Removing any one of the profile, key, canonical base, or opt-in prevents startup.
Never paste real keys or secrets into prompts. MCP server environment variables are resolved by the host process, not by the model.
Configuration
Environment variable | Default | Purpose |
|
| Capability boundary: |
| — | Least-privilege workspace key; ignored in |
| Public production base for the content-free docs OpenAPI GET only | Sandbox requires an explicit verified non-production origin; production requires exactly |
| — | Set to |
| — | Set to |
| enabled | Set to |
The server writes JSON-RPC only to stdout and logs only to stderr.
Deliberately deferred surfaces
The MCP does not fabricate hosted capabilities that are not yet backed by stable, tenant-isolated APIs:
suggest_mappingandvalidate_mappingwait for the structured mapping-validation service and partner-guide provenance contract.create_sandbox_project,create_test_partner,submit_test_document, andget_test_resultswait for stable tenant-isolated lifecycle/test routes.generate_webhook_fixtureandverify_webhook_signaturewait for one canonical runtime signing contract; the current primary delivery/replay path and remediation path sign differently.Credential rotation, raw gateway configuration, mapping deployment, arbitrary partner edits, manual evidence/lifecycle claims, production activation/rollback/isolation, QBO sync/disconnect, and document retransmission are not exposed in production. The production profile is limited to the allowlisted reads and server-gated draft/configuration/connectivity-test/go-live-request/outbound/QBO-export operations described above.
Local development
node test.mjs
npm run test:stdio
npm startUnit tests use synthetic data and mock HTTP. The stdio integration tests exercise docs, sandbox, and production discovery without live API calls. See RELEASE_NOTES_0.5.0.md for release gates.
Architecture and repository authority
MCP client
<-> @signaledi/mcp-server over stdio
|- public documentation resources and local synthetic helpers
`- profile-gated calls to the conventional SignalEDI /api/v1 REST APIThe standalone GitHub repository SignalEDI/mcp-server is the canonical source and sole automated npm/MCP Registry publish authority. The private SignalEDI/platform repository may retain a synchronized validation snapshot for its hosted API/backend contracts; see MIRROR.md. All examples are synthetic and must remain free of customer, health, financial, and credential data.
Available Tools
7 toolsexplain_edi_errorExplain Edi ErrorARead-onlyIdempotent
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.
Inputs: code, segment, rawError. Returns: fix, meaning, rawError, lookup_x12, +1 more
generate_integration_exampleGenerate Integration ExampleARead-onlyIdempotent
Generate a sandbox-safe cURL, Node.js, or Python example for the current SignalEDI REST contract. Uses environment-variable placeholders and synthetic values, sets outbound environment to SANDBOX, refuses production hosts, and never embeds credentials. Local read-only operation.
Inputs: language (required), operation (required), documentType. Returns: code, path, notes, method, +3 more
generate_test_documentGenerate Test DocumentARead-onlyIdempotent
Render a synthetic X12 sample for the local inventory (850/810/856 baseline, 837 Professional partial). Returns an honest capability label. controlNumber and the transaction's primary date apply to every fixture; poNumber applies only to 850 and 810. Refuses EDIFACT, HL7, and unknown sets. Local only; works in the docs profile. Local read-only operation.
Inputs: type (required), overrides. Returns: tool, type, error, content, +4 more
get_document_schemaGet Document SchemaARead-onlyIdempotent
Get a public X12 starter schema for the local inventory (850/810/856 baseline, 837 Professional partial). Returns an honest capability label and is explicitly not a trading-partner implementation guide. Refuses EDIFACT, HL7, and unknown sets. Local read-only operation.
Inputs: transactionSet (required). Returns: name, tool, error, fixture, +15 more
lookup_element_definitionLookup Element DefinitionARead-onlyIdempotent
Alias for lookup_x12 — search segment maps and ack codes (850/810/856/837 dictionaries). Local read-only operation.
Inputs: query, element. Returns: query, matches
lookup_x12Lookup X12ARead-onlyIdempotent
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.
Inputs: query (required). Returns: query, matches
search_docsSearch DocsARead-onlyIdempotent
Search the bundled public SignalEDI developer index. Returns authoritative MCP resource URIs and short snippets; it does not search customer data or private partner guides. Local read-only operation.
Inputs: query (required), limit. Returns: query, scope, results
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
TDQS
Scored across 7 tools
lookup_x12 and lookup_element_definition are explicitly the same operation under different names, creating direct overlap. search_docs and lookup_x12 also share a search-like purpose, though descriptions differentiate them. Other tools are clearly distinct.
All tool names follow a consistent snake_case verb_noun pattern (search_, get_, lookup_, generate_, explain_). No mixed conventions or irregular prefixes exist.
With 7 tools, the server is well within the ideal 3-15 range for its EDI reference scope. The one redundant alias tool is a minor blemish but does not make the set bloated or thin.
The tool surface covers the main workflows for an EDI documentation/sandbox server: searching docs, retrieving schemas, looking up X12 definitions, generating examples, explaining errors, and producing test documents. Minor gaps exist (e.g., no explicit supported-transaction-set listing), but no critical dead ends.
Maintenance
Related MCP Connectors
Connect QuickBooks to ChatGPT, Claude & Grok. Record bills, invoices, journal entries. Run reports.
Send encrypted files and secrets, collect files and get documents signed, from your AI.
Connect QuickBooks Online to AI agents with secure read or write access across multiple companies.
Validate, extract, repair and generate French Factur-X / EN16931 invoices via AgentForge API
Related MCP Servers
- FlicenseNot gradedqualityDmaintenanceIntegrates QuickBooks with GenAI applications via the Model Context Protocol, enabling accounting and financial management tasks.1-
- AlicenseAqualityDmaintenanceLet AI agents read, validate and acknowledge EDI documents. Parses raw X12 and EDIFACT interchanges into structured JSON, validates envelope integrity, produces plain-language summaries, and generates 997 Functional Acknowledgments.4MIT
- AlicenseNot gradedqualityBmaintenanceEnables AI assistants to locally parse, validate, audit, explain, generate, and convert XRechnung and ZUGFeRD/Factur-X e-invoices using official rule sets, fully offline with no API keys required.Apache 2.0
- FlicenseNot gradedqualityCmaintenanceEnables AI assistants to parse, validate, summarize, and convert X12 EDI documents (such as 850 purchase orders and 810 invoices) into structured JSON through callable MCP tools.-