Check a consumer against a producer
check_compatibilityCheck a consumer service's calls against a producer's operations: missing or unused operations, plus stored type verdicts (coverage in type_verdicts). Read status first. It reads compatible, incompatible, partially_checked, or unresolved where nothing was compared, and pairs_compared and pairs_uncompared say how much of the pair the check reached. Call it before removing or changing any route, shape, field, or event. Consumers that reach the producer through a published SDK package have no call site of their own and are listed separately in via_sdk, never merged into the direct pairs. For whole-project topology, use get_service_graph first. To read both sides' types for the operations a verdict names, use get_contract_pair. Reference: https://docs.carrick.tools/mcp-tools
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"consumer_service": "<consumer_service>",
"producer_service": "<producer_service>"
},
"name": "check_compatibility"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| path | No | Filter by HTTP path, GraphQL field, or socket event name. A `{field=value}` dispatch suffix narrows to one case. On a large pair this is what narrows the answer; paging alone cannot. | |
| repo | No | Your repo as owner/repo (git remote) or just the repo name. Resolves which Carrick project to query. | |
| limit | No | Issue rows per page (default 50, max 200). Errors come first; issue_counts counts every category. A page is cut further when the response would be too long to read inline. | |
| method | No | Filter by operation label: HTTP method (GET, POST), GraphQL kind (QUERY, MUTATION), or socket direction (CLIENT->SERVER, SERVER->CLIENT, UNKNOWN). UNKNOWN also selects HTTP routes whose verb the scan could not read; each row names its protocol. | |
| offset | No | Issue rows to skip (default 0). Pass the `next_offset` from a previous call to page through. | |
| project | No | Carrick project slug to query. Omit to auto-resolve via `repo`, or omit both when the workspace has one project. | |
| consumer_service | Yes | The service making API calls | |
| producer_service | Yes | The service exposing endpoints |