[Mate][Platform] Make AGENTS.md the canonical AI-agent guidance, slim CLAUDE.md#2101
Open
wachterjohannes wants to merge 2 commits into
Open
[Mate][Platform] Make AGENTS.md the canonical AI-agent guidance, slim CLAUDE.md#2101wachterjohannes wants to merge 2 commits into
wachterjohannes wants to merge 2 commits into
Conversation
Applies the same pattern as symfony#2054 for the Platform component: AGENTS.md carries the canonical, general AI-agent guidance and CLAUDE.md is reduced to a header plus an `@AGENTS.md` Claude Code import. The two bits that were only in CLAUDE.md (the `src/EventListener/` directory entry and the mixed-content `UserMessage` template example) are moved into AGENTS.md so nothing is lost.
The section duplicated content already in AGENTS.md and described end-user runtime wiring rather than Claude Code-specific dev guidance: - The "Mate is consumed as an MCP server / mcp.json auto-pickup" paragraph describes how end users wire Mate into Claude Code, not how Claude Code helps develop Mate. That belongs in user-facing docs (README / INSTRUCTIONS.md). - The "sources of truth for available MCP tools" paragraph is already covered by AGENTS.md's "Agent Instructions Materialization" section, and the guidance applies to any AI agent — not specifically to Claude Code. CLAUDE.md is now just the header plus the `@AGENTS.md` import, matching the shape of the other components.
wachterjohannes
requested review from
Nyholm,
OskarStark and
chr-hertel
as code owners
carsonbot
added
Mate
carsonbot
changed the title
Contributor
Author
|
@chr-hertel when we accept to adopt this pattern i will create an additional PR for all the other components with the same pattern |
Member
|
but do we really need this if there are no claude specifics? |
Contributor
Author
yes because claude.md is the entry point of claude code BUT others use agents.md so to make sure all xosing agents load the instructiona we have to keep both |
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
3 participants
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.
Follow-up to #2054, applying the same pattern more broadly.
[Platform]Make AGENTS.md canonical, reduce CLAUDE.md to importsrc/platform/AGENTS.mdnow carries the canonical, general AI-agent guidance for the Platform component, andsrc/platform/CLAUDE.mdis reduced to a header plus an@AGENTS.mdClaude Code import.The two bits that previously lived only in
CLAUDE.mdare moved intoAGENTS.mdso nothing is lost:src/EventListener/directory entry (withTemplateRendererListener)UserMessagetemplate exampleNo Claude Code-specific section was added — unlike Mate (which is itself an MCP server consumed by Claude Code), Platform is a plain library with nothing dev-tool-specific to call out. The
Bridge/ClaudeCode/bridge is just one bridge among many and is covered inAGENTS.mdlike the others.[Mate]Drop redundant Claude Code Specifics sectionThe
## Claude Code Specificssection insrc/mate/CLAUDE.mdintroduced by #2054 turns out to be redundant on closer reading:mcp.jsonauto-pickup" describes how end users wire Mate into Claude Code at runtime, not how Claude Code helps you develop on the Mate codebase. That's user-facing docs material (README / INSTRUCTIONS.md), not dev-tool guidance.AGENTS.mdunder## Agent Instructions Materialization, and the guidance applies to any AI agent — not specifically to Claude Code.After this PR
src/mate/CLAUDE.mdis just header +@AGENTS.mdimport, matching the shape adopted for Platform here.