change/content-and-fix-tables#2318
Conversation
|
|
|
Related PR for the Menu shopware/developer-portal#615 No redirects needed, recently merged |
There was a problem hiding this comment.
Pull request overview
This PR relocates and reshapes the MCP Server documentation by moving the former guide landing content into the products/tools/mcp-server/ section, polishing table formatting, and adding an examples page to demonstrate end-to-end tool workflows.
Changes:
- Moved the MCP Server landing-page content into
products/tools/mcp-server/index.mdand removed the previous guide landing page. - Added a new
Examplespage with step-by-step MCP tool call sequences. - Updated internal links, image paths, and table formatting across the MCP Server docs pages.
Reviewed changes
Copilot reviewed 8 out of 11 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| products/tools/mcp-server/troubleshooting.md | Table alignment/formatting cleanup in the quick reference section |
| products/tools/mcp-server/tools-reference.md | Adjusted JSON success example formatting in response envelope section |
| products/tools/mcp-server/shopware-extensions.md | Table alignment/formatting cleanup for merchant tool listings |
| products/tools/mcp-server/mcp-concepts.md | Updated link target for “Extending via Plugin” |
| products/tools/mcp-server/index.md | New/rewritten landing page content (architecture, limitations, section index) and nav position adjustment |
| products/tools/mcp-server/getting-started.md | Table alignment and corrected relative asset paths for screenshots |
| products/tools/mcp-server/extending.md | Updated multiple cross-links to plugin/app guides under guides/ |
| products/tools/mcp-server/examples.md | New page providing practical, step-by-step tool call workflows |
| products/tools/mcp-server/configuration.md | Corrected relative asset paths for screenshots |
| products/tools/mcp-server/best-practices.md | Corrected relative asset path for screenshot |
| guides/development/tooling/mcp-server/index.md | Removed the old guide landing page content |
Comments suppressed due to low confidence (1)
products/tools/mcp-server/tools-reference.md:19
- In the success response example,
datais an empty array but_meta.totalis42. For a paginated list response this is internally inconsistent and may confuse readers. Either show representative items indataor settotalto0whendatais empty in the example.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
Bojan Rajh (@bojanrajh) Björn Meyer (@BrocksiNet) quick reminder, we should merge this soon, otherwise the other pages get used / indexed and we have to look at redirects. Thx. |
Summary
Moved files related to this comment #2264 (comment)
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