Skip to content

fix(docs): correct agent conversation argument syntax - #1558

Open
alicandayan wants to merge 1 commit into
getsentry:mainfrom
alicandayan:fix/agent-conversation-reference-syntax
Open

fix(docs): correct agent conversation argument syntax#1558
alicandayan wants to merge 1 commit into
getsentry:mainfrom
alicandayan:fix/agent-conversation-reference-syntax

Conversation

@alicandayan

Copy link
Copy Markdown

The agent-conversation reference currently shows sentry agent-conversation view my-org conv-123, but view accepts one [<org>/]<conversation-id> positional argument. The list and view headings also make the organization appear mandatory even though both support detection.

Correct the authoritative examples to use my-org/conv-123, include the detected-organization form, and add command-specific usage metadata. Regenerate the skill index/reference with the existing generator. Command execution and argument parsing are unchanged.

Validation:

  • Both new documentation regressions fail against current main before the correction.
  • Generated API schema, SDK, command docs and skills through the existing scripts.
  • 101 focused command, API, formatter and documentation tests passed across five files.
  • Biome checked the three TypeScript files with no fixes or errors.

Copilot AI lite review requested due to automatic review settings September 8, 2026 14:37
@vercel

vercel Bot commented Sep 8, 2026

Copy link
Copy Markdown

@alicandayan is attempting to deploy a commit to the Sentry Team on Vercel.

A member of the Team first needs to authorize it.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

The runtime ContextError usage hint in agent-conversation list remains inconsistent with the newly documented optional-org usage, which can mislead users when org auto-detection fails.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

Pull request overview

This PR corrects the documented argument syntax for sentry agent-conversation view so the org and conversation ID are shown as a single positional ([<org>/]<conversation-id>), and clarifies that organization auto-detection is supported for both list and view. It also adds command usage metadata so generated references/headings reflect the canonical signatures.

Changes:

  • Add customUsage metadata to agent-conversation list and view command definitions for correct signature generation.
  • Update generated skill reference markdown and CLI docs fragments to use my-org/conv-123 and include an org-auto-detected example.
  • Add regression tests ensuring generated reference headings/examples preserve optional org detection and the single-positional form.
File summaries
File Description
packages/cli/test/script/generate-skill-markdown.test.ts Adds tests asserting the generated agent-conversation reference uses optional-org headings and correct example syntax.
packages/cli/src/commands/agent-conversation/view.ts Adds customUsage so generated docs use [<org>/]<conversation-id> for view.
packages/cli/src/commands/agent-conversation/list.ts Adds customUsage so generated docs show [<org>] for list.
packages/cli/plugins/sentry-cli/skills/sentry-cli/SKILL.md Updates the skill index entries to reflect optional org detection and corrected signatures.
packages/cli/plugins/sentry-cli/skills/sentry-cli/references/agent-conversation.md Updates headings and examples to use conv-123 and my-org/conv-123 (single positional).
apps/cli-docs/src/fragments/commands/agent-conversation.md Updates public docs examples to match corrected view argument form and org auto-detection.
Review details
  • Files reviewed: 6/6 changed files
  • Comments generated: 1
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment on lines 99 to 103
docs: {
brief: "List recent agent conversations",
customUsage: ["[<org>]"],
fullDescription:
"List recent agent conversations from a Sentry organization.\n\n" +
@BYK BYK self-assigned this Sep 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants