docs(snapshots): Add agentic workflow page#17939
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
Add a Snapshots child page that explains how to use Sentry MCP for agent-assisted snapshot investigation. Cover setup, Preprod Snapshots tool selection, snapshot URL handling, primitive snapshot tools, and when to use CLI workflows instead. Co-Authored-By: Claude Code Opus <noreply@example.com>
cameroncooke
force-pushed
the
cameroncooke/docs/snapshots-agentic-workflow
branch
from
59371a5 to
2c71066
Compare
|
|
||
| ### Advanced Snapshot Tools (Optional) | ||
|
|
||
| For most investigations the agent needs no extra setup. By default, it can read any snapshot URL and return the diff summary plus a changed image's current, base, and diff-mask previews. |
There was a problem hiding this comment.
doesn't the mcp need Preprod Snapshots to get the images?
There was a problem hiding this comment.
@mtopo27 no you don't need it, agent can use get_sentry_resource to get snapshots and images, preprod snapshots is opt-in and adds snapshot primitive tools., this give the agent slightly more control and allows us to future proof things in case we want to add more leavers.
|
|
||
| Connect an AI coding assistant to Sentry's MCP server so it can pull snapshot diffs, images, and baselines on your behalf. This lets you investigate snapshot failures by asking the agent, instead of clicking through the Sentry UI or downloading images by hand. It complements the [local CLI workflow](/product/snapshots/local-testing/): MCP is built for agent-assisted investigation and review, while `sentry-cli` is built for local downloads and diffing. | ||
|
|
||
| ## Set Up Sentry MCP |
There was a problem hiding this comment.
i think it's worth clarifying that you can use the Sentry MCP or achieve similar functionality through the REST API + CLI. We don't have to map every single MCP tool <> API call, but some reference is warranted. RN it seems like the only way to use the agentic workflow is via the MCP which isn't true
There was a problem hiding this comment.
@mtopo27 Can do, I didn't because I don't think agents calling APIs directly is an optimal use-case. Also agents can't authenticate requests, so user would have to create access token environmental variables that the agent could pass as the bearer token. Agents won't accept raw access tokens for security reasons. So you can't just ask you agent to connect to said API, needs human intervention.
There was a problem hiding this comment.
Fair, but I think letting people know something like "The Sentry MCP has been optimized to retrieve Snapshot results. If you'd like, you can also fetch the data via the REST API and expose scripts to agents"... (something like that)
There was a problem hiding this comment.
with link to the rest api root page https://docs.sentry.io/api/snapshots/
2 participants
DESCRIBE YOUR PR
Adds a new Snapshots documentation page, Agentic Workflow, covering how to use Sentry's MCP server to investigate snapshot results with an AI coding assistant (Claude Code, Cursor, VS Code, and others) instead of clicking through the Sentry UI or downloading images by hand.
get_sentry_resourceversus the advanced tools it unlocks (get_snapshot,get_snapshot_image,get_latest_base_snapshot), plus the context-window tradeoffsentry-cliand Local Testing for local download and diff workflowsThe page sits in the Snapshots section (
sidebar_order: 30) and is gated behind the Early Adopter include. Tool names, parameters, and the example responses were verified against the live Sentry MCP server.IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes: