Skip to main content
Glama

Check sync health

get_sync_health
Read-onlyIdempotent

Integrations (between two systems): Use when a signed in CRM Connector customer asks how their syncs are doing: what failed, why records did not arrive, what is waiting, when an integration last ran or which conflicts wait for a choice. Returns, for all integrations or one, the failed records grouped by reason with a count per integration and record type, the records waiting on a related record, and totals. With an integration_id, include recent_syncs adds its latest syncs (moment, outcome and per record type what was read, written, skipped and failed) and include conflicts adds the conflicts waiting: two records that match one record, of which only one can sync, named only to a person who allowed managing integrations. Failure reasons never quote record contents. Not for listing integrations (use list_integrations) or for fixing anything: it only reads; resolve a conflict with resolve_conflict and start a sync with run_sync.

Input Schema

NameRequiredDescriptionDefault
daysNoHow many days back to look, 1 to 30.
limitNoWith include recent_syncs: how many of the latest syncs, 1 to 20.
includeNoOptional, with an integration_id: recent_syncs for its latest syncs, conflicts for the conflicts waiting.
integration_idNoOptional id of one integration, as list_integrations returns it; needed for include. Leave it out for all integrations.

Output Schema

NameRequiredDescriptionDefault
healthYes
conflictsYes
recentSyncsYes
conflictsNotReadYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed17 schema fields changed
    • addedInput schema / properties / include
      Added value: +{
      +  "description": "Optional, with an integration_id: recent_syncs for its latest syncs, conflicts for the conflicts waiting.",
      +  "items": {
      +    "enum": [
      +      "recent_syncs",
      +      "conflicts"
      +    ],
      +    "type": "string"
      +  },
      +  "maxItems": 2,
      +  "type": "array",
      +  "uniqueItems": true
      +}
    • changedInput schema / properties / integration_id / description
      Previous value: -"Optional id of one integration, as list_integrations returns it. Leave it out for all integrations."New value: +"Optional id of one integration, as list_integrations returns it; needed for include. Leave it out for all integrations."
    • addedInput schema / properties / limit
      Added value: +{
      +  "default": 5,
      +  "description": "With include recent_syncs: how many of the latest syncs, 1 to 20.",
      +  "maximum": 20,
      +  "minimum": 1,
      +  "type": "integer"
      +}
    • addedOutput schema / properties / conflicts
      Added value: +{
      +  "properties": {
      +    "conflicts": {
      +      "items": {
      +        "properties": {
      +          "alsoMatches": {
      +            "type": [
      +              "string",
      +              "null"
      +            ]
      +          },
      +          "id": {
      +            "format": "uuid",
      +            "type": "string"
      +          },
      +          "lastSeenAt": {
      +            "format": "date-time",
      +            "type": "string"
      +          },
      +          "recordType": {
      +            "type": "string"
      +          },
      +          "shared": {
      +            "type": [
      +              "string",
      +              "null"
      +            ]
      +          },
      +          "sharedIn": {
      +            "type": "string"
      +          },
      +          "syncedNow": {
      +            "type": [
      +              "string",
      +              "null"
      +            ]
      +          }
      +        },
      +        "required": [
      +          "id",
      +          "recordType",
      +          "sharedIn",
      +          "shared",
      +          "syncedNow",
      +          "alsoMatches",
      +          "lastSeenAt"
      +        ],
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "integrationId": {
      +      "format": "uuid",
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "manageUrl": {
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "message": {
      +      "type": "string"
      +    },
      +    "openConflicts": {
      +      "type": [
      +        "integer",
      +        "null"
      +      ]
      +    },
      +    "outcome": {
      +      "type": "string"
      +    },
      +    "status": {
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    }
      +  },
      +  "required": [
      +    "outcome",
      +    "message"
      +  ],
      +  "type": [
      +    "object",
      +    "null"
      +  ]
      +}
    • addedOutput schema / properties / conflictsNotRead
      Added value: +{
      +  "type": [
      +    "string",
      +    "null"
      +  ]
      +}
    • removedOutput schema / properties / days
      Removed value: -{
      -  "type": "integer"
      -}
    • removedOutput schema / properties / failures
      Removed value: -{
      -  "items": {
      -    "properties": {
      -      "direction": {
      -        "type": "string"
      -      },
      -      "integrationId": {
      -        "format": "uuid",
      -        "type": "string"
      -      },
      -      "integrationName": {
      -        "type": "string"
      -      },
      -      "reason": {
      -        "type": "string"
      -      },
      -      "recordType": {
      -        "type": "string"
      -      },
      -      "records": {
      -        "type": "integer"
      -      }
      -    },
      -    "required": [
      -      "integrationId",
      -      "integrationName",
      -      "recordType",
      -      "direction",
      -      "reason",
      -      "records"
      -    ],
      -    "type": "object"
      -  },
      -  "type": "array"
      -}
    • addedOutput schema / properties / health
      Added value: +{
      +  "properties": {
      +    "days": {
      +      "type": "integer"
      +    },
      +    "failures": {
      +      "items": {
      +        "properties": {
      +          "direction": {
      +            "type": "string"
      +          },
      +          "integrationId": {
      +            "format": "uuid",
      +            "type": "string"
      +          },
      +          "integrationName": {
      +            "type": "string"
      +          },
      +          "reason": {
      +            "type": "string"
      +          },
      +          "recordType": {
      +            "type": "string"
      +          },
      +          "records": {
      +            "type": "integer"
      +          }
      +        },
      +        "required": [
      +          "integrationId",
      +          "integrationName",
      +          "recordType",
      +          "direction",
      +          "reason",
      +          "records"
      +        ],
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "integrationId": {
      +      "format": "uuid",
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "integrations": {
      +      "items": {
      +        "properties": {
      +          "failedRecords": {
      +            "type": "integer"
      +          },
      +          "id": {
      +            "format": "uuid",
      +            "type": "string"
      +          },
      +          "lastSyncStartedAt": {
      +            "format": "date-time",
      +            "type": [
      +              "string",
      +              "null"
      +            ]
      +          },
      +          "name": {
      +            "type": "string"
      +          },
      +          "recordsWritten": {
      +            "type": "integer"
      +          },
      +          "syncs": {
      +            "type": "integer"
      +          },
      +          "waitingRecords": {
      +            "type": "integer"
      +          }
      +        },
      +        "required": [
      +          "id",
      +          "name",
      +          "syncs",
      +          "recordsWritten",
      +          "failedRecords",
      +          "waitingRecords",
      +          "lastSyncStartedAt"
      +        ],
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "moreInformationUrl": {
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "outcome": {
      +      "enum": [
      +        "answered",
      +        "noActivePlan",
      +        "notFound",
      +        "noIntegrations"
      +      ],
      +      "type": "string"
      +    },
      +    "summary": {
      +      "type": "string"
      +    },
      +    "totals": {
      +      "properties": {
      +        "failedRecords": {
      +          "type": "integer"
      +        },
      +        "recordsWritten": {
      +          "type": "integer"
      +        },
      +        "syncs": {
      +          "type": "integer"
      +        },
      +        "waitingRecords": {
      +          "type": "integer"
      +        }
      +      },
      +      "required": [
      +        "syncs",
      +        "recordsWritten",
      +        "failedRecords",
      +        "waitingRecords"
      +      ],
      +      "type": "object"
      +    },
      +    "waiting": {
      +      "items": {
      +        "properties": {
      +          "integrationId": {
      +            "format": "uuid",
      +            "type": "string"
      +          },
      +          "integrationName": {
      +            "type": "string"
      +          },
      +          "recordType": {
      +            "type": "string"
      +          },
      +          "records": {
      +            "type": "integer"
      +          },
      +          "waitingOn": {
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "integrationId",
      +          "integrationName",
      +          "recordType",
      +          "waitingOn",
      +          "records"
      +        ],
      +        "type": "object"
      +      },
      +      "type": "array"
      +    }
      +  },
      +  "required": [
      +    "outcome",
      +    "summary",
      +    "days",
      +    "integrationId",
      +    "totals",
      +    "integrations",
      +    "failures",
      +    "waiting",
      +    "moreInformationUrl"
      +  ],
      +  "type": "object"
      +}
    • removedOutput schema / properties / integrationId
      Removed value: -{
      -  "format": "uuid",
      -  "type": [
      -    "string",
      -    "null"
      -  ]
      -}
    • removedOutput schema / properties / integrations
      Removed value: -{
      -  "items": {
      -    "properties": {
      -      "failedRecords": {
      -        "type": "integer"
      -      },
      -      "id": {
      -        "format": "uuid",
      -        "type": "string"
      -      },
      -      "lastSyncStartedAt": {
      -        "format": "date-time",
      -        "type": [
      -          "string",
      -          "null"
      -        ]
      -      },
      -      "name": {
      -        "type": "string"
      -      },
      -      "recordsWritten": {
      -        "type": "integer"
      -      },
      -      "syncs": {
      -        "type": "integer"
      -      },
      -      "waitingRecords": {
      -        "type": "integer"
      -      }
      -    },
      -    "required": [
      -      "id",
      -      "name",
      -      "syncs",
      -      "recordsWritten",
      -      "failedRecords",
      -      "waitingRecords",
      -      "lastSyncStartedAt"
      -    ],
      -    "type": "object"
      -  },
      -  "type": "array"
      -}
    • removedOutput schema / properties / moreInformationUrl
      Removed value: -{
      -  "type": [
      -    "string",
      -    "null"
      -  ]
      -}
    • removedOutput schema / properties / outcome
      Removed value: -{
      -  "enum": [
      -    "answered",
      -    "noActivePlan",
      -    "notFound",
      -    "noIntegrations"
      -  ],
      -  "type": "string"
      -}
    • addedOutput schema / properties / recentSyncs
      Added value: +{
      +  "properties": {
      +    "integrationId": {
      +      "format": "uuid",
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "integrationName": {
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "moreInformationUrl": {
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "outcome": {
      +      "enum": [
      +        "answered",
      +        "noActivePlan",
      +        "notFound",
      +        "noIntegrations"
      +      ],
      +      "type": "string"
      +    },
      +    "summary": {
      +      "type": "string"
      +    },
      +    "syncs": {
      +      "items": {
      +        "properties": {
      +          "direction": {
      +            "type": "string"
      +          },
      +          "failed": {
      +            "type": "integer"
      +          },
      +          "finishedAt": {
      +            "format": "date-time",
      +            "type": [
      +              "string",
      +              "null"
      +            ]
      +          },
      +          "read": {
      +            "type": "integer"
      +          },
      +          "recordTypes": {
      +            "items": {
      +              "properties": {
      +                "completed": {
      +                  "type": "boolean"
      +                },
      +                "direction": {
      +                  "type": "string"
      +                },
      +                "failed": {
      +                  "type": "integer"
      +                },
      +                "read": {
      +                  "type": "integer"
      +                },
      +                "recordType": {
      +                  "type": "string"
      +                },
      +                "skipReasons": {
      +                  "items": {
      +                    "properties": {
      +                      "reason": {
      +                        "type": "string"
      +                      },
      +                      "records": {
      +                        "type": "integer"
      +                      }
      +                    },
      +                    "required": [
      +                      "reason",
      +                      "records"
      +                    ],
      +                    "type": "object"
      +                  },
      +                  "type": "array"
      +                },
      +                "skipped": {
      +                  "type": "integer"
      +                },
      +                "stoppedBecause": {
      +                  "type": [
      +                    "string",
      +                    "null"
      +                  ]
      +                },
      +                "written": {
      +                  "type": "integer"
      +                }
      +              },
      +              "required": [
      +                "recordType",
      +                "direction",
      +                "completed",
      +                "read",
      +                "written",
      +                "skipped",
      +                "failed",
      +                "skipReasons",
      +                "stoppedBecause"
      +              ],
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "skipped": {
      +            "type": "integer"
      +          },
      +          "startedAt": {
      +            "format": "date-time",
      +            "type": "string"
      +          },
      +          "state": {
      +            "type": "string"
      +          },
      +          "written": {
      +            "type": "integer"
      +          }
      +        },
      +        "required": [
      +          "startedAt",
      +          "finishedAt",
      +          "state",
      +          "direction",
      +          "read",
      +          "written",
      +          "skipped",
      +          "failed",
      +          "recordTypes"
      +        ],
      +        "type": "object"
      +      },
      +      "type": "array"
      +    }
      +  },
      +  "required": [
      +    "outcome",
      +    "summary",
      +    "integrationId",
      +    "integrationName",
      +    "syncs",
      +    "moreInformationUrl"
      +  ],
      +  "type": [
      +    "object",
      +    "null"
      +  ]
      +}
    • removedOutput schema / properties / summary
      Removed value: -{
      -  "type": "string"
      -}
    • removedOutput schema / properties / totals
      Removed value: -{
      -  "properties": {
      -    "failedRecords": {
      -      "type": "integer"
      -    },
      -    "recordsWritten": {
      -      "type": "integer"
      -    },
      -    "syncs": {
      -      "type": "integer"
      -    },
      -    "waitingRecords": {
      -      "type": "integer"
      -    }
      -  },
      -  "required": [
      -    "syncs",
      -    "recordsWritten",
      -    "failedRecords",
      -    "waitingRecords"
      -  ],
      -  "type": "object"
      -}
    • removedOutput schema / properties / waiting
      Removed value: -{
      -  "items": {
      -    "properties": {
      -      "integrationId": {
      -        "format": "uuid",
      -        "type": "string"
      -      },
      -      "integrationName": {
      -        "type": "string"
      -      },
      -      "recordType": {
      -        "type": "string"
      -      },
      -      "records": {
      -        "type": "integer"
      -      },
      -      "waitingOn": {
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "integrationId",
      -      "integrationName",
      -      "recordType",
      -      "waitingOn",
      -      "records"
      -    ],
      -    "type": "object"
      -  },
      -  "type": "array"
      -}
    • changedOutput schema / required
      Previous value: -[
      -  "outcome",
      -  "summary",
      -  "days",
      -  "integrationId",
      -  "totals",
      -  "integrations",
      -  "failures",
      -  "waiting",
      -  "moreInformationUrl"
      -]New value: +[
      +  "health",
      +  "recentSyncs",
      +  "conflicts",
      +  "conflictsNotRead"
      +]
  2. First observed

TDQS

A4.6/5.0
Behavior4/5

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

Annotations already declare readOnlyHint/idempotentHint/destructiveHint=false, so the bar is lower, yet the description still adds real context: failure reasons never quote record contents, conflict names are only visible to a user permitted to manage integrations, and 'include' only applies with an integration_id. It stops short of noting rate limits or pagination across the 30-day window.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded with the trigger scenario and tightly packed, but several sentences are long nested clauses with heavy colon/semicolon chaining, which slows scanning. Every sentence does carry information, so the length is earned, just not optimally structured.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Output schema exists so return values need not be spelled out, yet the description still characterizes the payload (failures grouped by reason with counts per integration and record type, waiting records, totals, conflicts). With four optional params, permission caveats and explicit exclusions covered, an agent has everything needed to call it correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3, but the description goes further by explaining what each optional parameter unlocks (recent_syncs adds moment/outcome plus per-record-type read/written/skipped/failed counts; conflicts adds waiting conflicts) and by stating that integration_id is required for include to have effect.

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?

States a specific verb and resource ('get_sync_health' / integrations sync status) and immediately frames the caller scenario ('a signed in CRM Connector customer asks how their syncs are doing'). It also distinguishes itself from siblings by naming list_integrations, resolve_conflict and run_sync as the wrong tools for adjacent jobs.

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

Usage Guidelines5/5

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

Explicit when-to-use (questions about failures, missing records, waiting items, last run, pending conflicts), explicit when-not ('Not for listing integrations', 'not for fixing anything'), and explicit routing to the alternatives with the condition that selects each. Nothing is left to inference.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources