Skip to content

Commit e8abd86

Browse files
authored
Merge pull request #16 from storybookjs/shilman/improve-readme
Improve README and package description
2 parents 5547615 + 53b53a2 commit e8abd86

File tree

3 files changed

+12
-3
lines changed

3 files changed

+12
-3
lines changed

.changeset/three-buckets-serve.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"@storybook/addon-mcp": patch
3+
---
4+
5+
Improve README

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
# Storybook MCP Addon
22

3-
This Storybook addon provides an MCP (Model Context Protocol) server, enabling AI agents to interact with your Storybook instance. The addon currently allows agents to get UI development instructions and retrieve story URLs directly from your running Storybook.
3+
This Storybook addon runs an MCP (Model Context Protocol) server to help develop UI components more efficiently.
4+
5+
It enables a workflow where for each UI component created, the agent will automatically generate and link to example stories. These stories let you visually verify the new UI in each of its key states, and provides documentation and component tests.
6+
7+
The server currently exposes two tools: one to provides UI development instructions to the agent, and the other to retrieve story URLs directly from your runnng Storybook.
48

59
> [!IMPORTANT]
610
> This addon currently only supports Vite-based Storybook setups, such as [`@storybook/react-vite`](https://storybook.js.org/docs/get-started/frameworks/react-vite), [`@storybook/nextjs-vite`](https://storybook.js.org/docs/get-started/frameworks/nextjs#with-vite), and [`@storybook/sveltekit`](https://storybook.js.org/docs/get-started/frameworks/sveltekit).

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
{
22
"name": "@storybook/addon-mcp",
33
"version": "0.0.4",
4-
"description": "everything you need to build a Storybook addon",
4+
"description": "Help agents automatically write and test stories for your UI components",
55
"keywords": [
6-
"storybook-addons",
6+
"storybook-addon",
77
"mcp",
88
"ai"
99
],

0 commit comments

Comments
 (0)