@plankui/mcp 0.1.1 → 0.1.3

package/README.md

@@ -1,8 +1,32 @@
-# @plankui/mcp
+<p align="center">
+  <a href="https://plankui.com/docs/mcp"><img src="https://plankui.com/logo.svg" width="64" height="64" alt="PlankUI" /></a>
+</p>
 
-An [MCP](https://modelcontextprotocol.io) server that gives AI coding agents the whole [PlankUI](https://plankui.com) library: every component's source, props and usage, the templates, and the setup files.
+<h1 align="center">@plankui/mcp</h1>
 
-It runs on your machine over stdio. Nothing is hosted and there is nothing to sign up for.
+<p align="center">
+  The <a href="https://plankui.com">PlankUI</a> MCP server. Your AI coding agent gets the real source, props and usage<br />
+  of every component, so it builds with PlankUI instead of guessing.
+</p>
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/@plankui/mcp"><img src="https://img.shields.io/npm/v/@plankui/mcp?style=flat-square&color=2f6bff&label=npm" alt="npm version" /></a>
+  <a href="https://www.npmjs.com/package/@plankui/mcp"><img src="https://img.shields.io/npm/dm/@plankui/mcp?style=flat-square&color=2f6bff" alt="Downloads a month" /></a>
+  <a href="https://github.com/VectorLabsHQ/plankui"><img src="https://img.shields.io/github/stars/VectorLabsHQ/plankui?style=flat-square&color=2f6bff&logo=github" alt="GitHub stars" /></a>
+  <a href="https://modelcontextprotocol.io"><img src="https://img.shields.io/badge/MCP-stdio-2f6bff?style=flat-square" alt="MCP over stdio" /></a>
+  <a href="https://github.com/VectorLabsHQ/plankui/blob/main/LICENSE"><img src="https://img.shields.io/npm/l/@plankui/mcp?style=flat-square&color=2f6bff" alt="MIT licence" /></a>
+</p>
+
+<p align="center">
+  <a href="https://plankui.com">Website</a> ·
+  <a href="https://plankui.com/docs/mcp">MCP docs</a> ·
+  <a href="https://plankui.com/docs/components">Components</a> ·
+  <a href="https://www.npmjs.com/package/plankui">CLI</a>
+</p>
+
+<p align="center">
+  <a href="https://plankui.com/docs/mcp"><img src="https://plankui.com/readme/components-dark.jpg" alt="PlankUI components in dark mode: charts, forms, a command menu, navigation and toggles" /></a>
+</p>
 
 ## Add it to your agent
 
@@ -22,21 +46,86 @@ claude mcp add plankui -- npx -y @plankui/mcp
 }
 ```
 
-Setup for every client, with one-click installs for Cursor and VS Code: [plankui.com/docs/mcp](https://plankui.com/docs/mcp).
+<details>
+<summary><b>VS Code</b></summary>
+
+In `.vscode/mcp.json`:
+
+```json
+{
+  "servers": {
+    "plankui": { "type": "stdio", "command": "npx", "args": ["-y", "@plankui/mcp"] }
+  }
+}
+```
+
+</details>
+
+<details>
+<summary><b>Codex</b></summary>
+
+In `~/.codex/config.toml`:
+
+```toml
+[mcp_servers.plankui]
+command = "npx"
+args = ["-y", "@plankui/mcp"]
+```
+
+</details>
+
+<details>
+<summary><b>Zed</b></summary>
+
+In your Zed settings:
+
+```json
+{
+  "context_servers": {
+    "plankui": { "source": "custom", "command": "npx", "args": ["-y", "@plankui/mcp"] }
+  }
+}
+```
+
+</details>
+
+One-click installs for Cursor and VS Code, and setup for every client: [plankui.com/docs/mcp](https://plankui.com/docs/mcp).
 
 Tools load when a session starts, so restart the client or open a new chat after adding the server.
 
+## Then just ask
+
+> Build a settings page with PlankUI: tabs for Profile and Billing, a form with a select and a switch, and a confirm dialog before deleting the account.
+
+> Which PlankUI component should I use for picking one option from a short list?
+
+> Set up PlankUI in this project with the Ember theme and the Keycap style.
+
+> Add a PlankUI select and dialog using Base UI.
+
+The agent looks components up, reads their real source and props, and writes code that matches the library, including the right install commands.
+
 ## Tools
 
 | Tool | Returns |
 | --- | --- |
 | `list_components` | Every component with its slug, category and one line on what it does |
 | `search_components` | Components that match an intent, such as "confirm dialog" |
-| `get_component` | Install command, full source of every file it needs, usage and props |
-| `get_component_usage` | Usage and props only |
+| `get_component` | Install command, full source of every file it needs, usage and props. Pass `primitives: "base"` for the Base UI version |
+| `get_component_usage` | Usage and props only (same `primitives` option) |
 | `list_templates` | Every template |
 | `get_template` | A template's full source |
 | `get_setup` | The tokens, styles and `cn` helper every project needs |
 | `get_theming` | Themes, styles, accents and how to change them |
 
-Needs Node 18 or later. MIT licensed.
+## Private by design
+
+The server runs on your machine over stdio and reads a registry bundled in the package. Nothing is hosted, nothing is sent anywhere and there is nothing to sign up for.
+
+## Requirements
+
+Node 18 or later and any client that speaks MCP.
+
+## Licence
+
+MIT. Made by [Vector Labs](https://github.com/VectorLabsHQ).

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@plankui/mcp",
-  "version": "0.1.1",
-  "description": "MCP server for PlankUI: gives AI coding agents every component's source, props, usage and the setup files.",
+  "version": "0.1.3",
+  "description": "MCP server for PlankUI: gives Cursor, Claude Code, VS Code, Codex and other AI agents the real source, props and usage of every component.",
   "type": "module",
   "bin": {
     "plank-mcp": "server.mjs"
@@ -15,7 +15,7 @@
     "node": ">=18"
   },
   "license": "MIT",
-  "homepage": "https://plankui.com",
+  "homepage": "https://plankui.com/docs/mcp",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/VectorLabsHQ/plankui.git",
@@ -26,9 +26,20 @@
   },
   "keywords": [
     "mcp",
+    "mcp-server",
     "model-context-protocol",
+    "ai",
+    "cursor",
+    "claude-code",
+    "codex",
+    "vscode",
     "react",
     "tailwindcss",
-    "plankui"
-  ]
+    "components",
+    "design-system",
+    "plankui",
+    "base-ui",
+    "radix-ui"
+  ],
+  "author": "Vector Labs (https://plankui.com)"
 }