# @vaneui/mcp [Health: Active]

**Category:** 💻 Developer Tools  
**Repository:** https://github.com/vaneui/mcp  
**GitHub Stars:** 1  
**npm Downloads (last month):** 2496  
**Views:** 0  
**Installs:** 0  
**Upvotes:** 0  
**Directory Page:** https://allmcps.com/mcp/vaneui-mcp

## Description
Model Context Protocol server that exposes VaneUI component documentation as resources for MCP-aware clients.

## Tools
Capabilities this server exposes over MCP:

- **search_docs** — Search the VaneUI markdown docs (component usage, prop-to-Tailwind mapping, patterns, testing, etc.) for a substring or regex. Returns up to 50 matches with URI, line number, and a short snippet. Use this before guessing prop names, defaults, or class mappings.
- **get_component_props** — Return a VaneUI component's boolean props, one line per category, default marked `*`. By default (`compact`) it lists the component's own props and names the shared layout categories it takes; slug `common` lists those once. detail `full` adds descriptions and every shared prop. Value props such as `label` or `title` are in `vaneui://docs/<slug>`. The slug is the resource basename: `button`, `card`, `icon-button`, etc.

## Claude Desktop Quick Installation
Install path detected from listing signals. Uses `npx` (confidence: high):

```json
"mcpServers": {
  "mcp": {
    "command": "npx",
    "args": ["-y","@vaneui/mcp"]
  }
}
```

## Documentation

## What @vaneui/mcp does

@vaneui/mcp makes VaneUI documentation available to MCP clients while an agent is building or reviewing interface code. Its resource set includes the project overview, installation and usage guides, theming and customization references, shared prop documentation, component pages, and agent-oriented rule files.

The server also exposes structured component metadata derived from VaneUI UI definitions. This covers boolean prop categories, available choices, default selections, and descriptions. Value-bearing properties such as a component label or modal title remain part of the relevant component documentation rather than the boolean prop table.

## How it works

The package communicates over standard input and output, so the client launches it as a child process and exchanges MCP messages through stdio. Documentation is exposed as Markdown resources using URIs in the form `vaneui://docs/<slug>`. Resource slugs are based on lowercased Markdown filenames.

`search_docs` accepts a required case-insensitive query and an optional `regex` flag. It returns up to 50 matches with the resource URI, slug, line number, and nearby text. This is useful for locating a prop, default, Tailwind mapping, theme guide, or usage pattern before generating code.

`get_component_props` requires a component slug and supports `compact` or `full` output. Compact mode focuses on component-specific boolean props and identifies the shared categories and defaults separately. Use the `common` slug to inspect shared layout properties. Full mode includes descriptions and shared properties. Within a category, the listed props are alternatives, and an asterisk identifies the default.

## Setup and configuration

Node.js 24 is required. The package can be started without cloning or compiling the repository by configuring the MCP client to run `npx -y @vaneui/mcp`.

For Claude Code, the equivalent command is:

```bash
claude mcp add vaneui -- npx -y @vaneui/mcp
```

Claude Desktop, Cursor, and VS Code can use the same `npx` command and package argument in their MCP configuration. Claude Desktop and Cursor use an `mcpServers` object, while VS Code uses `servers`. After changing the Claude Desktop configuration, restart the application.

To run a local development build, install dependencies, build the TypeScript source, and start the resulting stdio server. A client can then use `node /absolute/path/to/vaneui-mcp/dist/server.js` as its command. The repository also provides type checking and tests for contributors.

## Tools and capabilities

- Search the complete documentation corpus with plain text or JavaScript regular expressions.
- Retrieve component-specific boolean props, alternatives, defaults, and optional descriptions.
- Inspect shared layout and typography props through the `common` component metadata.
- Read component references and guides through `vaneui://docs/*` Markdown resources.
- Look up theming, customization, testing, CSS convention, and prop-to-Tailwind guidance.

## Limitations and notes

The server communicates through stdio rather than an HTTP endpoint. It is intended for clients that can launch a stdio MCP server. Search results are capped at 50 matches. Compact prop output does not expand every shared layout property; query `common` or request full detail when those properties are needed. Props that accept values must be read from the component resource rather than the boolean category output.

_Full upstream README: https://allmcps.com/mcp/vaneui-mcp/readme_