docs: clarify large artifact context tooling#63
Conversation
📝 WalkthroughWalkthroughAGENTS.md is updated with new guidance under "Core MUST Rules" that permits agents to optionally use local compression tools for navigating large non-source artifacts, contingent upon validating conclusions against the original uncompressed content before any code edits or final assertions. ChangesAgent Guidance Enhancement
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@AGENTS.md`:
- Around line 84-86: The "AI Context Tools" paragraph is placed before the "Core
MUST Rules" section but contains a MUST-level requirement; move this paragraph
under the "Core MUST Rules" header as a ### subsection named "AI Context Tools"
(or split it into two sentences under "AI Context Tools": one MAY sentence
recommending compression tools and a separate MUST sentence requiring
verification of conclusions against the original artifact) so the mandatory
language lives inside "Core MUST Rules" and the optional guidance remains
clearly marked as MAY.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
| ## AI Context Tools | ||
|
|
||
| For very large non-source artifacts such as CI logs, debug traces, generated JSON, or massive command output, agents may optionally use `chopratejas/headroom` or a similar local compression tool as a navigation aid, but must verify conclusions against the original uncompressed artifact before editing code or making final claims. |
There was a problem hiding this comment.
Placement inconsistency: Section should likely be under "Core MUST Rules".
The PR description states this guidance is added "under 'Core MUST Rules'", but the actual implementation places it as a sibling section before "Core MUST Rules" (line 88). Additionally, the content contains a MUST-level requirement ("must verify conclusions") but is placed outside the "Core MUST Rules" section.
Consider either:
- Moving this subsection under "Core MUST Rules" as a ### subsection (matching the PR description), or
- Restructuring to separate the optional suggestion (using compression tools) from the mandatory requirement (verification before final claims)
📝 Proposed fix: Move under Core MUST Rules as a subsection
-## AI Context Tools
-
-For very large non-source artifacts such as CI logs, debug traces, generated JSON, or massive command output, agents may optionally use `chopratejas/headroom` or a similar local compression tool as a navigation aid, but must verify conclusions against the original uncompressed artifact before editing code or making final claims.
-
## Core MUST Rules
+### AI Context Tools
+
+- **MAY** optionally use `chopratejas/headroom` or a similar local compression tool as a navigation aid for very large non-source artifacts such as CI logs, debug traces, generated JSON, or massive command output.
+- **MUST** verify conclusions against the original uncompressed artifact before editing code or making final claims.
+
### Environment SetupThis aligns with the PR description and separates the optional (MAY) from mandatory (MUST) guidance using the priority levels defined in the document.
🧰 Tools
🪛 LanguageTool
[style] ~86-~86: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...mit messages. ## AI Context Tools For very large non-source artifacts such as CI logs, d...
(EN_WEAK_ADJECTIVE)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@AGENTS.md` around lines 84 - 86, The "AI Context Tools" paragraph is placed
before the "Core MUST Rules" section but contains a MUST-level requirement; move
this paragraph under the "Core MUST Rules" header as a ### subsection named "AI
Context Tools" (or split it into two sentences under "AI Context Tools": one MAY
sentence recommending compression tools and a separate MUST sentence requiring
verification of conclusions against the original artifact) so the mandatory
language lives inside "Core MUST Rules" and the optional guidance remains
clearly marked as MAY.
1 participant
Summary
Verification
No build or test run: documentation-only AGENTS.md change.
Note
Low Risk
Documentation-only change to agent guidance; no runtime, auth, or application code affected.
Overview
Adds an AI Context Tools section to
AGENTS.mdbetween the GitHub Issues rules and Core MUST Rules. It tells agents they may use optional local helpers (e.g.chopratejas/headroom) when skimming very large non-source artifacts (CI logs, traces, huge command output), and that they must confirm anything that affects code or final statements against the original uncompressed data.Reviewed by Cursor Bugbot for commit f03509e. Bugbot is set up for automated code reviews on this repo. Configure here.
Summary by CodeRabbit