Log inSubmit server
@vaneui MCP logo

@vaneui MCP

by @vaneui

Exposes VaneUI component docs, guides, resources, and prop metadata to MCP-aware coding clients over stdio.

InstallRepositoryWebsite
Full README Compare alternatives Embed widget Claim this listing

Install @vaneui MCP

Pick your client, then add it in one click or paste the config.

STDIONode.js
~/Library/Application Support/Claude/claude_desktop_config.json
claude_desktop_config.json
{
  "mcpServers": {
    "vaneui-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "@vaneui/mcp"
      ]
    }
  }
}

Settings → Developer → Edit Config, merge this into mcpServers, then fully quit and reopen Claude Desktop.

Automated check passed— started and listed 2 tools correctly (Today).

Overview

@vaneui/mcp connects MCP-aware coding agents to VaneUI’s component documentation and structured prop metadata. It serves Markdown resources through stdio and provides `search_docs` for substring or JavaScript regex searches plus `get_component_props` for component boolean-prop tables and defaults. Reach for it when an agent needs VaneUI-specific usage, theming, layout, or prop guidance without copying documentation into prompts. The package runs directly through `npx` and requires Node.js 24.

Use cases

  • Search VaneUI guides for component usage and prop mappings
  • Inspect component defaults before generating interface code
  • Read shared layout props for composing VaneUI components
  • Look up theme defaults and customization patterns
  • Connect an MCP-aware editor to VaneUI documentation

Key features

  • VaneUI Markdown resources over MCP
  • Case-insensitive substring and regex documentation search
  • Structured boolean prop tables with defaults
  • Compact and full component-prop detail modes
  • Shared layout and typography prop metadata
  • Standard stdio transport

Tools2

What @vaneui MCP lets your agent do. Expand a tool for its parameters.

Verified live~340 tokens of context

Security & health

What it can reach and how reliably it runs — from our own checks, not the maintainer’s claims.

ActiveLast checked Today

Recent health check succeeded.

What it can do

From the 2 tools this server returned when we ran it.

Read-only tools · 2
Network at startup3 connections
Files written at startupNone
Install scriptsNone
npm provenanceSigned build
Package age157 days
Maintainers1

Observed 2026-11-12 in an isolated sandbox. A description of reach, not a security audit.

Supply-chain signal

No high-severity advisories surfaced by our automated scan.

Critical 0High 0Medium 0Low 0

Scanned 9h ago via OSV.dev · @vaneui/mcp (npm)

Adoption & maintenance

Factual signals from GitHub, npm, and our automated checks — not a rating.

GitHub stars1Stargazers on the source repository.
npm downloads2.5kPackage downloads in the last 30 days.
Last commit5d agoMost recent push to the default branch.
Availability100%Our rolling endpoint + install checks that succeeded.
Install checkPassedOur sandbox started it and listed its tools.
Tools exposed2Callable tools this server registers over MCP.

How @vaneui MCP works

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:

Terminal
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.

Read the full README View source on GitHub

Reviews

No reviews yet — be the first to share how it worked for you.

Frequently Asked Questions about @vaneui MCP

@vaneui/mcp is an MCP server that connects AI coding clients to VaneUI documentation and component metadata. It exposes Markdown resources through stdio, plus `search_docs` for text or regex searches and `get_component_props` for boolean props, alternatives, defaults, and descriptions. It helps agents consult VaneUI guidance while generating code.

Run it through `npx` with `npx -y @vaneui/mcp` in your MCP client configuration. Claude Code can add it with `claude mcp add vaneui -- npx -y @vaneui/mcp`; Claude Desktop, Cursor, and VS Code each accept the same command and package argument in their MCP settings. Node.js 24 is required.

Yes, @vaneui/mcp works with Cursor through a standard stdio configuration. Add a `vaneui` server to the global `~/.cursor/mcp.json` or project `.cursor/mcp.json`, using `npx` as the command and `-y`, `@vaneui/mcp` as the arguments.

Use `get_component_props` with the component slug to retrieve its boolean prop categories and defaults. Compact mode is the default, while `full` adds descriptions and shared props. Use `search_docs` for value-bearing props, component guidance, theme settings, or Tailwind mappings.

Yes, build the TypeScript source and point the MCP client to `node /absolute/path/to/vaneui-mcp/dist/server.js`. The local server uses stdio, just like the npm package, and the repository includes the bundled resources needed to run it.

Related MCP servers

All in Developer Tools All alternatives
Add a badge to your READMEShow it’s listed — live SVG, Markdown or HTML.

AllMCPs Directory Badge

Full Badge Customizer

Showcase your server listing on GitHub or your project documentation. Embed this dynamic SVG badge to highlight official listing status and live engagement.

Badge Style:
Live Dynamic SVG Preview@vaneui MCP AllMCPs Directory Badge
Markdown (GitHub README)
[![AllMCPs](https://allmcps.com/api/badge/vaneui-mcp?style=directory)](https://allmcps.com/mcp/vaneui-mcp)
HTML Embed
<a href="https://allmcps.com/mcp/vaneui-mcp"><img src="https://allmcps.com/api/badge/vaneui-mcp?style=directory" alt="@vaneui MCP on AllMCPs" /></a>