webfansplz/vite-plugin-vue-mcp

Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 47 Commits
.cursor		.cursor
.github		.github
.vscode		.vscode
playground		playground
screenshots		screenshots
src		src
.gitignore		.gitignore
.npmrc		.npmrc
LICENSE		LICENSE
README.md		README.md
build.config.ts		build.config.ts
eslint.config.js		eslint.config.js
package.json		package.json
pnpm-lock.yaml		pnpm-lock.yaml
pnpm-workspace.yaml		pnpm-workspace.yaml
tsconfig.json		tsconfig.json

Repository files navigation

vite-plugin-vue-mcp

npm version npm downloads bundle License

Vite plugin that enables a MCP server for your Vue app to provide information about the component tree, state, routes, and pinia tree and state.

Installation 📦

pnpm install vite-plugin-vue-mcp -D

Usage 🔨

// vite.config.ts
import { VueMcp } from 'vite-plugin-vue-mcp'
export default defineConfig({
 plugins: [VueMcp()],
})

Then the MCP server will be available at http://localhost:[port]/__mcp/sse.

If you are using Cursor, create a .cursor/mcp.json file in your project root, this plugin will automatically update it for you. For more details about the MCP, check the official Cursor documentation.

Options

export interface VueMcpOptions {
 /**
 * The host to listen on, default is `localhost`
 */
 host?: string
 /**
 * Print the MCP server URL in the console
 *
 * @default true
 */
 printUrl?: boolean
 /**
 * The MCP server info. Ingored when `mcpServer` is provided
 */
 mcpServerInfo?: McpServerInfo
 /**
 * Custom MCP server, when this is provided, the built-in MCP tools will be ignored
 */
 mcpServer?: (viteServer: ViteDevServer) => Awaitable<McpServer>
 /**
 * Setup the MCP server, this is called when the MCP server is created
 * You may also return a new MCP server to replace the default one
 */
 mcpServerSetup?: (server: McpServer, viteServer: ViteDevServer) => Awaitable<void | McpServer>
 /**
 * The path to the MCP server, default is `/__mcp`
 */
 mcpPath?: string
 /**
 * Update the address of the MCP server in the cursor config file `.cursor/mcp.json`,
 * if `.cursor` folder exists.
 *
 * @default true
 */
 updateCursorMcpJson?: boolean | {
 enabled: boolean
 /**
 * The name of the MCP server, default is `vue-mcp`
 */
 serverName?: string
 }
 /**
 * append an import to the module id ending with `appendTo` instead of adding a script into body
 * useful for projects that do not use html file as an entry
 *
 * WARNING: only set this if you know exactly what it does.
 * @default ''
 */
 appendTo?: string | RegExp
}