DiffiCat

Get report

get_report

Read-onlyIdempotent

The finished report. Call it first with failedOnly: true and view: "digest": only the failed pages, each with its issues, diff percentage and largest regions, and a text line per page; summary covers every page. check_page and diff_deploy return the first regressed region's image; get_screenshot (?surface=full) fetches a region by filename. Without view, results are { path, status, failedChecks }; responseFormat: "detailed" returns per-check fields. offset and limit page through results (default 50, at most 5000; nextOffset is next); limit: 1 returns the summary alone; includeText: true adds the plain-text report. A change whose flakyShare is at least 0.5 is likely the page moving on its own: mask its fingerprint's element (visual.masks), not a regression. Call wait_for_comparison first. Free.

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": {
      "jobId": "<jobId>"
    },
    "name": "get_report"
  }
}

Input Schema

Name	Required	Description
`view`	No	full (default): every page result with its diffs, screenshots and text; digest: one small object per page (status, failed checks, issues, diff percentage), no text.
`jobId`	Yes	Returned at job creation, e.g. web-1a2b3c.
`limit`	No	Page results to return (at most 5000; default 1000 on REST, 50 over MCP).
`offset`	No	Index of the first page result to return (default 0).
`jobToken`	No	Returned at job creation; optional when the HTTP headers carry the key that paid the job.
`failedOnly`	No	Only failed pages in results, total, nextOffset and text; summary still covers every page.
`includeText`	No	Also put the text block in structuredContent.text.
`responseFormat`	No	concise (default): each result is { path, status, failedChecks }, plus snapshots when a side came from one; detailed: every per-check field, diff and screenshot name.

Output Schema

Name	Required	Description	Default
`code`	No
`text`	No
`error`	No
`jobId`	No
`total`	No
`status`	No
`results`	No
`summary`	No
`cancelled`	No
`followUps`	No
`nextOffset`	No

Schema Changelog

Changes observed during successful MCP inspections.

Changed6 schema fields changedNov 7, 2026

changedInput schema / properties / failedOnly / description

Previous value: -"Only pages whose status is fail: results, total, nextOffset and text then cover the failed pages alone, while summary still covers every page."New value: +"Only failed pages in results, total, nextOffset and text; summary still covers every page."

changedInput schema / properties / includeText / description

Previous value: -"Also return the plain-text report over the slice as structuredContent.text; the text block carries it either way."New value: +"Also put the text block in structuredContent.text."

changedInput schema / properties / jobId / description

Previous value: -"The jobId returned when the job was created, e.g. web-1a2b3c or cmp-1a2b3c."New value: +"Returned at job creation, e.g. web-1a2b3c."

changedInput schema / properties / jobToken / description

Previous value: -"The jobToken returned when the job was created. Optional when the request’s HTTP headers carry the key that paid the job."New value: +"Returned at job creation; optional when the HTTP headers carry the key that paid the job."

changedInput schema / properties / responseFormat / description

Previous value: -"concise (default): each result is { path, status, failedChecks }, plus snapshots when a side was read from a stored snapshot; detailed: the full per-check fields, diffs and screenshot names of every result."New value: +"concise (default): each result is { path, status, failedChecks }, plus snapshots when a side came from one; detailed: every per-check field, diff and screenshot name."

changedInput schema / properties / view / description

Previous value: -"full (default) returns every page result with its diffs and screenshots plus text; digest returns one small object per page (status, failed checks, issues, diff percentage) and no text. Combine digest with failedOnly=true to keep the response small."New value: +"full (default): every page result with its diffs, screenshots and text; digest: one small object per page (status, failed checks, issues, diff percentage), no text."

Changed1 schema field changedNov 2, 2026

addedOutput schema / properties / followUps

Added value: +{
+  "items": {
+    "type": "string"
+  },
+  "type": "array"
+}

Changed6 schema fields changedOct 25, 2026

changedInput schema / $schema

Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"

changedInput schema / properties / jobId / description

Previous value: -"The jobId returned when the job was created, e.g. web-1a2b3c."New value: +"The jobId returned when the job was created, e.g. web-1a2b3c or cmp-1a2b3c."

changedInput schema / properties / jobId / pattern

Previous value: -"^web-[a-z0-9-]+$"New value: +"^(?:web|cmp)-[a-z0-9-]+$"

changedInput schema / properties / responseFormat / description

Previous value: -"concise (default): each result is { path, status, failedChecks }; detailed: the full per-check fields, diffs and screenshot names of every result."New value: +"concise (default): each result is { path, status, failedChecks }, plus snapshots when a side was read from a stored snapshot; detailed: the full per-check fields, diffs and screenshot names of every result."

