docs: canonicalize AGENTS.md as the agent guide and freshen against code#29
Draft
jack-arturo wants to merge 3 commits into
Draft
docs: canonicalize AGENTS.md as the agent guide and freshen against code#29jack-arturo wants to merge 3 commits into
jack-arturo wants to merge 3 commits into
Conversation
Promote CLAUDE.md's content to AGENTS.md (canonical, read by all agents) and reduce CLAUDE.md to the bare `@AGENTS.md` import. Mechanical only; the freshness pass follows in the next commit. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
- Enumerate all 17 MCP tools with exact names (doc previously listed none/count) - Fix npm test description (Vitest run, not "runs help command") and add real scripts - Correct pirsch_compare logic: true period totals via /statistics/total + buildComparisonTotals/pctChange, not sumSeries; generalize intro to coding agents and note @AGENTS.md import contract Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
This PR standardizes agent guidance docs by making AGENTS.md the canonical agent guide and reducing CLAUDE.md to an @AGENTS.md import, while updating the guidance to match the current codebase.
Changes:
- Replace
CLAUDE.mdcontents with a single@AGENTS.mdimport. - Add new
AGENTS.mdcontaining the consolidated agent instructions, tool inventory, and code-linked citations.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| CLAUDE.md | Replaced full guidance with an @AGENTS.md import to avoid drift. |
| AGENTS.md | Introduced canonical agent guide with architecture/tooling/env-var details and source citations. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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
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.
What & why
Adopts the fleet house standard for agent-direction files:
AGENTS.mdis the single source of truth, andCLAUDE.mdis reduced to a one-line@AGENTS.mdimport. Claude Code resolves the import at launch; every other agent (Cursor, Codex, …) readsAGENTS.md's bytes directly. Token-neutral, and it kills the silent drift between near-identical copies.This repo had no prior
AGENTS.md, so there was no duplication to remove — this is adopting the standard (consistency + future-proofing across the fleet) plus a freshness pass against the current code. Reviewers should not hunt for a divergence that never existed.Two commits
docs: adopt house standard— purely mechanical:CLAUDE.md→@AGENTS.md, establish canonicalAGENTS.md, generalize the intro line to "coding agents (Claude Code, Cursor, Codex, …)".docs: freshen AGENTS.md against current code— every factual claim re-verified against source, withpath:linecitations.Freshness changes
src/index.ts:507= 2 + 12 fromstatisticsToolConfigsat:419+ 3).pirsch_comparedescription — it does notsumSeries; it computes true period totals from/statistics/totalviabuildComparisonTotals/pctChange.npm testdescription corrected from "runs help" →vitest run.Caveats (noted for awareness — out of scope for this docs PR)
src/index.ts:359reads0.1.0whilepackage.jsonis0.1.2(note: a recent commit syncedserver.jsonto0.1.2; the in-code string still lags).Review note
Automated verification caught mechanical drift only — every tool/path/env-var named now exists in code, the tool count matches,
CLAUDE.mdis exactly@AGENTS.md. It does not judge whether the advice is still good or well-emphasized. Please read the diff for judgment. No auto-merge.🤖 Generated with Claude Code