Skip to content

@W-21197996 Update MCP docs#217

Merged
yhsieh1 merged 3 commits intomainfrom
t/commerce/W-21197996/update-docs
Feb 26, 2026
Merged

@W-21197996 Update MCP docs#217
yhsieh1 merged 3 commits intomainfrom
t/commerce/W-21197996/update-docs

Conversation

@yhsieh1
Copy link
Contributor

@yhsieh1 yhsieh1 commented Feb 26, 2026

Summary

Update MCP docs to:

  • Add MCP tool reference documentation for pwakit_development_guidelines and storefront_next_development_guidelines;
  • MCP Server sidebar
  • Tools Referenc
  • nav updates in config

Testing

  • pnpm docs:dev
  • verify MCP docs shows in side bar and top nav
  • verify pwakit_development_guidelines and storefront_next_development_guidelines content and links from toolsets are correct
Screenshot 2026-02-26 at 3 44 14 PM Screenshot 2026-02-26 at 3 44 27 PM

Dependencies

  • No net-new third-party dependencies were added
  • If net-new third-party dependencies were added, rationale/discussion is included and 3pl-approved is set by a maintainer

  • Tests pass (pnpm test)
  • Code is formatted (pnpm run format)

Copy link
Contributor

@patricksullivansf patricksullivansf left a comment

Choose a reason for hiding this comment

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

Tested locally and links work. Page content looks good. Minor suggestions.

Comment on lines +94 to +100
## Content Structure

Content is loaded from markdown files in the MCP package (`packages/b2c-dx-mcp/content/pwav3/`). Each section is a separate file (~100–200 lines), enabling:

- **Token efficiency**: Returns only relevant content (200–500 lines vs 20K+ full doc).
- **Modular access**: Request specific sections as needed.
- **Multi-select**: Combine related sections in a single call for contextual learning.
Copy link
Contributor

Choose a reason for hiding this comment

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

This might be an internal implementation detail? If so I would recommend removing it from these user facing docs.

Comment on lines +97 to +103
## Content Structure

Content is loaded from markdown files in the MCP package (`packages/b2c-dx-mcp/content/sfnext/`). Each section is a separate file (~100–200 lines), enabling:

- **Token efficiency**: Returns only relevant content (200–500 lines vs 20K+ full doc).
- **Modular access**: Request specific sections as needed.
- **Multi-select**: Combine related sections in a single call for contextual learning.
Copy link
Contributor

Choose a reason for hiding this comment

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

same suggestion, is this user facing?

|---------|----------------|
| `quick-reference` | Critical rules, architecture principles, quick patterns |
| `components` | Component patterns, Chakra UI, special components (_app, _app-config, _error), React Hooks |
| `data-fetching` | commerce-sdk-react hooks, useCustomQuery/useCustomMutation, React Query, custom APIs, caching |
Copy link
Contributor

Choose a reason for hiding this comment

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

Consider re-ordering these so the strange lack of starting capitalization relative to other lists is avoided.

| `state-management` | State management patterns |
| `auth` | Authentication and session management |
| `config` | Configuration system |
| `i18n` | i18n patterns and internationalization |
Copy link
Contributor

Choose a reason for hiding this comment

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

this one also has odd capitalization, but I've no suggestion about mitigating it.

@yhsieh1 yhsieh1 merged commit eee5dbc into main Feb 26, 2026
4 checks passed
@yhsieh1 yhsieh1 deleted the t/commerce/W-21197996/update-docs branch February 26, 2026 21:31
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