changedOutput schema / $schema

Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"

changedOutput schema / properties / results / items / anyOf

Previous value: -[
-  {
-    "additionalProperties": false,
-    "properties": {
-      "failedChecks": {
-        "items": {
-          "type": "string"
-        },
-        "type": "array"
-      },
-      "path": {
-        "type": "string"
-      },
-      "status": {
-        "type": "string"
-      }
-    },
-    "required": [
-      "path",
-      "status",
-      "failedChecks"
-    ],
-    "type": "object"
-  },
-  {
-    "additionalProperties": {},
-    "propertyNames": {
-      "type": "string"
-    },
-    "type": "object"
-  }
-]New value: +[
+  {
+    "additionalProperties": false,
+    "properties": {
+      "failedChecks": {
+        "items": {
+          "type": "string"
+        },
+        "type": "array"
+      },
+      "path": {
+        "type": "string"
+      },
+      "snapshots": {
+        "additionalProperties": false,
+        "properties": {
+          "a": {
+            "additionalProperties": false,
+            "properties": {
+              "n": {
+                "type": "number"
+              },
+              "snapshotId": {
+                "type": "string"
+              }
+            },
+            "required": [
+              "snapshotId",
+              "n"
+            ],
+            "type": "object"
+          },
+          "b": {
+            "additionalProperties": false,
+            "properties": {
+              "n": {
+                "type": "number"
+              },
+              "snapshotId": {
+                "type": "string"
+              }
+            },
+            "required": [
+              "snapshotId",
+              "n"
+            ],
+            "type": "object"
+          }
+        },
+        "type": "object"
+      },
+      "status": {
+        "type": "string"
+      }
+    },
+    "required": [
+      "path",
+      "status",
+      "failedChecks"
+    ],
+    "type": "object"
+  },
+  {
+    "additionalProperties": {},
+    "propertyNames": {
+      "type": "string"
+    },
+    "type": "object"
+  }
+]

Changed7 schema fields changedOct 4, 2026

changedInput schema / properties / jobToken / description

Previous value: -"The jobToken returned when the job was created. Optional when the request carries the prepaid key that paid the job (Authorization: Bearer dck_…)."New value: +"The jobToken returned when the job was created. Optional when the request’s HTTP headers carry the key that paid the job."

addedInput schema / properties / responseFormat

Added value: +{
+  "description": "concise (default): each result is { path, status, failedChecks }; detailed: the full per-check fields, diffs and screenshot names of every result.",
+  "enum": [
+    "concise",
+    "detailed"
+  ],
+  "type": "string"
+}

addedInput schema / properties / view

Added value: +{
+  "description": "full (default) returns every page result with its diffs and screenshots plus text; digest returns one small object per page (status, failed checks, issues, diff percentage) and no text. Combine digest with failedOnly=true to keep the response small.",
+  "enum": [
+    "full",
+    "digest"
+  ],
+  "type": "string"
+}

removedOutput schema / properties / results / items / additionalProperties
```
Removed value: -{}
```

addedOutput schema / properties / results / items / anyOf

Added value: +[
+  {
+    "additionalProperties": false,
+    "properties": {
+      "failedChecks": {
+        "items": {
+          "type": "string"
+        },
+        "type": "array"
+      },
+      "path": {
+        "type": "string"
+      },
+      "status": {
+        "type": "string"
+      }
+    },
+    "required": [
+      "path",
+      "status",
+      "failedChecks"
+    ],
+    "type": "object"
+  },
+  {
+    "additionalProperties": {},
+    "propertyNames": {
+      "type": "string"
+    },
+    "type": "object"
+  }
+]

removedOutput schema / properties / results / items / propertyNames
```
Removed value: -{
-  "type": "string"
-}
```
removedOutput schema / properties / results / items / type
```
Removed value: -"object"
```

Changed1 schema field changedOct 4, 2026

changedInput schema / properties / limit / description

Previous value: -"Page results to return (default 1000, at most 5000)."New value: +"Page results to return (at most 5000; default 1000 on REST, 50 over MCP)."

Changed1 schema field changedSep 30, 2026
- addedInput schema / properties / jobId / description
```
Added value: +"The jobId returned when the job was created, e.g. web-1a2b3c."
```

Changed2 schema fields changedSep 29, 2026

addedInput schema / properties / includeText

Added value: +{
+  "description": "Also return the plain-text report over the slice as structuredContent.text; the text block carries it either way.",
+  "type": "boolean"
+}

changedOutput schema / (root)

Previous value: -nullNew value: +{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "additionalProperties": false,
+  "properties": {
+    "cancelled": {
+      "type": "boolean"
+    },
+    "code": {
+      "type": "string"
+    },
+    "error": {
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "jobId": {
+      "type": "string"
+    },
+    "nextOffset": {
+      "maximum": 9007199254740991,
+      "minimum": -9007199254740991,
+      "type": "integer"
+    },
+    "results": {
+      "items": {
+        "additionalProperties": {},
+        "propertyNames": {
+          "type": "string"
+        },
+        "type": "object"
+      },
+      "type": "array"
+    },
+    "status": {
+      "type": "string"
+    },
+    "summary": {
+      "additionalProperties": {},
+      "propertyNames": {
+        "type": "string"
+      },
+      "type": "object"
+    },
+    "text": {
+      "type": "string"
+    },
+    "total": {
+      "maximum": 9007199254740991,
+      "minimum": -9007199254740991,
+      "type": "integer"
+    }
+  },
+  "type": "object"
+}

Changed1 schema field changedSep 29, 2026

addedInput schema / properties / failedOnly

Added value: +{
+  "description": "Only pages whose status is fail: results, total, nextOffset and text then cover the failed pages alone, while summary still covers every page.",
+  "type": "boolean"
+}

Changed2 schema fields changedSep 27, 2026

changedInput schema / properties / jobToken / description

Previous value: -"The jobToken returned when the job was created."New value: +"The jobToken returned when the job was created. Optional when the request carries the prepaid key that paid the job (Authorization: Bearer dck_…)."

changedInput schema / required

Previous value: -[
-  "jobId",
-  "jobToken"
-]New value: +[
+  "jobId"
+]

Changed2 schema fields changedSep 26, 2026

addedInput schema / properties / limit

Added value: +{
+  "description": "Page results to return (default 1000, at most 5000).",
+  "maximum": 9007199254740991,
+  "minimum": 1,
+  "type": "integer"
+}

addedInput schema / properties / offset

Added value: +{
+  "description": "Index of the first page result to return (default 0).",
+  "maximum": 9007199254740991,
+  "minimum": 0,
+  "type": "integer"
+}

First observedSep 25, 2026

TDQS

A4.5/5.0

Behavior5/5

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

Annotations already declare readOnly/idempotent/non-destructive, so the safety profile is covered. The description adds genuinely non-obvious behavior: what digest returns per page, that 'summary covers every page' even with failedOnly, that 'limit: 1 returns the summary alone', paging defaults and the nextOffset contract, and that the call is 'Free'. The flakyShare >= 0.5 guidance (mask the fingerprint's element in visual.masks rather than treating it as a regression) is operational knowledge an agent could not derive from the schema.

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?

Nearly every clause carries distinct information — views, paging, flaky handling, prerequisites — with no filler. Structure is the weak point: it opens with a fragment and packs return-shape, sibling routing and a statistical heuristic into one dense paragraph, and 'Call wait_for_comparison first. Free.' sits at the tail where prerequisites usually belong up front.

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?

For an 8-parameter tool with an output schema, the description still covers the things the schema cannot: prerequisite ordering, digest vs full mode output, paging defaults, text inclusion, and the flaky-movement interpretation rule. Nothing an agent needs to call this correctly — jobId provenance, token optionality, cost, or pagination termination via nextOffset — is missing.

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 numeric defaults and enum meanings are already documented; the baseline would be 3. The description earns above baseline by explaining emergent behavior not visible in the schema, notably that limit: 1 collapses the result to the summary alone and that failedOnly leaves the summary spanning every page. It does not add much on jobToken or jobId beyond the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description names the resource ('the finished report') and immediately constrains it with the jobId-driven views and result shape, so an agent knows this reads a completed comparison report. It falls short of a 5 because the opening is a bare noun fragment with no verb ('retrieves/returns'), so the action is inferred rather than stated. Sibling differentiation is still strong: check_page and diff_deploy are explicitly described as returning 'the first regressed region's image' versus this tool's full page results.

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 ordering and configuration guidance is given: 'Call it first with failedOnly: true and view: "digest"' and 'Call wait_for_comparison first.' Alternatives are named with the condition that selects them: check_page/diff_deploy for a single regressed region image, get_screenshot (?surface=full) to fetch a region by filename. When-to-use, when-not-to-use, and alternatives are all present.

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

All DiffiCat tools Inspect

Try in Browser

One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources

Need Help?