docs: rewrite CLAUDE.md and add AGENTS.md contributor guide#928
Merged
Conversation
Architecture section replaced with a directory-level map covering all current subsystems (telemetry, community, triggers, n8n wrapper, tool-docs, skills). Commands verified against package.json: removed broken test:templates and stale migrate:fts5, added build:all, test:e2e, fetch:community, generate:docs:incremental with pointers to the MEMORY_N8N_UPDATE.md and MEMORY_TEMPLATE_UPDATE.md runbooks. Replaced retired get_node_essentials/get_node_info guidance with get_node detail levels. Removed the duplicated instruction block and version annotations, fixed the attribution spelling. 208 lines down to 100. Conceived by Romuald Członkowski - www.aiadvisors.pl/en Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Conceived by Romuald Członkowski - www.aiadvisors.pl/en
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the repository’s agent/contributor guidance to better reflect the current n8n-mcp structure and workflows around v2.64.0, and introduces a dedicated contributor guide.
Changes:
- Rewrites
CLAUDE.mdto modernize the architecture overview, development commands, and tool guidance. - Adds
AGENTS.mdas a contributor-focused guide covering structure, build/test workflows, style, and PR hygiene.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| CLAUDE.md | Modernizes agent guidance (commands, architecture map, workflow/tool guidance). |
| AGENTS.md | Adds contributor guidelines for structure, commands, style/testing, and PR/security practices. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ## Architecture | ||
|
|
||
| ### Core Components | ||
| Directory-level map of `src/`. This file intentionally stays at subsystem level — for file-level detail, explore the directories. |
| - After changing MCP server code: build, then ask the user to reload the MCP server before testing | ||
| - Run `npm run typecheck` after every code change | ||
| - Never commit directly to main — use feature branches and PRs | ||
| - Add to every commit message and PR description: `Conceived by Romuald Członkowski - www.aiadvisors.pl/en`. Never put this attribution inside file contents |
|
|
||
| ## Project Structure & Module Organization | ||
|
|
||
| Core TypeScript lives in `src/`: MCP tools in `src/mcp/`, business logic in `src/services/`, persistence in `src/database/`, and shared code in `src/types/` and `src/utils/`. Tests mirror these areas in `tests/unit/` and `tests/integration/`; supporting fixtures and mocks stay under `tests/`. React/Vite apps live in `ui-apps/src/`, utilities in `scripts/`, documentation in `docs/`, and generated skills/databases in `data/`. Treat `dist/`, coverage output, and `ui-apps/dist/` as generated. |
Mark the src/ map as non-exhaustive and add the scripts/ subsystem, scope the attribution rule to exclude file contents unambiguously, and mention src/scripts/ in the AGENTS.md project structure. Conceived by Romuald Członkowski - www.aiadvisors.pl/en Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Comment on lines
+85
to
+86
| - Never commit directly to main — use feature branches and PRs | ||
| - Add to every commit message and PR description: `Conceived by Romuald Członkowski - www.aiadvisors.pl/en`. The attribution belongs in commit messages and PR descriptions only — never in source, test, or documentation file contents |
Comment on lines
+12
to
+14
| - `npm run typecheck` (also `npm run lint`) performs strict checks without emitting. | ||
| - `npm run dev:http` rebuilds and restarts the HTTP server as sources change. | ||
| - `npm run rebuild` regenerates the node database; expect this to take several minutes. |
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.
Summary
Refreshes the two agent/contributor guidance files so they match the codebase at v2.64.0.
CLAUDE.md rewrite (208 → 100 lines)
The previous version described the codebase as it was around v2.7. Every claim in the new version is verified against the current repo:
services/listed 10 of 38 files) with a directory-level subsystem map that now coverstelemetry/,community/,triggers/,n8n/,mcp/tool-docs/, andmcp/skills/. Removed the "(NEW in v2.x)" annotations.package.json. Removed brokentest:templates(source deleted) and one-timemigrate:fts5; addedbuild:all,test:e2e,fetch:community, andgenerate:docs:incrementalwith pointers to theMEMORY_N8N_UPDATE.md/MEMORY_TEMPLATE_UPDATE.mdrunbooks.get_node_essentials()/get_node_info()advice with the currentget_nodedetail levels.AGENTS.md (new)
Adds a repository contributor guide covering project structure, build/test commands, coding style, testing thresholds, commit/PR conventions, and security notes for public-repo hygiene.
Conceived by Romuald Członkowski - www.aiadvisors.pl/en
🤖 Generated with Claude Code