Vuetify 컴포넌트 정보, API 문서 및 설치 가이드를 AI 지원 개발 환경에 제공합니다.
다른 이름 vuetifyjs/mcp, @vuetify/mcp
- 스타
- 115
- Tools
- 16
- 다운로드, 30일
- —
- 최신 버전
- —
- 마지막 커밋
- 2026년 10월 23일
- 라이선스
- MIT
Vuetify MCP란?
Vuetify 컴포넌트 정보, API 문서 및 설치 가이드를 AI 지원 개발 환경에 제공합니다. 16개 도구를 제공합니다. 예: get_vuetify_api_by_version, get_component_api_by_version, get_directive_api_by_version.
프로젝트 README에서 생성된 요약
Vuetify MCP server 정보
Vuetify로 사용자 인터페이스를 구축하는 개발자는 이 server를 IDE에 통합하여 AI 지원 워크플로우 내에서 컴포넌트 문서와 API 상세 정보를 직접 확인할 수 있습니다. Cursor, Claude Desktop, VS Code, Trae, Windsurf와 같은 MCP 호환 클라이언트에서 작동하며, npx를 통한 로컬 설치와 원격 호스팅 옵션을 모두 제공합니다. 사용자는 일반 문서를 위해 공개 엔드포인트에 연결하거나, Vuetify One OAuth를 사용하여 확장된 에코시스템 사이트에 접속할 수 있습니다.
이 server는 컴포넌트 속성(props), 이벤트, 슬롯(slots) 관리 및 Nuxt, Vite, Vue CLI 설치 가이드에 접근할 수 있는 특정 도구를 제공합니다. v2에서 v3로의 업그레이드 플레이북 및 breaking change 카탈로그와 같이 버전 간 업그레이드를 위한 특화된 기능도 포함되어 있습니다. 고급 사용자의 경우, 커스텀 디자인 시스템 구축을 지원하기 위해 @vuetify/v0 composables 및 headless 컴포넌트를 지원합니다. 설정은 대화형 CLI 또는 IDE 설정 내 수동 JSON 업데이트를 통해 관리할 수 있습니다.
활용 사례
- 1Vuetify 컴포넌트 생성AI 어시스턴트에게 올바른 props와 attributes를 사용하여 특정 Vuetify 컴포넌트 코드를 작성하도록 요청합니다.
- 2컴포넌트 API 상세 정보 조회특정 컴포넌트에서 사용할 수 있는 이벤트, 슬롯 및 메서드를 찾습니다.
- 3설치 가이드 참조Vite 또는 Nuxt 환경에서 Vuetify를 설정하기 위한 단계별 지침을 확인합니다.
프로젝트의 README를 바탕으로 작성되었습니다. 모든 활용 사례는 해당 내용의 인용문과 대조하여 확인합니다.
Vuetify MCP 설치 방법
형식 확인: 2026년 11월 10일Cursor에 추가Goose에 추가Claude Code에 Vuetify MCP 설치
$ claude mcp add mcp -- npx -y @vuetify/mcpCursor에 Vuetify MCP 설치
~/.cursor/mcp.json
{
"mcpServers": {
"mcp": {
"command": "npx",
"args": [
"-y",
"@vuetify/mcp"
]
}
}
}VS Code에 Vuetify MCP 설치
.vscode/mcp.json
{
"servers": {
"mcp": {
"type": "stdio",
"command": "npx",
"args": [
"-y",
"@vuetify/mcp"
]
}
}
}VS Code CLI에 Vuetify MCP 설치
$ code --add-mcp '{"name":"mcp","type":"stdio","command":"npx","args":["-y","@vuetify/mcp"]}'Claude Desktop에 Vuetify MCP 설치
claude_desktop_config.json
{
"mcpServers": {
"mcp": {
"command": "npx",
"args": [
"-y",
"@vuetify/mcp"
]
}
}
}Codex에 Vuetify MCP 설치
$ codex mcp add mcp -- npx -y @vuetify/mcpCodex config.toml에 Vuetify MCP 설치
~/.codex/config.toml
[mcp_servers.mcp] command = "npx" args = ["-y", "@vuetify/mcp"]
Gemini CLI에 Vuetify MCP 설치
$ gemini mcp add -s user mcp npx -- -y @vuetify/mcpGemini settings.json에 Vuetify MCP 설치
~/.gemini/settings.json
{
"mcpServers": {
"mcp": {
"command": "npx",
"args": [
"-y",
"@vuetify/mcp"
]
}
}
}Vuetify MCP 도구 16
README에서 감지됨get_vuetify_api_by_versionget_component_api_by_versionget_directive_api_by_versionget_installation_guideget_feature_guidesget_feature_guideget_exposed_exportsget_frequently_asked_questionsget_release_notes_by_versionget_vuetify_one_installation_guideget_vuetify0_installation_guideget_vuetify0_package_guide
| get_vuetify_api_by_version | — | |
| get_component_api_by_version | — | |
| get_directive_api_by_version | — | |
| get_installation_guide | — | |
| get_feature_guides | — | |
| get_feature_guide | — | |
| get_exposed_exports | — | |
| get_frequently_asked_questions | — | |
| get_release_notes_by_version | — | |
| get_vuetify_one_installation_guide | — | |
| get_vuetify0_installation_guide | — | |
| get_vuetify0_package_guide | — |
도구 16개 모두 보기도구 수 줄이기
get_vuetify0_composable_listget_vuetify0_component_listget_vuetify0_composable_guideget_vuetify0_component_guide
| get_vuetify0_composable_list | — | |
| get_vuetify0_component_list | — | |
| get_vuetify0_composable_guide | — | |
| get_vuetify0_component_guide | — |
구성
GITHUB_TOKENVUETIFY_API_KEY
| 이름 | 설명 | 유형 |
|---|---|---|
| GITHUB_TOKEN | — | |
| VUETIFY_API_KEY | — |
자동 검사
2026년 11월 12일에 실행됨전체 보고서 →자동 검사를 통과했습니다. 이는 보안 감사가 아닙니다. 코드를 직접 읽고 서버에 필요한 최소한의 권한만 부여하십시오. 검사 방식
- 소스 저장소 연결 및 접근 가능통과
- 오픈 소스 라이선스 (OSI)통과
- 최근 1년 내 커밋 또는 릴리스통과
- 패키지 이름이 인기 패키지와 유사하지 않음통과
- 원격 엔드포인트가 HTTPS 사용검사되지 않음
- 파괴적인 도구에 라벨 표시됨통과
- 모델에 대한 숨겨진 지침 없음통과
- 패키지 및 해당 종속성에 중요한 보안 권고 없음검사되지 않음
README
GitHub에서 보기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
- Working with @vuetify/v0 composables and headless components for building custom design systems
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
Hosted HTTP Server (Easiest)
Two URLs. Use /mcp unless you subscribe to Vuetify One.
| URL | Auth | Tools |
|---|---|---|
https://mcp.vuetifyjs.com/mcp |
none | docs, APIs, install/upgrade guides |
https://mcp.vuetifyjs.com/one |
Vuetify One OAuth | docs plus ecosystem sites (Bin, Play, Link, and the rest of One) |
The claude CLI below is Claude Code, not Claude Desktop — see Claude Desktop for that GUI client.
# Claude Code — public docs
claude mcp add --transport http vuetify-mcp https://mcp.vuetifyjs.com/mcp
# Optional — authenticate with Vuetify One
claude mcp add --transport http vuetify-one https://mcp.vuetifyjs.com/one
Grok Bot / Cursor Agents: add /mcp for docs (no Authorize card). Add /one to authenticate with Vuetify One; subscribers can then use ecosystem sites from that connector. Do not paste an API key.
Local Installation
Run Vuetify MCP locally:
# 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.
Cursor / Agent Plugin
This repo is an Agent Plugins 1.0.0 package (plugin.json + mcp.json) that points compatible clients at the hosted server.
- Hosted MCP (docs): https://mcp.vuetifyjs.com/mcp
- Hosted MCP (One / OAuth): https://mcp.vuetifyjs.com/one
- Privacy: https://vuetifyjs.com/en/legal/mcp-privacy
Local test: copy or symlink this repo to ~/.cursor/plugins/local/vuetify-mcp.
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:
# Configure for hosted remote server
npx -y @vuetify/mcp config --remote
# Or configure for local installation
npx -y @vuetify/mcp config
The CLI will:
- Detect supported IDEs on your system (VS Code, Claude, Cursor, Trae, Windsurf)
- Prompt you if multiple IDEs are found
- Apply the necessary settings automatically to your selected environment
- Use the hosted server (with
--remote) or local installation
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.
| IDE | Settings File Path | JSON Key Path |
|---|---|---|
| VSCode | <user home>/.config/Code/User/settings.json |
mcp.servers.vuetify-mcp |
| Claude | <user home>/Library/Application Support/Claude/claude_desktop_config.json (macOS)%APPDATA%\Claude\claude_desktop_config.json (Windows) |
mcpServers.vuetify-mcp |
| Cursor | <user home>/.config/Cursor/User/mcp.json |
mcpServers.vuetify-mcp |
| Trae | <user home>/.config/Trae/User/mcp.json |
mcpServers.vuetify-mcp |
| Windsurf | <user home>/.config/Windsurf/User/mcp.json |
mcpServers.vuetify-mcp |
Local stdio (most IDEs):
{
"mcpServers": {
"vuetify-mcp": {
"command": "npx",
"args": ["-y", "@vuetify/mcp"]
}
}
}
Hosted remote server (most IDEs):
{
"mcpServers": {
"vuetify-mcp": {
"url": "https://mcp.vuetifyjs.com/mcp"
},
"vuetify-one": {
"url": "https://mcp.vuetifyjs.com/one"
}
}
}
Omit vuetify-one unless you have a Vuetify One subscription.
Claude Desktop
Claude Desktop (the GUI app, distinct from the Claude Code CLI) does not support direct HTTP transport in claude_desktop_config.json — it only accepts stdio servers. Pick one of the configs below.
Local stdio:
{
"mcpServers": {
"vuetify-mcp": {
"command": "npx",
"args": ["-y", "@vuetify/mcp"]
}
}
}
Hosted via mcp-remote bridge (consumes the hosted server over stdio):
{
"mcpServers": {
"vuetify-mcp": {
"command": "npx",
"args": ["-y", "mcp-remote", "https://mcp.vuetifyjs.com/mcp"]
}
}
}
Hosted via mcp-remote on Windows + WSL2:
{
"mcpServers": {
"vuetify-mcp": {
"command": "wsl",
"args": ["npx", "-y", "mcp-remote", "https://mcp.vuetifyjs.com/mcp"]
}
}
}
After editing claude_desktop_config.json, fully quit and relaunch Claude Desktop. Logs (useful for debugging) are at <Claude folder>/logs/main.log — search for vuetify-mcp.
Authentication
Hosted /mcp needs no login. /one authenticates with Vuetify One so subscribers can access ecosystem sites — do not paste an API key there.
Local stdio or self-hosted HTTP can still use a Vuetify API key. How you pass it depends on transport:
Local stdio servers use environment variables:
{
"mcpServers": {
"vuetify-mcp": {
"command": "npx",
"args": ["-y", "@vuetify/mcp"],
"env": {
"VUETIFY_API_KEY": "<YOUR_API_KEY>"
}
}
}
}
HTTP/remote servers require headers (env vars don't work for HTTP transport):
{
"mcpServers": {
"vuetify-mcp": {
"type": "http",
"url": "https://mcp.vuetifyjs.com/mcp",
"headers": {
"Authorization": "Bearer <YOUR_API_KEY>"
}
}
}
}
The server accepts either Authorization: Bearer <token> or X-Vuetify-Api-Key: <token> headers.
VSCode local:
{
"servers": {
"vuetify-mcp": {
"command": "npx",
"args": ["-y", "@vuetify/mcp"],
"env": {
"VUETIFY_API_KEY": "<YOUR_API_KEY>",
"GITHUB_TOKEN": "<YOUR_GITHUB_TOKEN>"
}
}
}
}
VSCode remote:
{
"servers": {
"vuetify-mcp": {
"url": "https://mcp.vuetifyjs.com/mcp"
}
}
}
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/<user>/.nvm/versions/node/<version>/bin/node /home/<user>/sites/mcp/dist/index.js"
]
}
}
}
Replace <user> and <version> with your actual WSL username and Node.js version.
Self-Hosted HTTP Server
Run your own HTTP server for remote access:
# Start with HTTP transport
npx -y @vuetify/mcp --transport=http --port=3000 --host=0.0.0.0 --stateless
Configuration:
{
"mcpServers": {
"vuetify-mcp": {
"url": "http://your-server:3000/mcp"
}
}
}
CLI Arguments:
--transport=http- Enable HTTP transport--port=3000- Port number (default: 3000)--host=0.0.0.0- Host address (default: localhost)--path=/mcp- Endpoint path (default: /mcp)--stateless- Stateless mode (recommended for public servers)
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_feature_guides: Get a list of available features in the documentation.get_feature_guide: Get the information about a specific feature in the documentation.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.get_vuetify_one_installation_guide: Get the README contents for @vuetify/one package from GitHub.
Upgrade (v2 → v3)
Start with get_v3_upgrade_playbook. Target Vuetify 3.13 LTS — do not jump to v4.
get_v3_upgrade_playbook: Ordered phases (baseline e2e, Vue 3 prerequisite, bundler/Nuxt, eslint --fix, component map, breaking-change scan).get_v3_upgrade_baseline_recipe: Playwright recipe forupgrade-baseline/before the bump andupgrade-after/after. Functional tests are the source of truth; screenshots are classified, not a CI gate.get_v2_to_v3_component_map: v2 component → v3.13 status (core, renamed, removed, replaced).get_v3_breaking_changes: Filterable v2 → 3 catalog, including agotchascategory.get_upgrade_guide: Full markdown. Useversion: "v2.7"for v2 → 3 (fetched from v3-stable).
Prompt: upgrade-v2-to-v3.
Upgrade (v3 → v4)
get_upgrade_guide: Useversion: "v3".get_v4_breaking_changes: Filterable Vuetify 4 breaking changes.
Vuetify0 (@vuetify/v0) Tools
Support for @vuetify/v0, a headless meta-framework providing unstyled components and composables for building design systems:
get_vuetify0_installation_guide: Get installation and usage instructions for @vuetify/v0 from GitHub.get_vuetify0_package_guide: Get package-specific documentation for @vuetify/v0.get_vuetify0_composable_list: List all 71 composables organized by category (foundation, registration, selection, forms, system, plugins, data, reactivity, transformers).get_vuetify0_component_list: List all 40 headless components available in @vuetify/v0.get_vuetify0_composable_guide: Get detailed documentation and source code for specific composables.get_vuetify0_component_guide: Get detailed documentation and source code for specific components.
Project Structure
The Vuetify MCP server follows a modular architecture that separates concerns and makes the codebase easier to navigate and extend:
vuetify-mcp/
├── bin/
│ └── cli.js # CLI entry point with argument handling
├── src/
│ ├── index.ts # Main server entry point
│ ├── services/ # Core business logic
│ │ ├── api.ts # API-related services
│ │ ├── documentation.ts # Documentation services
│ │ └── vuetify0.ts # @vuetify/v0 services
│ ├── tools/ # MCP tool definitions
│ │ ├── api.ts # API tools
│ │ ├── documentation.ts # Documentation tools (includes @vuetify/v0)
│ ├── transports/ # Transport implementations
│ │ └── http.ts # HTTP transport with stateless/stateful modes
│ └── cli/ # Interactive CLI configuration
├── package.json
├── tsconfig.json
└── README.md
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:
- Add or update service methods in the appropriate service file (e.g.,
src/services/component.ts) - Register the tool in the corresponding tools file (e.g.,
src/tools/component.ts) - 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
McpServerclass - Parameter validation with Zod schemas for type safety
- Multiple transport options: stdio (default) and HTTP with session management
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:
- Check the GitHub issues for similar problems
- Join the Vuetify Discord for community support
- 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
Vuetify MCP 질문
Vuetify MCP를 Claude Code에 추가하려면 어떻게 하나요?
터미널에서 claude mcp add mcp -- npx -y @vuetify/mcp를 실행합니다. 모든 프로젝트에서 사용할 수 있게 하려면 --scope user를 추가합니다.
Vuetify MCP를 Cursor에 추가하려면 어떻게 하나요?
~/.cursor/mcp.json를 열고 mcpServers 아래에 서버를 추가합니다. 위 설치 섹션에 표시된 Cursor 구성을 사용합니다.
Vuetify MCP는 어떤 도구를 제공하나요?
16개 도구를 제공합니다. 예: get_vuetify_api_by_version, get_component_api_by_version, get_directive_api_by_version, get_installation_guide, get_feature_guides.
Claude Desktop에서 Vuetify MCP server를 어떻게 사용하나요?
Claude Desktop은 stdio server가 필요합니다. npx를 사용한 로컬 stdio 설정이나 mcp-remote 브릿지를 사용하여 호스팅된 HTTP server에 연결할 수 있습니다.
호스팅된 MCP server는 인증이 필요한가요?
표준 호스팅 /mcp 엔드포인트는 인증이 필요하지 않으며, /one 엔드포인트는 구독자를 위한 Vuetify One OAuth를 사용합니다.
Vuetify MCP server를 로컬에서 실행할 수 있나요?
네, npx -y @vuetify/mcp 명령어를 사용하여 로컬에서 실행할 수 있습니다.