You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit a5efbf3
Browse filesBrowse the repository at this point in the historyBrowse files
## Summary
Make root `docs/` the shared entry point for Sentry CLI, Sentry MCP, and
contributor guidance. Link to the published CLI docs and their existing
Astro source without moving the release-built site. Update root guidance
and CI-selection wording; root docs remain quality-checked without
selecting product jobs.
Closes#1363
## Validation
- `pnpm run tsc`
- `pnpm run lint`
- `pnpm run test`
- `pnpm run check:generated`
- `pnpm run docs:check`
- `pnpm run test:ci-projects`
- `pnpm exec oxfmt --check` on changed files
- `node scripts/pre-commit-generated.mjs`
Co-authored-by: GPT-6 Sol <agent@openai.com>
Sentry MCP is a Model Context Protocol server that exposes Sentry's error tracking and performance monitoring to AI assistants through 19 tools.
2
+
3
+
Toolkit contains the Sentry CLI, the Sentry MCP server, and shared code. Product-specific instructions live in their packages; start with the shared [documentation index](docs/README.md).
3
4
4
5
## Principles
5
6
@@ -9,90 +10,104 @@ Sentry MCP is a Model Context Protocol server that exposes Sentry's error tracki
9
10
10
11
## Constraints
11
12
12
-
-**Tool count**: Target ≤20, hard limit 25 (AI agents have limited tool slots).
13
+
-**MCP tool count**: Target ≤20, hard limit 25 (AI agents have limited tool slots).
13
14
-**Quality gate**: `pnpm run tsc && pnpm run lint && pnpm run test` must pass before committing.
14
15
15
16
## Repository Structure
16
17
17
18
```
18
-
sentry-mcp/
19
+
toolkit/
20
+
├── apps/
21
+
│ └── cli-docs/ # CLI documentation site and generated command pages
19
22
├── packages/
23
+
│ ├── cli/ # Sentry CLI (see packages/cli/AGENTS.md)
pnpm --filter sentry run cli help# Run CLI help from repository root
94
109
95
-
#Testing
110
+
#MCP testing
96
111
pnpm -w run cli --transport stdio "q"# Test MCP tools
97
112
pnpm -w run cli --transport stdio --access-token=TOKEN "q"
98
113
@@ -121,12 +136,14 @@ Use `/dex` skill to coordinate complex work. Create tasks with full context, bre
121
136
1. Check neighboring files for existing patterns before writing new code.
122
137
2. When adding or modifying Sentry API endpoint usage, ALWAYS validate the endpoint behavior against the Sentry source code in `~/src/sentry` instead of assuming docs or client parameters are authoritative.
123
138
3. Update relevant docs when changing functionality.
124
-
4. Follow docs/contributing/error-handling.md for error types.
139
+
4. Follow docs/contributing/error-handling.md for MCP error types and
140
+
packages/cli/src/lib/errors.ts for CLI error classes.
125
141
5. Follow docs/contributing/pr-management.md for commits and PRs.
126
142
127
143
## Commit Attribution
128
144
129
145
AI commits MUST include:
146
+
130
147
```
131
148
Co-Authored-By: (the agent model's name and attribution byline)
Copy file name to clipboardExpand all lines: README.md
+12-2Lines changed: 12 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,11 @@
1
-
# sentry-mcp
1
+
# Sentry Toolkit
2
+
3
+
This repository contains the Sentry CLI, the Sentry MCP server, and shared
4
+
packages. For the CLI, see the [CLI guide](docs/cli/README.md) and the published
5
+
documentation at <https://cli.sentry.dev/>. The [documentation index](docs/README.md)
6
+
covers both products and shared contributor guidance.
7
+
8
+
## Sentry MCP
2
9
3
10
Sentry's MCP service is primarily designed for human-in-the-loop coding agents. Our tool selection and priorities are focused on developer workflows and debugging use cases, rather than providing a general-purpose MCP server for all Sentry functionality.
4
11
@@ -267,6 +274,7 @@ pnpm -w run cli --access-token=TOKEN "query"
267
274
Note: The CLI defaults to `http://localhost:5173`. Override with `--mcp-host` or set `MCP_URL` environment variable.
268
275
269
276
**Comprehensive testing playbooks:**
277
+
270
278
-**Stdio testing:** See `docs/testing/stdio.md` for complete guide on building, running, and testing the stdio implementation (IDEs, MCP Inspector)
271
279
-**Remote testing:** See `docs/testing/remote.md` for complete guide on testing the remote server (OAuth, web UI, CLI client)
272
280
@@ -287,4 +295,6 @@ When addressing automated feedback, focus on the underlying concerns rather than
287
295
288
296
### Contributor Documentation
289
297
290
-
Looking to contribute or explore the full documentation map? See `CLAUDE.md` (also available as `AGENTS.md`) for contributor workflows and the complete docs index. The `docs/` folder contains the per-topic guides and tool-integrated `.md` files.
298
+
Looking to contribute? Start at the [Toolkit documentation index](docs/README.md)
299
+
for CLI, MCP, and shared guides. See `AGENTS.md` for repository rules and
0 commit comments