Skip to main content

check-partner-config

Health-check a single ECGrid interconnect (trading-partner relationship) for completeness and correctness. Use when the caller asks whether a trading partner is set up correctly, ready to exchange traffic, fully configured, or wants to know why traffic is not flowing — given the integer interconnect ID. Runs four checks: setup complete (status = Completed), traffic has flowed, both ECGrid IDs are active, and whether either ID has a future-dated move scheduled. Returns NOT_FOUND when no interconnect matches the ID.

Tool Name​

connectivity_partner_check-partner-config

Auth Level Required​

Any (scoped to caller's APIKey)

Parameters​

ParameterTypeRequiredDescription
request.interconnectIdintegerYesThe numeric interconnect (trading-partner relationship) ID to health-check. Positive integer >= 1. Example: 12345. Same value as InterconnectIDInfo.interconnectId returned by connectivity_partner_list-partners or connectivity_partner_get-partner-by-id.

Response​

Returns a health summary with individual check results and a plain-language issues array describing any problems found.

{
  "isHealthy": false,
  "setupComplete": true,
  "hasTraffic": false,
  "tp1": {
    "isActive": true,
    "scheduledMove": false,
    "lastTraffic": null
  },
  "tp2": {
    "isActive": true,
    "scheduledMove": false,
    "lastTraffic": null
  },
  "issues": [
    "No traffic has been recorded on this interconnect. Verify both sides are sending EDI documents.",
    "TP1 has no last-traffic timestamp — the interconnect may never have been used."
  ]
}

Response Fields​

FieldTypeDescription
isHealthybooleantrue when all critical checks pass; false if any issue was found
setupCompletebooleantrue when the interconnect status is Completed (both sides accepted)
hasTrafficbooleantrue when at least one EDI document has flowed across this relationship
tp1objectHealth flags for the TP1 side of the interconnect
tp1.isActivebooleantrue when the TP1 ECGrid ID's lifecycle status is Active
tp1.scheduledMovebooleantrue when the TP1 ECGrid ID has a future-dated move scheduled via ownerInfo.effective
tp1.lastTrafficstring | nullISO 8601 timestamp of the most recent traffic from the TP1 side (null if none)
tp2objectHealth flags for the TP2 side — same shape as tp1
tp2.isActivebooleantrue when the TP2 ECGrid ID's lifecycle status is Active
tp2.scheduledMovebooleantrue when the TP2 ECGrid ID has a future-dated move scheduled
tp2.lastTrafficstring | nullISO 8601 timestamp of the most recent traffic from the TP2 side (null if none)
issuesarrayPlain-language list of problems and warnings to relay to the caller. Empty when isHealthy is true.

Example Call​

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "connectivity_partner_check-partner-config",
    "arguments": {
      "request": { "interconnectId": 12345 }
    }
  }
}

Example Prompts​

  • Is trading partner 12345 set up correctly?
  • Why is traffic not flowing with interconnect 99999?
  • Check the configuration for partner 55555

See Also​