Skip to content

docs: add MCP server documentation#2264

Draft
Björn Meyer (BrocksiNet) wants to merge 7 commits intomainfrom
feat/mcp-server-documentation
Draft

docs: add MCP server documentation#2264
Björn Meyer (BrocksiNet) wants to merge 7 commits intomainfrom
feat/mcp-server-documentation

Conversation

@BrocksiNet
Copy link
Copy Markdown
Contributor

Summary

Adds complete documentation for Shopware's native MCP server introduced in 6.7:

  • guides/development/tooling/mcp-server/ — 8 pages covering concepts, getting started, configuration, best practices, examples, troubleshooting, tools reference, and Shopware extensions (Copilot, SwagMcpMerchantAssistant, SwagMcpDevTools, ai-coding-tools)
  • guides/plugins/plugins/mcp-server.md — how-to for extending via plugin
  • guides/plugins/apps/mcp-server.md — how-to for extending via app (webhook)
  • 4 Admin UI screenshots for tool allowlist and ACL privilege flows
  • Navigation entries in tooling, plugins, apps, and extensions indexes

Related links

relates: shopware/shopware#15346

Checklist

  • I reviewed affected links, code samples, and cross-references, including PageRef references where relevant.
  • I added or updated redirects in .gitbook.yaml if pages were moved, renamed, or deleted.
  • I updated .wordlist.txt (and sorted it) if spellcheck flags new legitimate terms.
  • Any required dependent changes in downstream modules have already been merged and published.
  • This pull request is ready for review.

Notes

Adds complete documentation for Shopware's native MCP server introduced
in 6.7:

- guides/development/tooling/mcp-server/ — 8 pages covering concepts,
  getting started, configuration, best practices, examples,
  troubleshooting,
  tools reference, and Shopware extensions (Copilot,
  SwagMcpMerchantAssistant,
  SwagMcpDevTools, ai-coding-tools)
- guides/plugins/plugins/mcp-server.md — how-to for extending via plugin
- guides/plugins/apps/mcp-server.md — how-to for extending via app
  (webhook)
- 4 Admin UI screenshots for tool allowlist and ACL privilege flows
- Navigation entries in tooling, plugins, apps, and extensions indexes
references

- Fix McpContextProvider namespace (Context\ sub-namespace) and
  requirePrivilege return value pattern in plugin sample code
- Fix shopware-media-upload has no dryRun, theme-config action/config
  defaults, debug:mcp column list, tool count claim
- Add extending.md: side-by-side quick reference for
  tools/prompts/resources across app, plugin, and bundle
- Add webhook handler examples for prompts and resources in
  apps/mcp-server.md
- Link SwagMcpAdminUsers and McpHelloWorld example repos in plugin and
  app docs
- Expand MCP acronym on first use in mcp-concepts.md, fix lowercase mcp
  in headings to use backticks
- Fix duplicate heading in shopware-extensions.md
- Document required-privileges in app mcp.xml (informational only;
  apps must enforce ACL themselves)
- Add array/object to supported input schema property types
- Add internal URL mode (url="/...") for routing to app scripts
- Document integration.mcp_tool_allowlist semantics (null/array/empty)
- Replace stale mcp.yaml snippet with mcp.php note; clarify the bundle
  loads automatically when MCP_SERVER feature flag is active
- Add --integration flag to debug:mcp; remove non-existent --all flag
- Add Symfony bundle stub guide
reference

- Add three new subsections to best-practices.md: writing descriptions
  for agent
  routing, the DI container cache requirement after description changes,
  and using
  the system prompt as the disambiguation override layer
- Fix shopware-theme-config salesChannelId row in tools-reference.md to
  reflect
  that it is optional in the schema and validated at runtime
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.

1 participant