Skip to content

Commit 73b524a

Browse files
codydebitsandfoxes
authored andcommitted
MCP Docs: Update for OAuth configs, web client, troubleshooting details. (#14142)
Updating Sentry MCP docs - * New configs for OAuth * Details for additional clients like Claude Code, additions for Cursor 1.0, and mcp.sentry.dev web client * Additional troubleshooting details * Bringing additional content from mcp landing page
1 parent 0eb92c5 commit 73b524a

File tree

2 files changed

+157
-27
lines changed

2 files changed

+157
-27
lines changed
1.91 MB
Loading

docs/product/sentry-mcp/index.mdx

Lines changed: 157 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: "Enable secure connectivity between Sentry issues and debugging dat
55
---
66

77
<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
8+
The Sentry MCP Server has been released for production, however MCP is a developing technology and changes should be expected. There will be bugs. Please reach out on
99
[GitHub](https://github.com/getsentry/sentry-mcp/issues) if you have any feedback or concerns.
1010
</Alert>
1111

@@ -19,67 +19,197 @@ The [Sentry MCP Server](https://mcp.sentry.dev) provides a secure way of bringin
1919
- List and create Sentry DSN's for projects
2020
- Invoke Seer to automatically fix issues and retrieve the status and details of an issue fix
2121

22+
The Sentry MCP Server includes support for modern MCP features:
23+
24+
- **Remote hosted (preferred) or local STDIO mode** - The hosted version provides lower friction and always includes the latest functionality and stability
25+
- **OAuth support** - Authenticate using your existing Sentry organization for seamless access to your projects
26+
- **Streamable HTTP with graceful SSE fallback** - Automatic fallback ensures compatibility across different clients
27+
- **16+ tool calls and prompts** - Comprehensive toolset for bringing Sentry context into LLM interactions
28+
2229
<VimeoEmbed id="1080588938?h=1e437d4874" />
2330

2431
## Getting Started
2532

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:
33+
### OAuth Configuration (Recommended)
34+
35+
For clients that support OAuth, you can use the streamlined configuration that provides automatic authentication:
2736

2837
```json
2938
{
30-
"mcpServers": {
31-
"Sentry": {
32-
"command": "npx",
33-
"args": [
34-
"mcp-remote@latest",
35-
"https://mcp.sentry.dev/sse"
36-
]
37-
}
39+
"mcpServers": {
40+
"Sentry": {
41+
"url": "https://mcp.sentry.dev/mcp"
3842
}
43+
}
3944
}
4045
```
4146

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.
47+
This configuration:
48+
- Enables OAuth authentication with your Sentry organization
49+
- Uses Streamable HTTP transport with automatic SSE fallback
50+
- Provides access to all 16+ available tools
51+
- Automatically handles authentication and session management
4352

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).
53+
With OAuth configuration, you'll be prompted to:
54+
1. Accept the OAuth authorization
55+
2. Login via your existing Sentry organization
56+
3. Grant access to the necessary permissions
4557

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.
58+
Once authenticated, you'll see the tools become available in your MCP client.
4759

4860
![Available Sentry MCP Tools](./img/mcp-tools.png)
4961

50-
## Example Calls
62+
### Remote MCP Configuration (Legacy)
5163

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 Seer and help me analyze and propose a solution for `issue id`.
64+
For clients that don't support OAuth, you can continue using the existing Remote MCP endpoint configuration:
5765

58-
![Sentry MCP using Autofix](./img/mcp-autofix1.png)
66+
```json
67+
{
68+
"mcpServers": {
69+
"Sentry": {
70+
"command": "npx",
71+
"args": [
72+
"-y",
73+
"mcp-remote@latest",
74+
"https://mcp.sentry.dev/mcp"
75+
]
76+
}
77+
}
78+
}
79+
```
80+
81+
### Local STDIO Mode
82+
83+
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). This is particularly useful for self-hosted Sentry installations.
84+
85+
To use STDIO mode, you'll need a Sentry User Auth Token with the following scopes:
86+
- `org:read`
87+
- `project:read`
88+
- `project:write`
89+
- `team:read`
90+
- `team:write`
91+
- `event:write`
92+
93+
Launch the STDIO transport:
94+
95+
```bash
96+
npx @sentry/mcp-server@latest --access-token=sentry-user-token --host=sentry.example.com
97+
```
98+
99+
You can also use environment variables:
100+
```bash
101+
SENTRY_ACCESS_TOKEN=your-token
102+
SENTRY_HOST=your-sentry-host
103+
```
104+
105+
### mcp.sentry.dev (live demo)
106+
107+
The [Sentry MCP page](https://mcp.sentry.dev) provides a simple way to configure and test the MCP server. From this web client you can authenticate with your Sentry organization and access a hosted MCP server for testing.
108+
109+
![Sentry MCP live demo](./img/mcpdev.png)
110+
111+
## Available Tools
112+
113+
The Sentry MCP Server provides comprehensive tools for interacting with Sentry data:
114+
115+
### Core Tools
116+
- **Organizations**: List and query organization information
117+
- **Projects**: Find, list, and create projects
118+
- **Teams**: Manage and query team information
119+
- **Issues**: Access issue details, search, and analyze problems
120+
- **DSNs**: List and create Data Source Names for projects
121+
122+
### Analysis Tools
123+
- **Error Searching**: Find errors in specific files or across projects
124+
- **Issue Analysis**: Detailed issue investigation with context
125+
- **Seer Integration**: Invoke Sentry's AI agent for root cause analysis and automated fixes
59126

60-
TODO: Image needs to be updated
127+
### Advanced Features
128+
- **Release Management**: Query and analyze release information
129+
- **Performance Monitoring**: Access transaction and performance data
130+
- **Custom Queries**: Execute complex searches across Sentry data
131+
132+
## Example Usage
133+
134+
Here are some example prompts you can use with the Sentry MCP:
135+
136+
- Tell me about the issues in my `project-name`
137+
- Check Sentry for errors in `components/UserProfile.tsx` and propose solutions
138+
- Diagnose issue `PROJECT-123` and propose solutions
139+
- Create a new project in Sentry for `new-service-name` and setup local instrumentation
140+
- Use Sentry's Seer to analyze and propose a solution for issue `PROJECT-456`
141+
- Show me the most recent releases for my organization
142+
- Find all unresolved crashes in my React Native app
143+
144+
![Sentry MCP using Autofix](./img/mcp-autofix1.png)
61145

62146
## Verified Clients
63147

64148
The Sentry MCP Server has been verified to work in:
65149

66150
### Claude for Desktop
67151

68-
By accessing the developer tools via `CMD + ,` -> `Developer` -> `Edit Config` -> edit the `claude_desktop_config.json` file
152+
Access developer tools via `CMD + ,` `Developer` `Edit Config` edit the `claude_desktop_config.json` file
69153

70154
### Claude.ai
71155

72-
You can access the `Settings` -> `Profile` -> Scroll to `Integrations`, select `Add More`, and add the Sentry MCP server URL `https://mcp.sentry.dev/sse`
156+
Navigate to `Settings` `Profile` Scroll to `Integrations`, select `Add More`, and add the Sentry MCP server URL `https://mcp.sentry.dev/mcp`
73157

74-
### Windsurf
158+
### Claude Code
75159

76-
Via the `Configure MCP` option in Cascade (CMD + L)
160+
Since recently reaching 1.0, Claude Code has native support for remote hosted MCP servers. From your cli enter `claude mcp add --transport http sentry https://mcp.sentry.dev/mcp` and then access Claude Code with `claude`.
161+
162+
Once in, you'll be prompted to authenticate with OAuth to Sentry.
77163

78164
### Cursor
79165

80-
Via the `Cursor` -> `Settings` -> `Cursor Settings` -> `MCP` and editing the `mcp.json` file
166+
Available via `Cursor``Settings``Cursor Settings``MCP` following the promps to configure Sentry MCP. Cursor 1.0+ includes enhanced MCP support with OAuth and Streamable HTTP.
167+
168+
You can still edit the `mcp.json` file manually if you prefer.
81169

82170
### VS Code and GitHub Copilot
83171

84-
By adding the server in `CMD+Shift+P` and selecting `MCP: Add Server`
172+
Add the server using `CMD+Shift+P` and selecting `MCP: Add Server`
173+
174+
### Windsurf
175+
176+
Configure via the `Configure MCP` option in Cascade (CMD + L)
177+
178+
### Other Clients
179+
180+
The Sentry MCP Server follows standard MCP protocols and should work with any client that supports:
181+
- OAuth authentication (recommended)
182+
- Remote MCP servers
183+
- SSE or Streamable HTTP transport
184+
185+
## Integration with Seer
186+
187+
The Sentry MCP Server provides seamless integration with [Seer](/product/ai-in-sentry/seer/), Sentry's AI agent. You can:
188+
189+
- **Trigger Seer Analysis**: Initiate automated root cause analysis for issues
190+
- **Get Fix Recommendations**: Receive AI-generated solutions for bugs and performance issues
191+
- **Monitor Fix Status**: Track the progress of Seer's analysis and implementation
192+
193+
**Note**: MCP and Seer are complementary tools. MCP brings Sentry context into your LLM, while Seer is purpose-built for deep issue analysis and automated debugging. You can use MCP to invoke Seer for complex debugging workflows.
194+
195+
## Troubleshooting
196+
197+
### Common Issues
198+
199+
**OAuth Authentication Problems**
200+
- Ensure your client supports OAuth authentication
201+
- Try the legacy Remote MCP configuration if OAuth isn't working
202+
- Check that you have the necessary permissions in your Sentry organization
203+
204+
**Connection Issues**
205+
- Verify the MCP server URL is correct: `https://mcp.sentry.dev/mcp`
206+
- For legacy setups, use: `https://mcp.sentry.dev/sse`
207+
- Check your client's MCP configuration syntax
208+
209+
**Missing Tools**
210+
- Ensure authentication completed successfully
211+
- Verify your Sentry organization access
212+
- Check for any error messages in your client's console
213+
214+
For additional support, visit the [GitHub repository](https://github.com/getsentry/sentry-mcp) or contact Sentry support.
85215

0 commit comments

Comments
 (0)