Skip to content

Commit d8d6535

Browse files
codydesfanahatacoolguyzone
authored
(feat) Sentry MCP Documentation (#13524)
## DESCRIBE YOUR PR Adding basic documentation for the Sentry MCP server ## IS YOUR CHANGE URGENT? Help us prioritize incoming PRs by letting us know when the change needs to go live. - [X] Urgent deadline (GA date, etc.): 4/28 --------- Co-authored-by: Shannon Anahata <[email protected]> Co-authored-by: Alex Krawiec <[email protected]>
1 parent 7a2db7b commit d8d6535

File tree

4 files changed

+79
-0
lines changed

4 files changed

+79
-0
lines changed
539 KB
Loading
387 KB
Loading
458 KB
Loading

docs/product/sentry-mcp/index.mdx

+79
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
---
2+
title: Sentry's MCP Server
3+
sidebar_order: 120
4+
description: "Enable secure connectivity between Sentry issues and debugging data, and LLM clients, using a Model Context Protocol (MCP) server."
5+
---
6+
7+
<Alert>
8+
The Sentry MCP Server is currently in **beta**. Beta features are still a work in progress and may have bugs. Please reach out on
9+
[GitHub](https://github.com/getsentry/sentry-mcp/issues) if you have any feedback or concerns.
10+
</Alert>
11+
12+
## Overview
13+
14+
The[ Sentry MCP Server](https://mcp.sentry.dev) provides a secure way of bringing Sentry's full issue context into systems that are able to leverage the [Model Context Protocol (MCP)](https://modelcontextprotocol.io/introduction). Sentry hosts and manages a remote MCP server, which you can connect to and leverage centrally. With the MCP, you can:
15+
16+
- Access Sentry issues and errors
17+
- Search for errors in specific files
18+
- Query projects and organizations
19+
- List and create Sentry DSN's for projects
20+
- Execute autofix runs and retrieve autofix status and details
21+
22+
![Sentry MCP Server Query in Claude](./img/mcp-light-1.png)
23+
24+
## Getting Started
25+
26+
Most clients that natively support MCP can be configured using a mcp_config.json file or an equivalent. In these systems, adding the server configuration to the file will setup an MCP server:
27+
28+
```json
29+
{
30+
"mcpServers": {
31+
"Sentry": {
32+
"command": "npx",
33+
"args": [
34+
"mcp-remote",
35+
"https://mcp.sentry.dev/sse"
36+
]
37+
}
38+
}
39+
}
40+
```
41+
42+
This setup uses the Remote-MCP server configuration, enabling most clients to connect to the Sentry MCP, authenticate via OAuth, and access the available tools.
43+
44+
Alternatively, if you don't want the Remote-MCP server, you can run the MCP Server locally in STDIO mode by following the instructions in the [README](https://github.com/getsentry/sentry-mcp).
45+
46+
Once configured via one of these methods, you'll be able to view the available tools within your client and use them as part of your LLM calls.
47+
48+
![Available Sentry MCP Tools](./img/mcp-tools.png)
49+
50+
## Example Calls
51+
52+
- Tell me about the issues in my `project`
53+
- Check Sentry for errors in `file.tsx` and propose solutions.
54+
- Diagnose issue `issue id` and propose solutions.
55+
- Create a new project in Sentry for `service-name` and setup local instrumentation using it.
56+
- Use Sentry's autofix feature, and help me analyze and propose a solution for `issue id`.
57+
58+
![Sentry MCP using Autofix](./img/mcp-autofix1.png)
59+
60+
## Verified Clients
61+
62+
The Sentry MCP Server has been verified to work in:
63+
64+
### Claude for Desktop
65+
66+
By accessing the developer tools via `CMD + ,` -> `Developer` -> `Edit Config` -> edit the `claude_desktop_config.json` file
67+
68+
### Windsurf
69+
70+
Via the `Configure MCP` option in Cascade (CMD + L)
71+
72+
### Cursor
73+
74+
Via the `Cursor` -> `Settings` -> `Cursor Settings` -> `MCP` and editing the `mcp.json` file
75+
76+
### VS Code and GitHub Copilot
77+
78+
By adding the server in `CMD+Shift+P` and selecting `MCP: Add Server`
79+

0 commit comments

Comments
 (0)