Provides a read-only, offline filesystem view of curated Shopware developer and merchant documentation for AI coding agents.
Also known as execuro/sw-dev-kb-factory, sw-dev-kb-factory, @execuro-sw-ecosystem/sw-dev-knowledge-base-mcp
- Stars
- 0
- Tools
- 4
- Downloads, 30 days
- 561
- Latest version
- 0.1.7
- Last commit
- Oct 21, 2026
- License
- MIT
What is Shopware Dev Knowledge Base MCP?
Shopware Dev Knowledge Base provides a read-only, offline filesystem view of curated Shopware developer and merchant documentation for AI coding agents. It exposes 4 tools, such as list_docs, grep_docs, read_doc.
Summary generated from the project's README
About Shopware Dev Knowledge Base MCP server
Providing an offline, read-only view of Shopware documentation to AI coding agents is what this MCP server enables. It allows developers to integrate a curated knowledge base directly into their coding sessions using standard filesystem-style operations. Because the documentation corpus is bundled within the package, the server operates entirely without a network connection or external API keys at runtime.
Users interact with the server through tools that mimic shell commands like list_docs, grep_docs, and read_doc. These tools allow an agent to navigate directory entries, search for specific lines of text across Markdown files, and read specific pages or line ranges. The server is configured as a stdio server via npx and can be customized to serve different wiki roots or project-specific layers.
This setup is ideal for developers working with Shopware 6.6 or 6.7 who need reliable, local access to developer and merchant documentation. By providing a filesystem view over plain Markdown, it ensures that the AI agent can find technical guidelines and topic hubs without the latency or privacy concerns of a web-based search engine.
What you can do with it
- 1Reading specific documentation pagesAn AI agent can retrieve the full content of a specific documentation page to answer technical implementation questions.
- 2Verifying knowledge base statusA developer can check which documentation layers and versions are currently being served by the server.
Written from the project's README. Every use case is checked against a quote from it.
How to install Shopware Dev Knowledge Base MCP
Formats verified 10 Nov 2026Add to CursorAdd to GooseInstall Shopware Dev Knowledge Base MCP in Claude Code
$ claude mcp add sw-dev-kb-factory -- npx -y @execuro-sw-ecosystem/sw-dev-knowledge-base-mcpInstall Shopware Dev Knowledge Base MCP in Cursor
~/.cursor/mcp.json
{
"mcpServers": {
"sw-dev-kb-factory": {
"command": "npx",
"args": [
"-y",
"@execuro-sw-ecosystem/sw-dev-knowledge-base-mcp"
]
}
}
}Install Shopware Dev Knowledge Base MCP in VS Code
.vscode/mcp.json
{
"servers": {
"sw-dev-kb-factory": {
"type": "stdio",
"command": "npx",
"args": [
"-y",
"@execuro-sw-ecosystem/sw-dev-knowledge-base-mcp"
]
}
}
}Install Shopware Dev Knowledge Base MCP in VS Code CLI
$ code --add-mcp '{"name":"sw-dev-kb-factory","type":"stdio","command":"npx","args":["-y","@execuro-sw-ecosystem/sw-dev-knowledge-base-mcp"]}'Install Shopware Dev Knowledge Base MCP in Claude Desktop
claude_desktop_config.json
{
"mcpServers": {
"sw-dev-kb-factory": {
"command": "npx",
"args": [
"-y",
"@execuro-sw-ecosystem/sw-dev-knowledge-base-mcp"
]
}
}
}Install Shopware Dev Knowledge Base MCP in Codex
$ codex mcp add sw-dev-kb-factory -- npx -y @execuro-sw-ecosystem/sw-dev-knowledge-base-mcpInstall Shopware Dev Knowledge Base MCP in Codex config.toml
~/.codex/config.toml
[mcp_servers.sw-dev-kb-factory] command = "npx" args = ["-y", "@execuro-sw-ecosystem/sw-dev-knowledge-base-mcp"]
Install Shopware Dev Knowledge Base MCP in Gemini CLI
$ gemini mcp add -s user sw-dev-kb-factory npx -- -y @execuro-sw-ecosystem/sw-dev-knowledge-base-mcpInstall Shopware Dev Knowledge Base MCP in Gemini settings.json
~/.gemini/settings.json
{
"mcpServers": {
"sw-dev-kb-factory": {
"command": "npx",
"args": [
"-y",
"@execuro-sw-ecosystem/sw-dev-knowledge-base-mcp"
]
}
}
}Shopware Dev Knowledge Base MCP tools 4
Detected from the READMElist_docsgrep_docsread_dockb_status
| list_docs | — | |
| grep_docs | — | |
| read_doc | — | |
| kb_status | — |
Automated checks
Ran Nov 14, 2026Full report →Passed our automated checks. That is not a security audit: read the code and give the server the narrowest access it needs. How checks work
- Source repository linked and reachableexecuro/sw-dev-kb-factory is public and reachablegithub.com/execuro/sw-dev-kb-factory ↗Pass
- Package names this repository as its source@execuro-sw-ecosystem/sw-dev-knowledge-base-mcp names execuro/sw-dev-kb-factory as sourcenpmjs.com/package/@execuro-sw-ecosystem/sw-dev-knowledge-bas ↗Pass
- Build provenance (Sigstore attestation)Sigstore attestation for @execuro-sw-ecosystem/sw-dev-knowledge-base-mcpnpmjs.com/package/@execuro-sw-ecosystem/sw-dev-knowledge-bas ↗Pass
- Open source license (OSI)MITspdx.org/licenses/MIT.html ↗Pass
- Commit or release in the last yearLast commit or release 2026-10-21github.com/execuro/sw-dev-kb-factory ↗Pass
- OpenSSF ScorecardNot checked
- Package name not close to a popular packageNo popular package one edit away from @execuro-sw-ecosystem/sw-dev-knowledge-base-mcpPass
- No critical advisory in the package or its dependencies1 resolved dependencies checked; no critical advisoryosv.dev ↗Pass
- No hidden instructions to the model4 tool descriptions and the README read; no override phrases, credential paths or hidden charactersPass
- Destructive tools are labelledNo tool named like delete, drop or execPass
- Remote endpoint answers the MCP handshakeNot checked
README
View on GitHubsw-dev-knowledge-base-mcp
A read-only, offline MCP server that lets a coding agent
ls/grep/cat a curated Shopware developer and merchant knowledge base without leaving its
session — plus the factory that builds that knowledge base.
The corpus ships inside the package, so the server needs no network at runtime, no API key and no index: it is a filesystem view over plain Markdown.
Install
npx -y @execuro-sw-ecosystem/sw-dev-knowledge-base-mcp@<version>
Node >= 20. The published package declares no dependencies — its two third-party libraries,
@modelcontextprotocol/sdk and
zod, are inlined into dist/server.js, and every other import is a node:
builtin. Their licences are in
THIRD-PARTY-NOTICES.md.
Configure it as an MCP server
Register it as a stdio server. In an .mcp.json-style client configuration:
{
"mcpServers": {
"ShopwareDevKnowledgeBase": {
"command": "npx",
"args": ["-y", "@execuro-sw-ecosystem/sw-dev-knowledge-base-mcp@<version>"]
}
}
}
Pin an exact version: the corpus is part of the package, so the version is the content.
Options, all optional:
| Flag | Environment variable | Effect |
|---|---|---|
--wiki-root <dir> |
WIKI_ROOT |
Serve an arbitrary wiki root instead of the packaged wiki/ |
--corpus <name> |
KB_CORPUS |
Select a corpus defined in kb.config.json (the package ships only wiki) |
--project-wiki <dir> |
KB_PROJECT_WIKI |
Add your own project wiki as a project layer; off disables it |
The tools it exposes
| Tool | Shell equivalent | What it returns |
|---|---|---|
list_docs |
ls (with depth, glob) |
Directory entries, titles from frontmatter, the directory's index.md |
grep_docs |
grep -rin over *.md |
Match lines with context, or files/count modes |
read_doc |
cat / sed -n |
A page or line range, its frontmatter and a citable path:from-to |
kb_status |
cat <layer>/manifest.json |
Which layers and corpus are served, with provenance and counts |
Line numbers are identical to the shell's, so a grep_docs hit pages straight into read_doc.
There is no ranking and no search engine: discovery quality comes from the corpus's own index.md
lines, keywords, hubs and synonyms file. The server writes nothing and opens no network
connection.
What is in the corpus
wiki/platform/ — a retrieval-oriented rewrite of Shopware's official documentation: developer
docs for 6.6 and 6.7, merchant/functional docs, topic hub pages, curated per-version guideline
files and a synonyms index. It is path-addressed: version and doc type are directories
(platform/dev/6.7/…, platform/func/…), never parameters. wiki/README.md describes the layout
and how to navigate it with a plain shell.
The published tarball is 2.7 MB (10.0 MB unpacked, 2006 files); its top level is exactly
LICENSE README.md THIRD-PARTY-NOTICES.md dist kb.config.json package.json wiki.
Working on this repository
End users never clone this repository — it is the factory that produces the package above:
| Path | What it is |
|---|---|
src/ |
MCP server source (builds dist/server.js) |
ingest/ |
The deterministic ingest CLI: sync, pages, hubs, guidelines, build, synonyms, lint |
wiki/ |
The generated documentation corpus — never hand-edited, except wiki/platform/index.md |
test/ |
Server and ingest test suite (node --test): 465 tests, zero skips |
scripts/ |
setup-sources.mjs, setup-docs.mjs, pack.mjs |
docs/ |
Maintainer guides — see Documentation |
.claude/ |
kb-factory-* skills, pinned writer/verify agents, and the two kb-verify-* hooks |
.sources/ |
Gitignored, created by npm run setup — pinned Shopware source and docs clones |
npm ci
npm run setup # fetches .sources/ — see "One-time setup" below
npm run build # typecheck + bundle src/ -> dist/server.js
npm test # build, then the full test suite
npm run wiki:lint # blocking schema/link/id/size checks over wiki/platform/
Run /kb-factory-setup (a Claude Code skill, see CONTRIBUTING.md) once per clone
before running the verify suite or an ingest writer — it installs the two hooks that keep each
agent inside its own corpus, without which neither is trustworthy.
One-time setup — what npm run setup actually does
npm run setup fetches two things you did not ask for by name into a gitignored .sources/:
- ~250 MB of pinned Shopware source (
.sources/shopware/<version>/, a sparse tag-pinned git checkout — not acomposer install, no PHP needed) that the code check and code-evidence lanes read. - ~1 GB of official documentation clones (
.sources/docs/{developer,merchant}/) that thedocstest corpus serves.
It is idempotent, resumable and an offline no-op once satisfied. The merchant documentation
mirror is a private repository. On a host without access, setup prints what is unavailable and
continues — that is deliberate: a missing optional input degrades the run rather than failing it,
and the committed wiki/platform/func/ layer stays usable either way. Full detail:
docs/sources.md.
Documentation
docs/producer-manual.md— building, code-checking, verifying and shipping the corpus; the full skill-driven ingest workflow.docs/sources.md— what.sources/holds and hownpm run setupbuilds it.docs/releasing.md— npm setup, tagging, publishing and post-publish verification.CONTRIBUTING.md— toolchain, test/lint gates, CI's zero-skips rule.CHANGELOG.md— Keep a Changelog format.THIRD-PARTY-NOTICES.md— licences of the code inlined intodist/server.js.
Licence
MIT, Execuro UG (haftungsbeschränkt). See THIRD-PARTY-NOTICES.md
for the licences of the third-party code inlined into dist/server.js.
Shopware Dev Knowledge Base MCP questions
How do I add Shopware Dev Knowledge Base MCP to Claude Code?
Run claude mcp add sw-dev-kb-factory -- npx -y @execuro-sw-ecosystem/sw-dev-knowledge-base-mcp in your terminal. Add --scope user to make it available in every project.
How do I add Shopware Dev Knowledge Base MCP to Cursor?
Open ~/.cursor/mcp.json and add the server under mcpServers, using the Cursor config shown in the install section above.
What tools does Shopware Dev Knowledge Base MCP provide?
It exposes 4 tools, including list_docs, grep_docs, read_doc, kb_status.
Does this server require an internet connection or API key?
No, the server is offline and requires no API key because the corpus is included directly in the package.
Can I use my own documentation with this server?
Yes, you can add your own project wiki as a layer using the --project-wiki flag.