📌Overview

Purpose: To provide a Vite plugin that implements a Model-Component-Protocol (MCP) server for Vue applications, facilitating access to component trees, states, and route information.

Overview: The vite-plugin-vue-mcp enables developers to visualize and interact with the structure and state of their Vue components via an MCP server. It integrates seamlessly with existing Vite projects and enhances the debugging experience by exposing detailed application insights.

Key Features:

• Get Component Tree: Retrieve and view the hierarchical structure of Vue components, aiding in understanding component relationships.

• Get Component State: Access the current state of specific components, allowing for better debugging and state management.

• Edit Component State: Modify the state of components dynamically, which is useful for testing and development scenarios.

• Highlight Component: Visually emphasize specific components in the application for easier identification during debugging.

• Get Routes: Obtain detailed information about the application's routing setup, thereby assisting in route management.

• Get Pinia Tree and State: Fetch the structure and state of Pinia stores, improving state management visibility in applications using state management libraries.

---

vite-plugin-vue-mcp

Vite plugin that enables an 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: https://docs.cursor.com/context/model-context-protocol.

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. Ignored 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
}

Features / Tools ✨

Get Component Tree

get-component-tree: Get the Vue component tree.

Get Component State

get-component-state: Get the state of a component (input: componentName).

Edit Component State

edit-component-state: Edit the state of a component (input: componentName, path, value, valueType).

Highlight Component

highlight-component: Highlight a component (input: componentName).

Get Routes

get-router-info: Get the Vue router info of the application.

Get Pinia Tree

get-pinia-tree: Get the Pinia tree of the application.

Get Pinia State

get-pinia-state: Get the Pinia state of the application (input: storeName).

Notice 💡

Please ensure the application is running in your browser before using the features.

Credits 💖

This project is inspired by vite-plugin-mcp. Thanks to @antfu for the great work.

License 📖

MIT License © Arlo