docs: canonicalize AGENTS.md as the agent guide and freshen against code#4
Merged
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>
- Correct tool count to exact 41 (was "~35"/"~42"), list all 41 names grouped by the 9 tool modules with real per-module counts (media is 4 not ~5; tool names taken from code, not the drifted README) - Fix logging claim: logs go to stderr via logToFile() gated by WORDPRESS_LOG_LEVEL/DISABLE_LOGGING, not to logs/wordpress-api.log (removed both false file-log mentions) - Add missing env vars (WORDPRESS_LOG_LEVEL, DISABLE_LOGGING, WORDPRESS_SQL_ENDPOINT, WORDPRESS_CACHE_DURATION, WORDPRESS_PARALLEL_SEARCH, UNIFIED_CONTENT_CACHE_DIR), note McpServer class + dynamic registration and src/cli.ts launcher, add verified path:line citations, generalize intro to coding agents Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Adopts the repository “house standard” for agent-direction docs by making AGENTS.md the canonical agent guide and reducing CLAUDE.md to a one-line @AGENTS.md import, plus a refresh pass to align the new guide with the current codebase.
Changes:
- Replaced the full
CLAUDE.mdguide content with a one-line@AGENTS.mdimport. - Added a new canonical
AGENTS.mdagent guide (build/dev commands, env vars, architecture, tool inventory) with code-referenced details.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
CLAUDE.md |
Converted to a one-line import pointing at AGENTS.md. |
AGENTS.md |
Added canonical agent guide; documents commands, configuration, architecture, and tool catalog. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…tion 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
logToFile()(src/wordpress.ts:20), not tologs/wordpress-api.log.get_media/update_media).search_plugin_repository,get_plugin_details.WORDPRESS_LOG_LEVEL,DISABLE_LOGGING,WORDPRESS_SQL_ENDPOINT,WORDPRESS_CACHE_DURATION,WORDPRESS_PARALLEL_SEARCH,UNIFIED_CONTENT_CACHE_DIR.Caveats (noted for awareness — out of scope for this docs PR)
src/cli.ts:14checksWORDPRESS_APP_PASSWORD, but nothing sets it (the rest of the code usesWORDPRESS_PASSWORD). This looks like a real bug;cli.tsis not the bin entry, so it is left untouched here.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