Skip to content

docs: reposition README around the production-operations direction (#902)#905

Open
czlonkowski wants to merge 1 commit into
mainfrom
docs/readme-repositioning-902
Open

docs: reposition README around the production-operations direction (#902)#905
czlonkowski wants to merge 1 commit into
mainfrom
docs/readme-repositioning-902

Conversation

@czlonkowski

Copy link
Copy Markdown
Owner

Summary

Repositions the README in line with the direction announced in Discussion #900: the official n8n MCP owns workflow authoring; n8n-mcp is the production-operations layer. Part of #902.

What changed

  • New lead paragraph — the project is introduced as an MCP server for running n8n workflows in production (validation, editing, debugging, versions, audit), with node documentation as the supporting knowledge layer. The old "comprehensive access to node documentation" bridge framing is retired.
  • New "Which MCP server should I use?" section near the top — "run both" framing with a measured comparison table, honest about the official server's advantages (drafting, publish lifecycle, folders, pin-data). Links Discussion #900 and the July 2026 competitive analysis.
  • Token-multiple claims explicitly retired — the section states that per-edit costs are now equal on current n8n versions (509 vs ~492 chars, measured). Only the surviving, scoped claims remain: validation honesty (five probes), patchNodeField surgical edits (5.3× on a ~1 KB field, scales with field size), community-node coverage. An audit of docs/ found no other stale multiples — the June analysis containing them was already replaced by the July edition.
  • Feature presentation reordered lifecycle-first — the Overview now leads with production-lifecycle capabilities (validation, autofix, diff editing, versions, executions, testing, audit, credentials) before the knowledge-layer stats; the MCP tools section now lists the 16 production-lifecycle tools before the 7 offline documentation/validation tools.
  • Maintainer consulting CTA added — "Work with the Maintainer" section linking AiAdvisors, placed after the sponsor block.
  • July 2026 competitive analysis linked from both the README Documentation section and docs/README.md.

Remaining manual step (not automatable)

Acceptance check

A first-time visitor sees, within the first screen: what the project is for today (lead paragraph), how it relates to the official MCP server ("Which MCP server should I use?"), and where it is going (link to #900).

Concieved by Romuald Członkowski - www.aiadvisors.pl/en

🤖 Generated with Claude Code

…oncieved by Romuald Członkowski - www.aiadvisors.pl/en)

- Lead with the production-lifecycle positioning; retire the node-docs-bridge framing
- Add 'Which MCP server should I use?' run-both section with measured claims,
  linking Discussion #900 and the July 2026 competitive analysis
- Explicitly retire the per-edit token-multiple claim for current n8n versions;
  keep only measured surviving claims (validation honesty, patchNodeField 5.3x,
  community-node coverage)
- Reorder features and MCP tools lifecycle-first (validation, versions,
  executions, autofix, audit before node documentation)
- Add AiAdvisors consulting CTA
- Link the July 2026 competitive analysis from both doc indexes

Part of #902

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings July 2, 2026 14:10

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates the project’s top-level documentation to reflect the “production-operations layer” positioning: n8n-mcp is presented primarily as the operational lifecycle toolkit for running workflows in production, while the official n8n MCP server is framed as the primary workflow-authoring path.

Changes:

  • Rewrites the README introduction and Overview to lead with production-lifecycle capabilities (validation, diff/surgical edits, debugging, versions, audit, credentials), with node documentation as the supporting layer.
  • Adds an early “Which MCP server should I use?” section with a comparison table and links to Discussion #900 and the July 2026 competitive analysis.
  • Adds a maintainer consulting CTA and links the July 2026 competitive analysis from both README locations (root + docs index).

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
README.md Repositions the project narrative toward production operations, adds official-vs-n8n-mcp guidance, reorders feature/tool presentation, and adds maintainer CTA + competitive analysis link.
docs/README.md Adds a reference link to the July 2026 competitive analysis.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants