MCP documentation | MCP docs for agents

ark_request_edi_partner_connection

ark.request_edi_partner_connection

Request EDI trading-partner setup for a broker organization using the same workflow as the Connections page.

Availability
Expanded preview
Scopes
edi:write
ARK permissions
canAdminEdi
Team visibility
Not entity-scoped
Approval policy
ask_before_write
ARK approval request
Required before execution
Idempotency
Required for external execution
Read-only
No
Destructive
No
External side effect
No
Rate limit
OAuth MCP credential and organization budgets

Input

partnerDisplayNamestringrequired

Trading partner display name, such as CH Robinson or Uber Freight.

min length: 1; max length: 200

requestNotesstring | null

Optional setup notes for the ARK/broker EDI admin workflow.

max length: 5000

Result

The tool returns the canonical ark.request_edi_partner_connection operation result in structuredContent and mirrors the same JSON as text. Errors set isError: true and return a stable error code, message, and optional details.