Skip to content

Commit 4d38edd

Browse files
authored
Clarify MCP docs (#868)
1 parent a7f86cb commit 4d38edd

1 file changed

Lines changed: 9 additions & 1 deletion

File tree

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -453,13 +453,21 @@ Whether to use lite mode for Storybook. In lite mode, the default Storybook UI i
453453

454454
Type: `boolean`, default: `false`
455455

456-
Enables an experimental MCP (Model Context Protocol) endpoint at `/mcp` on the Storybook channel server. This can be used by AI tooling to query Storybook documentation and component/story metadata. Available from v10.3 onwards.
456+
Enables an experimental MCP (Model Context Protocol) server for AI tooling to query Storybook documentation and component/story metadata.
457457

458458
You can enable MCP with or without websockets:
459459

460460
- `experimental_mcp: true` starts the HTTP MCP endpoint
461461
- adding `websockets` also enables story selection tools over the same channel server
462462

463+
The MCP server is available at the `/mcp` endpoint on the Storybook channel server. Configure your MCP client via its settings UI, or use:
464+
465+
```sh
466+
npx mcp-add --type http --url "http://localhost:7007/mcp" --scope project
467+
```
468+
469+
You'll need to adjust the URL accordingly if you're using non-default `websockets.(host|port|secured)` [properties](#websockets).
470+
463471
### websockets
464472

465473
Type: `'auto' | { host?: string, port?: number, secured?: boolean, key?: string | Buffer, cert?: string | Buffer, ca?: string | Buffer | Array<string | Buffer>, passphrase?: string }`, default: `undefined`

0 commit comments

Comments
 (0)