Document MCP tool discoverability - #2398
Conversation
Developer Docs healthcheckStatus: Completed with |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: e0e000f72f
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "Codex (@codex) review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "Codex (@codex) address that feedback".
There was a problem hiding this comment.
Pull request overview
This PR updates the Shopware MCP server documentation to reflect progressive tool discovery (discovery tools + session-scoped toolsets), cursor-pagination for capability lists, and the removal of the retired MCP_SERVER setup guidance while keeping pre-6.7.14.0 compatibility notes.
Changes:
- Documented the three discovery tools and session toolset enabling flow across reference, getting-started, and troubleshooting pages.
- Updated MCP server capability/architecture docs to include Admin + Store API endpoints, toolset grouping behavior, and pagination/
listChangednotifications. - Refreshed extension/app/plugin guides and best practices to incorporate tool grouping (
#[McpToolGroup]) and deferred discovery.
Reviewed changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| products/tools/mcp-server/troubleshooting.md | Updates troubleshooting matrix for progressive discovery and allowlist behavior. |
| products/tools/mcp-server/tools-reference.md | Adds discovery tools section and toolset enable semantics to the reference. |
| products/tools/mcp-server/intro.md | Updates feature status copy, capability table, and known limitations to match new discovery/pagination behavior. |
| products/tools/mcp-server/index.md | Updates the high-level status/info box to mention both Admin + Store API MCP endpoints. |
| products/tools/mcp-server/getting-started.md | Removes feature-flag setup steps and documents the on-demand discovery/toolset flow. |
| products/tools/mcp-server/extending.md | Adds pre-6.7.14.0 compatibility note and documents grouping/toolset implications for extensions. |
| products/tools/mcp-server/configuration.md | Removes feature-flag section; documents discovery tools in allowed_tools and cursor pagination for lists. |
| products/tools/mcp-server/best-practices.md | Reframes guidance around toolsets/allowslists and adds guidance for grouping tools. |
| guides/plugins/plugins/storefront/templates/agentic-files.md | Updates wording to reflect Store API MCP availability without the feature-flag phrasing. |
| guides/plugins/plugins/mcp-server.md | Adds #[McpToolGroup] guidance and updates steps to reflect grouping/toolset discovery. |
| guides/plugins/apps/mcp-server.md | Documents app toolsets and list-changed notifications for app lifecycle changes. |
| .wordlist.txt | Adds “toolset/toolsets” to the spellcheck allowlist. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
# Conflicts: # products/tools/mcp-server/extending.md
Verified every claim against shopware/shopware trunk after the MCP discoverability epic merged, and corrected or completed what drifted: - state that both the MCP_SERVER flag removal and progressive discovery ship in 6.7.14.0, with a single version matrix in Configuration - document the toolsets core ships and how titles are generated - add the new Store API MCP page: auth, tools, rate limits, sessions, ai-catalog advertisement, and its own service tags - correct pagination details (page size 50 via the bundle's pagination_limit, invalid-cursor error, per-principal cursors) - describe how listChanged notifications are actually delivered, and that plugin lifecycle does not emit them - split the spec-gap row: resource templates are implemented, subscriptions are not; stop asserting a pinned protocol revision - document the grouped allowlist modal and the group inference rules
- qualify the fresh-session tool surface: extensions can add tools to the discovery group, so the three core discovery tools are the default, not a cap - use "toolset" consistently instead of "group" in the discovery flow - describe the tool-search query parameter as a free-text query - spell out "Streamable HTTP transport" in the capability tables
📊 Documentation Impact Analyzer
Reasons
|
Summary
Related links
Checklist
PageRefreferences where relevant..gitbook.yamlif pages were moved, renamed, or deleted..wordlist.txt(and sorted it) if spellcheck flags new legitimate terms.Notes
git diff --check.