GitHub - vuetifyjs/mcp: 🤖 A Model Context Protocol (MCP) library for use with Agentic chat bots (original) (raw)

Model Context Protocol (MCP) server providing Vuetify component information and documentation to any MCP-compatible client or IDE.

Overview

The Vuetify Model Context Protocol (MCP) server bridges the gap between Vuetify's powerful component library and AI-assisted development environments. This integration enables seamless access to Vuetify's extensive component ecosystem directly within your development workflow.

This MCP server enables IDEs and other Model Context clients to assist with:

• Generating Vuetify components with proper props and attributes
• Creating common UI layouts and patterns following best practices
• Providing comprehensive information about Vuetify features and APIs
• Accessing installation guides, FAQs, and release notes without leaving your IDE

By connecting your development environment to the Vuetify MCP server, you gain AI-powered assistance that understands Vuetify's component structure, styling conventions, and implementation details.

Quick Start

Run Vuetify MCP with a single command:

Start the Vuetify MCP server

npx -y @vuetify/mcp

This command downloads and runs the latest version of the Vuetify MCP server, making it immediately available to your MCP-compatible clients.

Configuration

You can configure the Vuetify MCP server in your IDE or client by running the interactive CLI or by manually updating your settings file.

Using the Interactive CLI

The interactive CLI provides the simplest way to configure your environment:

Run the configuration helper

npx -y @vuetify/mcp config

The CLI will:

1. Detect supported IDEs on your system (VS Code, Claude, Cursor, Trae, Windsurf)
2. Prompt you if multiple IDEs are found
3. Apply the necessary settings automatically to your selected environment

Manual Configuration

Below are the locations and JSON snippets for each supported environment. Copy the JSON into your client or IDE settings file at the specified path.

Example JSON snippet for most IDEs (non-VS Code):

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

Example JSON snippet for VSCode:

{ "mcp": { "servers": { "vuetify-mcp": { "command": "npx", "args": ["-y", "@vuetify/mcp"], "env": { // Optional: API key for accessing premium Vuetify features "VUETIFY_API_KEY": "", // Optional: GitHub token for accessing private repositories "GITHUB_TOKEN": "" } } } } }

WSL (Windows Subsystem for Linux)

If you prefer to run the MCP server from Windows using WSL:

{ "mcpServers": { "vuetify-mcp": { "command": "wsl.exe", "args": [ "bash", "-c", "/home//.nvm/versions/node//bin/node /home//sites/mcp/dist/index.js" ] } } }

Replace <user> and <version> with your actual WSL username and Node.js version.

Features

The Vuetify MCP server provides a comprehensive set of tools to enhance your development experience. These tools are automatically available to any MCP-compatible client once the server is configured.

API Tools

• get_vuetify_api_by_version: Download and cache Vuetify API types by version. Supports all major Vuetify versions (2.x and 3.x).
• get_component_api_by_version: Return the API list for a specific Vuetify component, including props, events, slots, and exposed methods.
• get_directive_api_by_version: Return the API information for a specific Vuetify directive (e.g., v-ripple, v-scroll). Includes directive description, arguments, default values, and source reference.

Documentation Tools

• get_installation_guide: Get detailed installation guides for various environments, including Vue CLI, Nuxt, Vite, and manual installation methods.
• get_available_features: Get a list of available Vuetify features, including components, directives, and composables.
• get_exposed_exports: Get a list of exports from the Vuetify npm package, useful for understanding what can be imported directly.
• get_frequently_asked_questions: Get the FAQ section from the Vuetify docs, providing answers to common questions and issues.
• get_release_notes_by_version: Get release notes for one or more Vuetify versions, helping you understand changes between versions.

Project Structure

The Vuetify MCP server follows a modular architecture that separates concerns and makes the codebase easier to navigate and extend:

vuetify-mcp/
├── src/
│   ├── index.ts        # Main entry point and server initialization
│   ├── services/       # Core business logic
│   │   ├── auth.ts        # Authentication service for API access
│   │   ├── component.ts   # Component-related service for API information
│   │   ├── documentation.ts # Documentation-related service for guides and FAQs
│   └── tools/          # MCP tool definitions
│       ├── component.ts   # Component-related tools (API, props, etc.)
│       ├── documentation.ts # Documentation-related tools (guides, FAQs, etc.)
│   └── transports/     # Transport wrappers
│       ├── auth.ts        # Authentication transport wrapper
├── package.json        # Project dependencies
├── tsconfig.json       # TypeScript configuration
└── README.md           # This file

This structure makes it easy to locate specific functionality and extend the server with new features.

Development

If you want to contribute to the Vuetify MCP server or customize it for your own needs, follow these steps to set up your development environment:

Install dependencies

pnpm install

Run development server

pnpm dev

The development server will start with hot-reloading enabled, allowing you to see your changes immediately.

Adding New Features

To add new features or extend existing ones:

1. Add or update service methods in the appropriate service file (e.g., src/services/component.ts)
2. Register the tool in the corresponding tools file (e.g., src/tools/component.ts)
3. Build and test your changes

MCP SDK Integration

This project uses the @modelcontextprotocol/sdk package to create a Model Context Protocol server that Claude and other AI assistants can interact with. The MCP architecture enables AI assistants to:

• Call specific tools defined in the server
• Receive structured responses in a standardized format
• Provide a better experience for Vuetify-related inquiries

The implementation follows the standard MCP patterns with:

• Server initialization using McpServer class
• Parameter validation with Zod schemas for type safety
• StdioServerTransport for communication between the client and server

Example Tool Implementation

Here's a simplified example of how a tool is implemented in the Vuetify MCP server:

// In src/tools/component.ts import { z } from 'zod'; import { componentService } from '../services/component';

export const getComponentApiByVersion = { name: 'get_component_api_by_version', description: 'Return the API list for a Vuetify component', parameters: z.object({ component: z.string().describe('The component name (e.g., "VBtn")'), version: z.string().optional().describe('Vuetify version (defaults to latest)') }), handler: async ({ component, version }) => { return componentService.getComponentApi(component, version); } };

Troubleshooting

Common Issues

• Server Not Starting: Ensure you have Node.js 16 or higher installed
• Configuration Not Working: Verify the paths and JSON structure in your settings file
• Missing API Information: Check that you're using a supported Vuetify version

Getting Help

If you encounter issues not covered here, please:

1. Check the GitHub issues for similar problems
2. Join the Vuetify Discord for community support
3. Open a new issue with detailed reproduction steps

Version Compatibility

The Vuetify MCP server is compatible with:

• Vuetify 3.x
• Node.js 22 and higher
• All major MCP-compatible clients (Claude, VSCode, etc.)

License

Vuetify MCP is available under the MIT software license.

Copyright (c) 2025-present Vuetify, LLC