Vue MCP Server

local-only server

The server can only run on the client’s local machine because it depends on local resources.

Integrations

  • Provides integration with Vite development servers to expose component and state data through MCP endpoints.

complemento vite-vue-mcp

Complemento de Vite que habilita un servidor MCP para su aplicación Vue para proporcionar información sobre el árbol de componentes, el estado, las rutas y el árbol pinia y el estado.

Instalación 📦

pnpm install vite-plugin-vue-mcp -D

Uso 🔨

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

Entonces el servidor MCP estará disponible en http://localhost:[port]/__mcp/sse .

Si usa Cursor, cree un archivo .cursor/mcp.json en la raíz de su proyecto; este complemento lo actualizará automáticamente. Para más información sobre MCP, consulte la documentación oficial de Cursor .

Opciones

export interface VueMcpOptions { /** * The host to listen on, default is `localhost` */ host?: string /** * The port to listen on, default is the port of the Vite dev server */ port?: number /** * 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 }

Características/Herramientas ✨

Obtener árbol de componentes

get-component-tree : obtiene el árbol de componentes de Vue.

Obtener el estado del componente

get-component-state : obtiene el estado de un componente (entrada: componentName ).

Editar el estado del componente

edit-component-state : edita el estado de un componente (entrada: componentName , path , value , valueType ).

Resaltar componente

highlight-component : Resalta un componente (entrada: componentName ).

Obtener rutas

get-router-info : obtiene la información del enrutador Vue de la aplicación.

Consigue el árbol Pinia

get-pinia-tree : obtiene el árbol Pinia de la aplicación.

Obtenga Pinia State

get-pinia-state : obtiene el estado de Pinia de la aplicación (entrada: storeName ).

Arquitectura ⚡️

Aviso 💡

Asegúrese de que la aplicación se esté ejecutando en su navegador antes de utilizar las funciones.

Créditos 💖

Este proyecto está inspirado en vite-plugin-mcp . Gracias a @antfu por el excelente trabajo.

Licencia 📖

Licencia MIT © Arlo

-
security - not tested
A
license - permissive license
-
quality - not tested

Proporciona información sobre las aplicaciones de Vue al exponer árboles de componentes, estado, rutas y datos de Pinia a través de un servidor de protocolo de contexto de modelo.

  1. Installation 📦
    1. Usage 🔨
      1. Options
    2. Features/Tools ✨
      1. Get Component Tree
      2. Get Component State
      3. Edit Component State
      4. Highlight Component
      5. Get Routes
      6. Get Pinia Tree
      7. Get Pinia State
    3. Architecture ⚡️
      1. Notice 💡
        1. Credits 💖
          1. License 📖
            ID: wxe5s8ifko