-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
feat(mcp-insights): product docs #14544
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
--- | ||
title: MCP Dashboard | ||
sidebar_order: 10 | ||
description: "Learn how to use Sentry's MCP Dashboard." | ||
--- | ||
|
||
<Include name="feature-limited-on-team-retention.mdx" /> | ||
|
||
Once you've [configured the Sentry SDK](/product/insights/ai/mcp/getting-started/) for your MCP project, you'll start receiving data in the Sentry [MCP Insights](https://sentry.io/orgredirect/organizations/:orgslug/insights/mcp/) dashboard. | ||
|
||
The main dashboard provides a comprehensive view of all your MCP server activities, performance metrics, and recent tool executions. | ||
|
||
 | ||
|
||
The dashboard displays key widgets like: | ||
|
||
- **Traffic**: Shows MCP requests over time, error rates, and releases to track overall server activity and health | ||
- **Traffic by Client**: Displays which MCP clients are connecting to your server (cursor-vscode, CustomMCPClient, etc.) | ||
- **Transport Distribution**: Shows the distribution of transport protocols used (http, sse, custom transports) | ||
- **Most Used Tools/Resources/Prompts**: Shows which MCP tools/resources/prompts are called most frequently by clients | ||
- **Slowest Tools/Resources/Prompts**: Identifies tools/resources/prompts with the highest response times for performance optimization | ||
- **Most Failing Tools/Resources/Prompts**: Highlights tools/resources/propmpts with the highest error rates that need attention | ||
|
||
Underneath these widgets are tables that allow you to view data in more detail: | ||
|
||
- **Tools**: Performance metrics for each MCP tool including request count, error rate, average duration, and P95 latency | ||
- **Resources**: Access patterns and performance for MCP resources by URI, showing requests, error rate, average duration, and P95 latency | ||
- **Prompts**: Usage statistics for MCP prompt templates by name, including requests, error rate, average duration, and P95 latency |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
--- | ||
title: Set Up | ||
sidebar_order: 0 | ||
description: "Learn how to set up Sentry MCP Monitoring" | ||
--- | ||
|
||
Sentry MCP Monitoring helps you track and debug Model Context Protocol (MCP) implementations using our supported SDKs and integrations. Monitor your complete MCP workflows from client connections to server responses, including tool executions, resource access, and protocol communications. | ||
|
||
To start sending MCP data to Sentry, make sure you've created a Sentry project for your MCP-enabled repository and follow the guide below: | ||
|
||
## Supported SDKs | ||
|
||
### JavaScript - MCP Server | ||
|
||
The Sentry JavaScript SDK supports MCP monitoring by wrapping the MCP Server from the [@modelcontextprotocol/sdk](https://www.npmjs.com/package/@modelcontextprotocol/sdk) package. This wrapper automatically captures spans for your MCP server workflows including tool executions, resource access, and client connections. | ||
|
||
#### Quick Start with MCP Server | ||
|
||
```javascript | ||
import { Sentry } from "@sentry/node"; | ||
import { McpServer } from "@modelcontextprotocol/sdk"; | ||
|
||
// Sentry init needs to be above everything else | ||
Sentry.init({ | ||
dsn: "___PUBLIC_DSN___", | ||
tracesSampleRate: 1.0, | ||
}); | ||
|
||
// Your MCP server | ||
const server = Sentry.wrapMcpServerWithSentry(new McpServer({ | ||
name: "my-mcp-server", | ||
version: "1.0.0", | ||
})); | ||
|
||
... | ||
``` |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
--- | ||
title: "MCP" | ||
sidebar_order: 20 | ||
description: "Learn how to use Sentry's MCP monitoring tools to trace and debug your Model Context Protocol implementations, including server connections, resource access, and tool executions." | ||
--- | ||
|
||
<Include name="feature-stage-beta.mdx" /> | ||
|
||
Sentry's MCP (Model Context Protocol) monitoring tools help you understand what's happening in your MCP implementations. They automatically collect information about MCP server connections, resource access, tool executions, and errors across your entire MCP pipeline—from client requests to server responses. | ||
|
||
## Example MCP Monitoring Use Cases | ||
|
||
- Your MCP server is failing to respond to tool calls, and you want to trace the complete request flow to identify where the connection is breaking. | ||
- Clients report that your MCP resources are returning outdated or malformed data, and you need to debug the full context of resource requests and server responses. | ||
- Your MCP implementations are experiencing performance issues, and you want to identify which components (server startup, resource fetching, or tool execution) are causing bottlenecks. | ||
|
||
## Get Started | ||
|
||
To use MCP Monitoring, you must have an existing Sentry account and project set up. If you don't have one, [create an account here](https://sentry.io/signup/). | ||
|
||
 | ||
|
||
Learn how to [set up Sentry for MCP](/product/insights/ai/mcp/getting-started/). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.