@parkhub/pave-ui-mcp
v0.1.3
Published
MCP server for @parkhub/pave-ui — gives AI agents access to component docs without a local Storybook
Downloads
286
Maintainers
Keywords
Readme
@parkhub/pave-ui-mcp
MCP server for @parkhub/pave-ui — gives AI agents (Claude Code, Cursor, etc.) access to component docs without needing a local Storybook running.
Component and docs manifests are bundled inside this package (generated from Storybook at publish time). No network calls, no external URLs, no auth required — just run it.
Usage
1. Start the server
npx @parkhub/pave-ui-mcp
# pave-ui-mcp running at http://localhost:6007/mcpKeep it running in a terminal (or wire it to your project's dev startup).
2. Add to your MCP config
Claude Code (.mcp.json in project root):
{
"mcpServers": {
"pave-ui": {
"url": "http://localhost:6007/mcp"
}
}
}Cursor (.cursor/mcp.json):
{
"mcpServers": {
"pave-ui": {
"url": "http://localhost:6007/mcp"
}
}
}3. Add agent instructions
The server surfaces the recommended configuration in two discoverable ways so agents can relay it to you:
- Automatic — the MCP
initializeresponseinstructionsfield includes a setup guidance note on every handshake. - On demand — call the
get-setup-instructionsprompt (prompts/get) to retrieve the full copyable block.
Add the following to your project's AGENTS.md or CLAUDE.md:
## @parkhub/pave-ui
This project uses [`@parkhub/pave-ui`](https://github.com/parkhub/pave-ui) for UI components.
### MCP server
Start the pave-ui MCP server before working on UI code:
```sh
npx @parkhub/pave-ui-mcpAdd to .mcp.json (Claude Code) or .cursor/mcp.json (Cursor) in the project root:
{
"mcpServers": {
"pave-ui": { "url": "http://localhost:6007/mcp" }
}
}Agent instructions
When using @parkhub/pave-ui components:
- Call
list-all-documentationat the start of any UI task to see all available components - Call
get-documentationbefore writing JSX for any component — never assume props exist - Use
get-documentation-for-storyto explore specific story variants and usage examples - If a prop is not returned by these tools, it does not exist — do not use it
---
## Configuration
| Env var | CLI flag | Default | Description |
|---|---|---|---|
| `PAVE_UI_MCP_PORT` | `--port=N` | `6007` | Port for the local MCP server |
| `PAVE_UI_STORYBOOK_URL` | `--storybook-url=URL` | *(bundled files)* | Override manifest source — use when you need docs for unreleased changes |
```sh
# Custom port
PAVE_UI_MCP_PORT=7000 npx @parkhub/pave-ui-mcp
# Point at a local Storybook (e.g. during active pave-ui development)
PAVE_UI_STORYBOOK_URL=http://localhost:6006 npx @parkhub/pave-ui-mcp