docs: add key principles and API schema workflow to agent guidance#466
Merged
docs: add key principles and API schema workflow to agent guidance#466
Conversation
Contributor
Semver Impact of This PR🟢 Patch (bug fixes) 📋 Changelog PreviewThis is how your changes will appear in the changelog. New Features ✨
Bug Fixes 🐛
Documentation 📚
Internal Changes 🔧
🤖 This preview updates automatically when you update the PR. |
Contributor
|
Contributor
Codecov Results 📊✅ 116 passed | Total: 116 | Pass Rate: 100% | Execution Time: 0ms 📊 Comparison with Base Branch
✨ No test changes detected All tests are passing successfully. ✅ Patch coverage is 100.00%. Project has 1130 uncovered lines. Coverage diff@@ Coverage Diff @@
## main #PR +/-##
==========================================
+ Coverage 95.30% 95.30% —%
==========================================
Files 177 177 —
Lines 24067 24067 —
Branches 0 0 —
==========================================
+ Hits 22937 22937 —
- Misses 1130 1130 —
- Partials 0 0 —Generated by Codecov Action |
Add a 'Key Principles' section to agent-guidance.md that explicitly instructs LLM agents to: - Always use CLI commands directly, never download external schemas - Use 'sentry schema' for API exploration instead of fetching OpenAPI files - Use 'sentry issue view <id>' to investigate specific issues Add an 'Explore the API Schema' workflow pattern showing how to use 'sentry schema' for API discovery. Add a common mistake entry about downloading API schemas externally. Update agentic-usage.md with concrete command mappings for common questions and a self-containment note. Regenerate SKILL.md to include the new guidance sections.
BYK
force-pushed
the
byk/improve-agent-skill-guidance
branch
from
2203e84 to
fa39097
Compare
5 tasks
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
LLM agents loading the sentry-cli skill were resorting to downloading OpenAPI
schemas from GitHub instead of using CLI commands like
sentry issue view CLI-G5.The SKILL.md was a pure command reference with no guidance on when to use which
command.
Changes
docs/src/content/docs/agent-guidance.mdalways use CLI commands directly, use
sentry schemafor API exploration, and usesentry issue view <id>for investigating issuesdocs/src/content/docs/agentic-usage.mdplugins/sentry-cli/skills/sentry-cli/SKILL.md