Skip to main content
Glama
Sentry MCP

Sentry MCP

Official
by getsentry

Get Snapshot

get_snapshot
Read-only

Retrieve a preprod snapshot comparison by ID to inspect metadata, image counts, and changed images with pixel-difference percentages for failed visual regression or screenshot tests.

Instructions

Get a preprod snapshot comparison by ID, such as a failed visual regression or screenshot test from CI: its metadata, image counts, and changed images with the percent of pixels that differ. For an app's latest baseline screenshots, use get_latest_base_snapshot. For a snapshot URL, use get_sentry_resource.

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": {
      "snapshotId": "<snapshotId>"
    },
    "name": "get_snapshot"
  }
}

Input Schema

NameRequiredDescriptionDefault
freshNoBypass cached reads.
regionUrlNo
snapshotIdYesNumeric snapshot artifact ID.
showUnmodifiedNoAlso list unchanged and skipped images. Can make large snapshots much bigger.
organizationSlugNoThe organization slug, from `find_organizations`. In `org/project` notation, the part before the slash.

Output Schema

NameRequiredDescriptionDefault
urlYes
vcsYes
addedYes
stateYes
countsYes
imagesNoSnapshot image inventory, present only when nothing changed.
changedYes
erroredYes
removedYes
renamedYes
skippedNoPresent only when showUnmodified=true.
approvalYes
projectIdYes
unchangedNoPresent only when showUnmodified=true.
snapshotIdYes
responseNotesYes
comparisonTypeYes
organizationSlugYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv1.0.1

TDQS

A4.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false, and openWorldHint=true, so the safety profile is covered. The description adds that results are scoped to changed images with pixel-diff percentages, implying unchanged images are omitted by default, but it says nothing about auth/region requirements, caching behavior, or payload size limits beyond what the schema states.

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

Conciseness5/5

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

Three compact sentences: the core capability and return contents come first, followed by two routing rules. No filler, no repetition of the title, and the alternative-tool guidance is short enough to scan.

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

Completeness4/5

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

An output schema exists, so the description needn't document return structure, yet it still summarizes payload contents usefully. Annotations cover the safety profile and the schema covers all five parameters, leaving only minor gaps such as region/self-hosted handling and cache behavior for the agent to infer from schema text.

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

Parameters3/5

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

Schema coverage is 80%, so the schema already documents fresh, regionUrl, snapshotId, showUnmodified, and organizationSlug. The description only reinforces the snapshotId ('by ID') and hints that output focuses on changed images, which loosely relates to showUnmodified, but adds no new syntax or format guidance. Baseline 3 applies when the schema carries the parameter burden.

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 a preprod snapshot comparison by ID') and enumerates what it returns: metadata, image counts, and changed images with per-image pixel-difference percentages. It also names the two siblings an agent might confuse it with, so the tool is distinguishable without opening any schema.

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?

Gives explicit routing rules: use get_latest_base_snapshot for an app's latest baseline screenshots, and get_sentry_resource for a snapshot URL. The concrete CI scenario ('failed visual regression or screenshot test') supplies the positive condition for using this tool.

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