Skip to content

fix(search-events): Document backtick _if aggregate syntax - #1494

Merged
wmak merged 1 commit into
mainfrom
wmak/fix/backtick-if-aggregates
Oct 13, 2026
Merged

wmak merged 1 commit into
mainfrom
wmak/fix/backtick-if-aggregates

Conversation

@wmak

@wmak wmak commented Oct 13, 2026

Copy link
Copy Markdown
Member

Spans, logs, and metrics conditional aggregates take a backtick-wrapped search filter as the first argument. Keep the three-argument count_if form for the errors dataset.

Spans, logs, and metrics conditional aggregates take a backtick-wrapped
search filter as the first argument. Keep the three-argument count_if
form for the errors dataset.

Co-Authored-By: Grok 4.7 <noreply@x.ai>
Co-authored-by: Cursor <cursoragent@cursor.com>
@github-actions github-actions Bot added the risk: low PR risk score: low label Oct 13, 2026
@wmak
wmak merged commit d7d7a75 into main Oct 13, 2026
33 checks passed
@wmak
wmak deleted the wmak/fix/backtick-if-aggregates branch October 13, 2026 15:47
joshuawayzwright pushed a commit to joshuawayzwright/sentry-mcp that referenced this pull request Nov 16, 2026
Adds a `sentry status` command backed by Sentry's public status page
(https://status.sentry.io) Statuspage API. It reports the overall
service indicator, any active incidents, and impacted components — and
works even when the Sentry API itself is degraded, since the request is
bounded by an explicit 10s timeout so a status check never hangs.

- `sentry status` (defaults to `show`) prints human-readable status
- `--json` emits structured data for scripting
- `--url` points at a self-hosted or regional Statuspage instance

This addresses item 2 of the issue. Request timeouts (item 1) already
exist in the shared API client (`sentry-client.ts`, 30s default +
per-endpoint overrides). Item 3 (auto-suppressing 5xx and suggesting
`sentry status`) is left for a follow-up as it's broader in scope.

## Testing
- `vitest run test/commands/status` — 4 tests pass (operational,
outage/incidents, `--json`, error path)
- `tsc --noEmit` clean
- `biome check` clean on new files
- `generate:docs` + `check:fragments` pass (new `status` fragment +
regenerated skill/docs sections committed)

Closes getsentry#1493

<!--
## Plan
Repo is the TypeScript sentry CLI (packages/cli), not Rust.

New files:
- packages/cli/src/lib/api/status-page.ts — fetchSentryStatus(baseUrl)
hits <url>/api/v2/summary.json, bounded by AbortSignal.timeout(10s),
throws ApiError on non-ok. Shapes payload into SentryStatus { indicator,
description, url, components[], incidents[] }, dropping Statuspage group
headers.
- packages/cli/src/commands/status/show.ts — buildCommand({ auth:false,
output:{human:formatSentryStatus} }) with --url flag (default
status.sentry.io); yields CommandOutput(status), adds a hint when not
fully operational. --json auto-injected by buildCommand.
- packages/cli/src/commands/status/index.ts — statusRoute
buildRouteMap({ routes:{show}, defaultCommand:"show" }).
- packages/cli/test/commands/status/show.test.ts — mocks
globalThis.fetch.
- apps/cli-docs/src/fragments/commands/status.md — doc fragment
(required by check-fragments).

Edits:
- packages/cli/src/app.ts — import statusRoute, register status in
top-level routes.
- packages/cli/src/lib/formatters/human.ts — add formatSentryStatus()
with colored indicator/component dots, incidents section, impacted-only
component list falling back to full list.
- Regenerated committed generated files: SKILL.md, references/status.md,
contributing.md.
-->

---------

Co-authored-by: jared-outpost[bot] <jared-outpost[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
joshuawayzwright pushed a commit to joshuawayzwright/sentry-mcp that referenced this pull request Nov 16, 2026
Adds a `sentry status` command backed by Sentry's public status page
(https://status.sentry.io) Statuspage API. It reports the overall
service indicator, any active incidents, and impacted components — and
works even when the Sentry API itself is degraded, since the request is
bounded by an explicit 10s timeout so a status check never hangs.

- `sentry status` (defaults to `show`) prints human-readable status
- `--json` emits structured data for scripting
- `--url` points at a self-hosted or regional Statuspage instance

This addresses item 2 of the issue. Request timeouts (item 1) already
exist in the shared API client (`sentry-client.ts`, 30s default +
per-endpoint overrides). Item 3 (auto-suppressing 5xx and suggesting
`sentry status`) is left for a follow-up as it's broader in scope.

## Testing
- `vitest run test/commands/status` — 4 tests pass (operational,
outage/incidents, `--json`, error path)
- `tsc --noEmit` clean
- `biome check` clean on new files
- `generate:docs` + `check:fragments` pass (new `status` fragment +
regenerated skill/docs sections committed)

Closes getsentry#1493

<!--
## Plan
Repo is the TypeScript sentry CLI (packages/cli), not Rust.

New files:
- packages/cli/src/lib/api/status-page.ts — fetchSentryStatus(baseUrl)
hits <url>/api/v2/summary.json, bounded by AbortSignal.timeout(10s),
throws ApiError on non-ok. Shapes payload into SentryStatus { indicator,
description, url, components[], incidents[] }, dropping Statuspage group
headers.
- packages/cli/src/commands/status/show.ts — buildCommand({ auth:false,
output:{human:formatSentryStatus} }) with --url flag (default
status.sentry.io); yields CommandOutput(status), adds a hint when not
fully operational. --json auto-injected by buildCommand.
- packages/cli/src/commands/status/index.ts — statusRoute
buildRouteMap({ routes:{show}, defaultCommand:"show" }).
- packages/cli/test/commands/status/show.test.ts — mocks
globalThis.fetch.
- apps/cli-docs/src/fragments/commands/status.md — doc fragment
(required by check-fragments).

Edits:
- packages/cli/src/app.ts — import statusRoute, register status in
top-level routes.
- packages/cli/src/lib/formatters/human.ts — add formatSentryStatus()
with colored indicator/component dots, incidents section, impacted-only
component list falling back to full list.
- Regenerated committed generated files: SKILL.md, references/status.md,
contributing.md.
-->

---------

Co-authored-by: jared-outpost[bot] <jared-outpost[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
joshuawayzwright pushed a commit to joshuawayzwright/sentry-mcp that referenced this pull request Nov 16, 2026
Adds a `sentry status` command backed by Sentry's public status page
(https://status.sentry.io) Statuspage API. It reports the overall
service indicator, any active incidents, and impacted components — and
works even when the Sentry API itself is degraded, since the request is
bounded by an explicit 10s timeout so a status check never hangs.

- `sentry status` (defaults to `show`) prints human-readable status
- `--json` emits structured data for scripting
- `--url` points at a self-hosted or regional Statuspage instance

This addresses item 2 of the issue. Request timeouts (item 1) already
exist in the shared API client (`sentry-client.ts`, 30s default +
per-endpoint overrides). Item 3 (auto-suppressing 5xx and suggesting
`sentry status`) is left for a follow-up as it's broader in scope.

## Testing
- `vitest run test/commands/status` — 4 tests pass (operational,
outage/incidents, `--json`, error path)
- `tsc --noEmit` clean
- `biome check` clean on new files
- `generate:docs` + `check:fragments` pass (new `status` fragment +
regenerated skill/docs sections committed)

Closes getsentry#1493

<!--
## Plan
Repo is the TypeScript sentry CLI (packages/cli), not Rust.

New files:
- packages/cli/src/lib/api/status-page.ts — fetchSentryStatus(baseUrl)
hits <url>/api/v2/summary.json, bounded by AbortSignal.timeout(10s),
throws ApiError on non-ok. Shapes payload into SentryStatus { indicator,
description, url, components[], incidents[] }, dropping Statuspage group
headers.
- packages/cli/src/commands/status/show.ts — buildCommand({ auth:false,
output:{human:formatSentryStatus} }) with --url flag (default
status.sentry.io); yields CommandOutput(status), adds a hint when not
fully operational. --json auto-injected by buildCommand.
- packages/cli/src/commands/status/index.ts — statusRoute
buildRouteMap({ routes:{show}, defaultCommand:"show" }).
- packages/cli/test/commands/status/show.test.ts — mocks
globalThis.fetch.
- apps/cli-docs/src/fragments/commands/status.md — doc fragment
(required by check-fragments).

Edits:
- packages/cli/src/app.ts — import statusRoute, register status in
top-level routes.
- packages/cli/src/lib/formatters/human.ts — add formatSentryStatus()
with colored indicator/component dots, incidents section, impacted-only
component list falling back to full list.
- Regenerated committed generated files: SKILL.md, references/status.md,
contributing.md.
-->

---------

Co-authored-by: jared-outpost[bot] <jared-outpost[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
joshuawayzwright pushed a commit to joshuawayzwright/sentry-mcp that referenced this pull request Nov 16, 2026
Adds a `sentry status` command backed by Sentry's public status page
(https://status.sentry.io) Statuspage API. It reports the overall
service indicator, any active incidents, and impacted components — and
works even when the Sentry API itself is degraded, since the request is
bounded by an explicit 10s timeout so a status check never hangs.

- `sentry status` (defaults to `show`) prints human-readable status
- `--json` emits structured data for scripting
- `--url` points at a self-hosted or regional Statuspage instance

This addresses item 2 of the issue. Request timeouts (item 1) already
exist in the shared API client (`sentry-client.ts`, 30s default +
per-endpoint overrides). Item 3 (auto-suppressing 5xx and suggesting
`sentry status`) is left for a follow-up as it's broader in scope.

## Testing
- `vitest run test/commands/status` — 4 tests pass (operational,
outage/incidents, `--json`, error path)
- `tsc --noEmit` clean
- `biome check` clean on new files
- `generate:docs` + `check:fragments` pass (new `status` fragment +
regenerated skill/docs sections committed)

Closes getsentry#1493

<!--
## Plan
Repo is the TypeScript sentry CLI (packages/cli), not Rust.

New files:
- packages/cli/src/lib/api/status-page.ts — fetchSentryStatus(baseUrl)
hits <url>/api/v2/summary.json, bounded by AbortSignal.timeout(10s),
throws ApiError on non-ok. Shapes payload into SentryStatus { indicator,
description, url, components[], incidents[] }, dropping Statuspage group
headers.
- packages/cli/src/commands/status/show.ts — buildCommand({ auth:false,
output:{human:formatSentryStatus} }) with --url flag (default
status.sentry.io); yields CommandOutput(status), adds a hint when not
fully operational. --json auto-injected by buildCommand.
- packages/cli/src/commands/status/index.ts — statusRoute
buildRouteMap({ routes:{show}, defaultCommand:"show" }).
- packages/cli/test/commands/status/show.test.ts — mocks
globalThis.fetch.
- apps/cli-docs/src/fragments/commands/status.md — doc fragment
(required by check-fragments).

Edits:
- packages/cli/src/app.ts — import statusRoute, register status in
top-level routes.
- packages/cli/src/lib/formatters/human.ts — add formatSentryStatus()
with colored indicator/component dots, incidents section, impacted-only
component list falling back to full list.
- Regenerated committed generated files: SKILL.md, references/status.md,
contributing.md.
-->

---------

Co-authored-by: jared-outpost[bot] <jared-outpost[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
joshuawayzwright pushed a commit to joshuawayzwright/sentry-mcp that referenced this pull request Nov 16, 2026
…nstall flags, plugin syntax (getsentry#1514)

## Documentation Audit Report — 2026-08-31

Weekly audit comparing the Sentry CLI implementation (v0.45.0-dev.0)
against its documentation. This covers changes since the last merged
audit ([getsentry#1461](getsentry/cli#1461), 2026-08-24).

---

### Findings Summary

| Section | Status |
|---------|--------|
| A. Undocumented commands | ✅ No gaps — `check:fragments` CI enforces
coverage |
| B. Undocumented flags | ✅ No gaps — auto-generated from CLI metadata |
| C. Missing usage examples | ✅ All 37 fragments have bash examples |
| D. Stale descriptions | ✅ No drift — pulled from code at generation
time |
| E. Missing route mappings | ✅ No gaps — `ROUTE_TO_REFERENCE` replaced
with auto 1:1 mapping |
| F. Installation gaps | ⚠️ Install script flags undocumented in
getting-started.mdx |
| G. Undocumented env vars | ✅ No gaps — `check:env-coverage` CI
enforces completeness |
| H. Auth/self-hosted gaps | ⚠️ `auth refresh --read-only/--scope`
examples missing |
| I. Plugin/skills gaps | ⚠️ `sentry docs` missing from agentic pages;
stale plugin syntax |
| J. README/DEVELOPMENT.md drift | ✅ No drift — auto-generated marker
sections |

---

### Changes Made

**1. Add `sentry docs` and `sentry status` to agentic guidance (I1,
I2)**

The `sentry docs` command suite (getsentry#1457) and `sentry status` command
(getsentry#1494) are recent additions that are highly relevant for AI agent
workflows but were not mentioned in `agentic-usage.md` or
`agent-guidance.md`. Added:
- New capability in agentic-usage.md: "Query documentation"
- New examples: `sentry docs "How do I set up source maps?"` and `sentry
status`
- New workflow patterns in agent-guidance.md for documentation querying
and status checking
- New key principle: "Use `sentry docs` for setup questions"
- New common mistake entry about fetching docs externally

**2. Document install script flags in getting-started.mdx (F1)**

The install script accepts `--no-modify-path`, `--no-completions`, and
`--no-agent-skills` flags, plus the `SENTRY_INSTALL_DIR` env var. These
were documented in the CLI fragment (`cli.md`) but not on the Getting
Started page where users encounter the install script.

**3. Update plugins/README.md installation syntax (I3)**

Replaced deprecated Claude Code `claude plugin marketplace add` /
`claude plugin install` commands with current dotagents-based
installation and automatic skill installation documentation.

**4. Add `auth refresh` scoped examples (H1)**

Added `--read-only` and `--scope` examples to the `auth refresh` section
in `auth.md` fragment.

---

### Top 5 Most Impactful Fixes (prioritized)

1. **`sentry docs` in agentic pages** — Primary agent tool for
documentation queries, invisible without this
2. **Install script flags in getting-started** — CI/Docker users need
`--no-agent-skills` etc.
3. **Plugin syntax update** — Deprecated commands that no longer work
4. **`sentry docs` workflow pattern** — Natural addition to detailed
agent guidance
5. **`auth refresh` scoped examples** — Minor but useful for agents and
CI

<div><a
href="https://cursor.com/agents/bc-540303b8-6fe0-4e4e-9e70-cacd12705c98?cursor_ref=pr_footer&cursor_cta=open_in_web"><picture><source
media="(prefers-color-scheme: dark)"
srcset="https://cursor.com/assets/images/open-in-web-dark.png"><source
media="(prefers-color-scheme: light)"
srcset="https://cursor.com/assets/images/open-in-web-light.png"><img
alt="Open in Web" width="114" height="28"
src="https://cursor.com/assets/images/open-in-web-dark.png"></picture></a>&nbsp;<a
href="https://cursor.com/automations/8b0c0f35-da5e-409d-984c-5e39518ffb8a"><picture><source
media="(prefers-color-scheme: dark)"
srcset="https://cursor.com/assets/images/view-automation-dark.png"><source
media="(prefers-color-scheme: light)"
srcset="https://cursor.com/assets/images/view-automation-light.png"><img
alt="View Automation" width="141" height="28"
src="https://cursor.com/assets/images/view-automation-dark.png"></picture></a>&nbsp;</div>

---------

Co-authored-by: Cursor Agent <cursoragent@cursor.com>
Co-authored-by: Miguel Betegón <miguelbetegongarcia@gmail.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
joshuawayzwright pushed a commit to joshuawayzwright/sentry-mcp that referenced this pull request Nov 16, 2026
…nstall flags, plugin syntax (getsentry#1514)

## Documentation Audit Report — 2026-08-31

Weekly audit comparing the Sentry CLI implementation (v0.45.0-dev.0)
against its documentation. This covers changes since the last merged
audit ([getsentry#1461](getsentry/cli#1461), 2026-08-24).

---

### Findings Summary

| Section | Status |
|---------|--------|
| A. Undocumented commands | ✅ No gaps — `check:fragments` CI enforces
coverage |
| B. Undocumented flags | ✅ No gaps — auto-generated from CLI metadata |
| C. Missing usage examples | ✅ All 37 fragments have bash examples |
| D. Stale descriptions | ✅ No drift — pulled from code at generation
time |
| E. Missing route mappings | ✅ No gaps — `ROUTE_TO_REFERENCE` replaced
with auto 1:1 mapping |
| F. Installation gaps | ⚠️ Install script flags undocumented in
getting-started.mdx |
| G. Undocumented env vars | ✅ No gaps — `check:env-coverage` CI
enforces completeness |
| H. Auth/self-hosted gaps | ⚠️ `auth refresh --read-only/--scope`
examples missing |
| I. Plugin/skills gaps | ⚠️ `sentry docs` missing from agentic pages;
stale plugin syntax |
| J. README/DEVELOPMENT.md drift | ✅ No drift — auto-generated marker
sections |

---

### Changes Made

**1. Add `sentry docs` and `sentry status` to agentic guidance (I1,
I2)**

The `sentry docs` command suite (getsentry#1457) and `sentry status` command
(getsentry#1494) are recent additions that are highly relevant for AI agent
workflows but were not mentioned in `agentic-usage.md` or
`agent-guidance.md`. Added:
- New capability in agentic-usage.md: "Query documentation"
- New examples: `sentry docs "How do I set up source maps?"` and `sentry
status`
- New workflow patterns in agent-guidance.md for documentation querying
and status checking
- New key principle: "Use `sentry docs` for setup questions"
- New common mistake entry about fetching docs externally

**2. Document install script flags in getting-started.mdx (F1)**

The install script accepts `--no-modify-path`, `--no-completions`, and
`--no-agent-skills` flags, plus the `SENTRY_INSTALL_DIR` env var. These
were documented in the CLI fragment (`cli.md`) but not on the Getting
Started page where users encounter the install script.

**3. Update plugins/README.md installation syntax (I3)**

Replaced deprecated Claude Code `claude plugin marketplace add` /
`claude plugin install` commands with current dotagents-based
installation and automatic skill installation documentation.

**4. Add `auth refresh` scoped examples (H1)**

Added `--read-only` and `--scope` examples to the `auth refresh` section
in `auth.md` fragment.

---

### Top 5 Most Impactful Fixes (prioritized)

1. **`sentry docs` in agentic pages** — Primary agent tool for
documentation queries, invisible without this
2. **Install script flags in getting-started** — CI/Docker users need
`--no-agent-skills` etc.
3. **Plugin syntax update** — Deprecated commands that no longer work
4. **`sentry docs` workflow pattern** — Natural addition to detailed
agent guidance
5. **`auth refresh` scoped examples** — Minor but useful for agents and
CI

<div><a
href="https://cursor.com/agents/bc-540303b8-6fe0-4e4e-9e70-cacd12705c98?cursor_ref=pr_footer&cursor_cta=open_in_web"><picture><source
media="(prefers-color-scheme: dark)"
srcset="https://cursor.com/assets/images/open-in-web-dark.png"><source
media="(prefers-color-scheme: light)"
srcset="https://cursor.com/assets/images/open-in-web-light.png"><img
alt="Open in Web" width="114" height="28"
src="https://cursor.com/assets/images/open-in-web-dark.png"></picture></a>&nbsp;<a
href="https://cursor.com/automations/8b0c0f35-da5e-409d-984c-5e39518ffb8a"><picture><source
media="(prefers-color-scheme: dark)"
srcset="https://cursor.com/assets/images/view-automation-dark.png"><source
media="(prefers-color-scheme: light)"
srcset="https://cursor.com/assets/images/view-automation-light.png"><img
alt="View Automation" width="141" height="28"
src="https://cursor.com/assets/images/view-automation-dark.png"></picture></a>&nbsp;</div>

---------

Co-authored-by: Cursor Agent <cursoragent@cursor.com>
Co-authored-by: Miguel Betegón <miguelbetegongarcia@gmail.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
joshuawayzwright pushed a commit to joshuawayzwright/sentry-mcp that referenced this pull request Nov 16, 2026
…nstall flags, plugin syntax (getsentry#1514)

## Documentation Audit Report — 2026-08-31

Weekly audit comparing the Sentry CLI implementation (v0.45.0-dev.0)
against its documentation. This covers changes since the last merged
audit ([getsentry#1461](getsentry/cli#1461), 2026-08-24).

---

### Findings Summary

| Section | Status |
|---------|--------|
| A. Undocumented commands | ✅ No gaps — `check:fragments` CI enforces
coverage |
| B. Undocumented flags | ✅ No gaps — auto-generated from CLI metadata |
| C. Missing usage examples | ✅ All 37 fragments have bash examples |
| D. Stale descriptions | ✅ No drift — pulled from code at generation
time |
| E. Missing route mappings | ✅ No gaps — `ROUTE_TO_REFERENCE` replaced
with auto 1:1 mapping |
| F. Installation gaps | ⚠️ Install script flags undocumented in
getting-started.mdx |
| G. Undocumented env vars | ✅ No gaps — `check:env-coverage` CI
enforces completeness |
| H. Auth/self-hosted gaps | ⚠️ `auth refresh --read-only/--scope`
examples missing |
| I. Plugin/skills gaps | ⚠️ `sentry docs` missing from agentic pages;
stale plugin syntax |
| J. README/DEVELOPMENT.md drift | ✅ No drift — auto-generated marker
sections |

---

### Changes Made

**1. Add `sentry docs` and `sentry status` to agentic guidance (I1,
I2)**

The `sentry docs` command suite (getsentry#1457) and `sentry status` command
(getsentry#1494) are recent additions that are highly relevant for AI agent
workflows but were not mentioned in `agentic-usage.md` or
`agent-guidance.md`. Added:
- New capability in agentic-usage.md: "Query documentation"
- New examples: `sentry docs "How do I set up source maps?"` and `sentry
status`
- New workflow patterns in agent-guidance.md for documentation querying
and status checking
- New key principle: "Use `sentry docs` for setup questions"
- New common mistake entry about fetching docs externally

**2. Document install script flags in getting-started.mdx (F1)**

The install script accepts `--no-modify-path`, `--no-completions`, and
`--no-agent-skills` flags, plus the `SENTRY_INSTALL_DIR` env var. These
were documented in the CLI fragment (`cli.md`) but not on the Getting
Started page where users encounter the install script.

**3. Update plugins/README.md installation syntax (I3)**

Replaced deprecated Claude Code `claude plugin marketplace add` /
`claude plugin install` commands with current dotagents-based
installation and automatic skill installation documentation.

**4. Add `auth refresh` scoped examples (H1)**

Added `--read-only` and `--scope` examples to the `auth refresh` section
in `auth.md` fragment.

---

### Top 5 Most Impactful Fixes (prioritized)

1. **`sentry docs` in agentic pages** — Primary agent tool for
documentation queries, invisible without this
2. **Install script flags in getting-started** — CI/Docker users need
`--no-agent-skills` etc.
3. **Plugin syntax update** — Deprecated commands that no longer work
4. **`sentry docs` workflow pattern** — Natural addition to detailed
agent guidance
5. **`auth refresh` scoped examples** — Minor but useful for agents and
CI

<div><a
href="https://cursor.com/agents/bc-540303b8-6fe0-4e4e-9e70-cacd12705c98?cursor_ref=pr_footer&cursor_cta=open_in_web"><picture><source
media="(prefers-color-scheme: dark)"
srcset="https://cursor.com/assets/images/open-in-web-dark.png"><source
media="(prefers-color-scheme: light)"
srcset="https://cursor.com/assets/images/open-in-web-light.png"><img
alt="Open in Web" width="114" height="28"
src="https://cursor.com/assets/images/open-in-web-dark.png"></picture></a>&nbsp;<a
href="https://cursor.com/automations/8b0c0f35-da5e-409d-984c-5e39518ffb8a"><picture><source
media="(prefers-color-scheme: dark)"
srcset="https://cursor.com/assets/images/view-automation-dark.png"><source
media="(prefers-color-scheme: light)"
srcset="https://cursor.com/assets/images/view-automation-light.png"><img
alt="View Automation" width="141" height="28"
src="https://cursor.com/assets/images/view-automation-dark.png"></picture></a>&nbsp;</div>

---------

Co-authored-by: Cursor Agent <cursoragent@cursor.com>
Co-authored-by: Miguel Betegón <miguelbetegongarcia@gmail.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
joshuawayzwright pushed a commit to joshuawayzwright/sentry-mcp that referenced this pull request Nov 16, 2026
…nstall flags, plugin syntax (getsentry#1514)

## Documentation Audit Report — 2026-08-31

Weekly audit comparing the Sentry CLI implementation (v0.45.0-dev.0)
against its documentation. This covers changes since the last merged
audit ([getsentry#1461](getsentry/cli#1461), 2026-08-24).

---

### Findings Summary

| Section | Status |
|---------|--------|
| A. Undocumented commands | ✅ No gaps — `check:fragments` CI enforces
coverage |
| B. Undocumented flags | ✅ No gaps — auto-generated from CLI metadata |
| C. Missing usage examples | ✅ All 37 fragments have bash examples |
| D. Stale descriptions | ✅ No drift — pulled from code at generation
time |
| E. Missing route mappings | ✅ No gaps — `ROUTE_TO_REFERENCE` replaced
with auto 1:1 mapping |
| F. Installation gaps | ⚠️ Install script flags undocumented in
getting-started.mdx |
| G. Undocumented env vars | ✅ No gaps — `check:env-coverage` CI
enforces completeness |
| H. Auth/self-hosted gaps | ⚠️ `auth refresh --read-only/--scope`
examples missing |
| I. Plugin/skills gaps | ⚠️ `sentry docs` missing from agentic pages;
stale plugin syntax |
| J. README/DEVELOPMENT.md drift | ✅ No drift — auto-generated marker
sections |

---

### Changes Made

**1. Add `sentry docs` and `sentry status` to agentic guidance (I1,
I2)**

The `sentry docs` command suite (getsentry#1457) and `sentry status` command
(getsentry#1494) are recent additions that are highly relevant for AI agent
workflows but were not mentioned in `agentic-usage.md` or
`agent-guidance.md`. Added:
- New capability in agentic-usage.md: "Query documentation"
- New examples: `sentry docs "How do I set up source maps?"` and `sentry
status`
- New workflow patterns in agent-guidance.md for documentation querying
and status checking
- New key principle: "Use `sentry docs` for setup questions"
- New common mistake entry about fetching docs externally

**2. Document install script flags in getting-started.mdx (F1)**

The install script accepts `--no-modify-path`, `--no-completions`, and
`--no-agent-skills` flags, plus the `SENTRY_INSTALL_DIR` env var. These
were documented in the CLI fragment (`cli.md`) but not on the Getting
Started page where users encounter the install script.

**3. Update plugins/README.md installation syntax (I3)**

Replaced deprecated Claude Code `claude plugin marketplace add` /
`claude plugin install` commands with current dotagents-based
installation and automatic skill installation documentation.

**4. Add `auth refresh` scoped examples (H1)**

Added `--read-only` and `--scope` examples to the `auth refresh` section
in `auth.md` fragment.

---

### Top 5 Most Impactful Fixes (prioritized)

1. **`sentry docs` in agentic pages** — Primary agent tool for
documentation queries, invisible without this
2. **Install script flags in getting-started** — CI/Docker users need
`--no-agent-skills` etc.
3. **Plugin syntax update** — Deprecated commands that no longer work
4. **`sentry docs` workflow pattern** — Natural addition to detailed
agent guidance
5. **`auth refresh` scoped examples** — Minor but useful for agents and
CI

<div><a
href="https://cursor.com/agents/bc-540303b8-6fe0-4e4e-9e70-cacd12705c98?cursor_ref=pr_footer&cursor_cta=open_in_web"><picture><source
media="(prefers-color-scheme: dark)"
srcset="https://cursor.com/assets/images/open-in-web-dark.png"><source
media="(prefers-color-scheme: light)"
srcset="https://cursor.com/assets/images/open-in-web-light.png"><img
alt="Open in Web" width="114" height="28"
src="https://cursor.com/assets/images/open-in-web-dark.png"></picture></a>&nbsp;<a
href="https://cursor.com/automations/8b0c0f35-da5e-409d-984c-5e39518ffb8a"><picture><source
media="(prefers-color-scheme: dark)"
srcset="https://cursor.com/assets/images/view-automation-dark.png"><source
media="(prefers-color-scheme: light)"
srcset="https://cursor.com/assets/images/view-automation-light.png"><img
alt="View Automation" width="141" height="28"
src="https://cursor.com/assets/images/view-automation-dark.png"></picture></a>&nbsp;</div>

---------

Co-authored-by: Cursor Agent <cursoragent@cursor.com>
Co-authored-by: Miguel Betegón <miguelbetegongarcia@gmail.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

This branch was previously deployed

1 inactive deployment
Actions — d963b6ba Deployed Oct 13, 2026 by wmak via eval #1295
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

risk: low PR risk score: low

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant