Skip to content

Improve documentation#172

Merged
JReinhold merged 31 commits intomainfrom
docs
Mar 13, 2026
Merged

Improve documentation#172
JReinhold merged 31 commits intomainfrom
docs

Conversation

@JReinhold
Copy link
Copy Markdown
Contributor

@JReinhold JReinhold commented Feb 24, 2026

This PR improves the documentation for all the MCP packages.

  • Introduces a new self-hosting example app for @storybook/mcp, demonstrating how to run your own Storybook MCP server in a Node.js process or Netlify Functions.
  • Added first draft of self-hosting docs that are meant to be added to the docs-site
  • Package READMEs are simplified to prioritize docs-site-first documentation. The existing README for addon-mcp has been temporarily moved to docs.md, so it can be used as a reference for writing the docs on the docs-site

~Both docs.md and self-hosting.md should be deleted when they have been migrated to the docs-site.~✅

Copilot AI review requested due to automatic review settings February 24, 2026 08:50
@netlify
Copy link
Copy Markdown

netlify bot commented Feb 24, 2026

Deploy Preview for storybook-mcp-self-host-example ready!

Name Link
🔨 Latest commit 5af6b6d
🔍 Latest deploy log https://app.netlify.com/projects/storybook-mcp-self-host-example/deploys/69b3defe19cd590008cae639
😎 Deploy Preview https://deploy-preview-172--storybook-mcp-self-host-example.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Feb 24, 2026

🦋 Changeset detected

Latest commit: 5af6b6d

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages
Name Type
@storybook/addon-mcp Patch
@storybook/mcp Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@pkg-pr-new
Copy link
Copy Markdown

pkg-pr-new bot commented Feb 24, 2026

npm i https://pkg.pr.new/storybookjs/mcp/@storybook/addon-mcp@172
npm i https://pkg.pr.new/storybookjs/mcp/@storybook/mcp@172

commit: 5af6b6d

@JReinhold JReinhold self-assigned this Feb 24, 2026
@JReinhold JReinhold added the documentation Improvements or additions to documentation label Feb 24, 2026
@codecov
Copy link
Copy Markdown

codecov bot commented Feb 24, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 73.74%. Comparing base (fd88a99) to head (5af6b6d).
⚠️ Report is 34 commits behind head on main.
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #172   +/-   ##
=======================================
  Coverage   73.74%   73.74%           
=======================================
  Files          42       42           
  Lines        1177     1177           
  Branches      330      330           
=======================================
  Hits          868      868           
  Misses        193      193           
  Partials      116      116           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@JReinhold JReinhold requested a review from kylegach February 24, 2026 08:51
@codecov
Copy link
Copy Markdown

codecov bot commented Feb 24, 2026

Bundle Report

Changes will increase total bundle size by 65.45kB (147.95%) ⬆️⚠️, exceeding the configured threshold of 5%.

Bundle name Size Change
@storybook/addon-mcp-esm* 65.45kB 65.45kB (100%) ⬆️⚠️

ℹ️ *Bundle size includes cached data from a previous commit

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR improves documentation across the MCP packages by introducing a docs-site-first approach. The changes simplify package READMEs and add comprehensive self-hosting documentation and examples.

Changes:

  • Added a new self-hosting example app (apps/self-host-mcp) demonstrating Node.js and Netlify Functions deployment of @storybook/mcp
  • Created draft self-hosting documentation (packages/mcp/self-hosting.md) with API reference and implementation examples
  • Simplified package READMEs to point to future docs site (marked with "TK" placeholders)
  • Moved existing addon README content to packages/addon-mcp/docs.md for reference during docs site migration

Reviewed changes

Copilot reviewed 13 out of 14 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
packages/mcp/self-hosting.md New comprehensive API documentation and self-hosting guide
packages/mcp/README.md Simplified to single sentence with docs link placeholder
packages/addon-mcp/docs.md Original README content moved here for migration reference
packages/addon-mcp/README.md Simplified to brief description with docs link placeholder
apps/self-host-mcp/server.ts Example Node.js server implementation with manifest provider
apps/self-host-mcp/netlify/functions/mcp.ts Netlify Functions adapter for the MCP handler
apps/self-host-mcp/package.json Standalone example package configuration
apps/self-host-mcp/README.md Example app documentation and usage instructions
apps/self-host-mcp/manifests/*.json Sample manifest files for testing
apps/self-host-mcp/netlify.toml Netlify deployment configuration
apps/self-host-mcp/tsconfig.json TypeScript configuration for example
apps/self-host-mcp/pnpm-lock.yaml Lockfile for standalone dependencies
.changeset/bright-masks-hunt.md Changeset describing README simplification
Files not reviewed (1)
  • apps/self-host-mcp/pnpm-lock.yaml: Language not supported

Comment thread apps/self-host-mcp/README.md Outdated
Comment thread packages/mcp/self-hosting.md Outdated
Comment thread packages/mcp/self-hosting.md Outdated
Comment thread packages/mcp/self-hosting.md Outdated
Comment thread packages/addon-mcp/docs.md Outdated
kylegach added 3 commits March 9, 2026 10:50
* main: (34 commits)
  Version Packages
  add back flag while core hasn't been released yet
  test: make /mcp GET handler selection explicit
  Apply suggestion from @JReinhold
  add changeset
  cleanup tests
  docs: clarify both flag names for older/newer Storybook in README and 404 hint
  docs: reflect that componentsManifest defaults to true and can be omitted
  feat: rename experimentalComponentsManifest → componentsManifest with backwards compat
  Initial plan
  test: format preset test assertions
  fix addon mcp page messaging and redirect behavior
  Initial plan
  Version Packages
  add more tests
  update task readmes
  update storybook
  improve preview stories tool description to make agents output the URLs to the user every time.
  Update eval/tasks/915-preview-story-by-id/README.md
  upgrade storybook
  ...
Copilot AI review requested due to automatic review settings March 10, 2026 21:44
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 11 out of 12 changed files in this pull request and generated 2 comments.

Files not reviewed (1)
  • apps/self-host-mcp/pnpm-lock.yaml: Language not supported

Comment thread packages/mcp/README.md Outdated
Comment thread apps/self-host-mcp/package.json
Copilot AI review requested due to automatic review settings March 12, 2026 15:07
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 11 out of 12 changed files in this pull request and generated 3 comments.


You can also share your feedback on Copilot code review. Take the survey.

Comment thread packages/mcp/README.md Outdated
Comment thread packages/addon-mcp/README.md
Comment thread packages/mcp/README.md
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings March 13, 2026 09:13
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 11 out of 12 changed files in this pull request and generated 2 comments.


You can also share your feedback on Copilot code review. Take the survey.

Comment thread apps/self-host-mcp/netlify/functions/mcp.ts
Comment thread packages/mcp/README.md
Copilot AI review requested due to automatic review settings March 13, 2026 09:35
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 11 out of 12 changed files in this pull request and generated no new comments.

Files not reviewed (1)
  • apps/self-host-mcp/pnpm-lock.yaml: Language not supported

You can also share your feedback on Copilot code review. Take the survey.

Copilot AI review requested due to automatic review settings March 13, 2026 09:40
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 11 out of 12 changed files in this pull request and generated 2 comments.

Files not reviewed (1)
  • apps/self-host-mcp/pnpm-lock.yaml: Language not supported

You can also share your feedback on Copilot code review. Take the survey.

Comment thread apps/self-host-mcp/server.ts Outdated
Comment thread apps/self-host-mcp/netlify/functions/mcp.ts
Copilot AI review requested due to automatic review settings March 13, 2026 09:54
@JReinhold JReinhold merged commit 8f51e2e into main Mar 13, 2026
13 checks passed
@JReinhold JReinhold deleted the docs branch March 13, 2026 09:56
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 11 out of 12 changed files in this pull request and generated no new comments.

Files not reviewed (1)
  • apps/self-host-mcp/pnpm-lock.yaml: Language not supported

You can also share your feedback on Copilot code review. Take the survey.

@storybook-app-bot storybook-app-bot bot mentioned this pull request Mar 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants