diff --git a/docs/product/sentry-mcp/index.mdx b/docs/product/sentry-mcp/index.mdx index 8824381bac31b..d69fb7bc48ddb 100644 --- a/docs/product/sentry-mcp/index.mdx +++ b/docs/product/sentry-mcp/index.mdx @@ -5,8 +5,10 @@ description: "Enable secure connectivity between Sentry issues and debugging dat --- - 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 - [GitHub](https://github.com/getsentry/sentry-mcp/issues) if you have any feedback or concerns. + 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 [GitHub](https://github.com/getsentry/sentry-mcp/issues) + if you have any feedback or concerns. ## Overview @@ -45,18 +47,21 @@ For clients that support OAuth, you can use the streamlined configuration that p ``` This configuration: + - Enables OAuth authentication with your Sentry organization - Uses Streamable HTTP transport with automatic SSE fallback - Provides access to all 16+ available tools - Automatically handles authentication and session management With OAuth configuration, you'll be prompted to: + 1. Accept the OAuth authorization 2. Login via your existing Sentry organization 3. Grant access to the necessary permissions - If you've joined a new Sentry organization, log out of your LLM's MCP integration and log back in to refresh access. + If you've joined a new Sentry organization, log out of your LLM's MCP + integration and log back in to refresh access. Once authenticated, you'll see the tools become available in your MCP client. @@ -72,11 +77,7 @@ For clients that don't support OAuth, you can continue using the existing Remote "mcpServers": { "Sentry": { "command": "npx", - "args": [ - "-y", - "mcp-remote@latest", - "https://mcp.sentry.dev/mcp" - ] + "args": ["-y", "mcp-remote@latest", "https://mcp.sentry.dev/mcp"] } } } @@ -87,6 +88,7 @@ For clients that don't support OAuth, you can continue using the existing Remote 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. To use STDIO mode, you'll need a Sentry User Auth Token with the following scopes: + - `org:read` - `project:read` - `project:write` @@ -101,6 +103,7 @@ npx @sentry/mcp-server@latest --access-token=sentry-user-token --host=sentry.exa ``` You can also use environment variables: + ```bash SENTRY_ACCESS_TOKEN=your-token SENTRY_HOST=your-sentry-host @@ -108,7 +111,7 @@ SENTRY_HOST=your-sentry-host ### mcp.sentry.dev (live demo) -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. +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. ![Sentry MCP live demo](./img/mcpdev.png) @@ -117,6 +120,7 @@ The [Sentry MCP page](https://mcp.sentry.dev) provides a simple way to configure The Sentry MCP Server provides comprehensive tools for interacting with Sentry data: ### Core Tools + - **Organizations**: List and query organization information - **Projects**: Find, list, and create projects - **Teams**: Manage and query team information @@ -124,11 +128,13 @@ The Sentry MCP Server provides comprehensive tools for interacting with Sentry d - **DSNs**: List and create Data Source Names for projects ### Analysis Tools + - **Error Searching**: Find errors in specific files or across projects - **Issue Analysis**: Detailed issue investigation with context - **Seer Integration**: Invoke Sentry's AI agent for root cause analysis and automated fixes ### Advanced Features + - **Release Management**: Query and analyze release information - **Performance Monitoring**: Access transaction and performance data - **Custom Queries**: Execute complex searches across Sentry data @@ -147,34 +153,55 @@ Here are some example prompts you can use with the Sentry MCP: ![Sentry MCP using Autofix](./img/mcp-autofix1.png) -## Verified Clients +## Verified Clients -The Sentry MCP Server has been verified to work in: +The Sentry MCP Server has been verified to work in: -### Claude for Desktop +### Claude for Desktop Access developer tools via `CMD + ,` → `Developer` → `Edit Config` → edit the `claude_desktop_config.json` file -### Claude.ai +### Claude.ai Navigate to `Settings` → `Profile` → Scroll to `Integrations`, select `Add More`, and add the Sentry MCP server URL `https://mcp.sentry.dev/mcp` -### Claude Code +### Claude Code + +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`. + +Once in, you'll be prompted to authenticate with OAuth to Sentry. -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`. +### Codex -Once in, you'll be prompted to authenticate with OAuth to Sentry. +From your CLI, enter `codex mcp add sentry -- npx -y mcp-remote@latest https://mcp.sentry.dev/mcp` and then access Codex with `codex`. + +Once in, you'll be prompted to authenticate with Sentry using OAuth. ### Cursor 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. -You can still edit the `mcp.json` file manually if you prefer. +You can still edit the `mcp.json` file manually if you prefer. ### VS Code and GitHub Copilot Add the server using `CMD+Shift+P` and selecting `MCP: Add Server` +### Warp + +Available via `Settings` -> `MCP Servers` -> `Manage MCP Servers` -> `Add MCP Server` -> `Sentry` -> `https://mcp.sentry.dev/mcp`. + +```json +{ + "Sentry": { + "command": "npx", + "args": ["-y", "mcp-remote@latest", "https://mcp.sentry.dev/mcp"], + "env": {}, + "working_directory": null + } +} +``` + ### Windsurf Configure via the `Configure MCP` option in Cascade (CMD + L) @@ -182,6 +209,7 @@ Configure via the `Configure MCP` option in Cascade (CMD + L) ### Other Clients The Sentry MCP Server follows standard MCP protocols and should work with any client that supports: + - OAuth authentication (recommended) - Remote MCP servers - SSE or Streamable HTTP transport @@ -201,19 +229,21 @@ The Sentry MCP Server provides seamless integration with [Seer](/product/ai-in-s ### Common Issues **OAuth Authentication Problems** + - Ensure your client supports OAuth authentication - Try the legacy Remote MCP configuration if OAuth isn't working - Check that you have the necessary permissions in your Sentry organization **Connection Issues** + - Verify the MCP server URL is correct: `https://mcp.sentry.dev/mcp` - For legacy setups, use: `https://mcp.sentry.dev/sse` - Check your client's MCP configuration syntax **Missing Tools** + - Ensure authentication completed successfully - Verify your Sentry organization access - Check for any error messages in your client's console For additional support, visit the [GitHub repository](https://github.com/getsentry/sentry-mcp) or contact Sentry support. -