Skip to content
Back to search

mcp

πŸ€– A Model Context Protocol (MCP) library for use with Agentic chat bots

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today
Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/vuetifyjs--mcp/badge.svg)](/listings/vuetifyjs--mcp)

HTML

<a href="/listings/vuetifyjs--mcp"><img src="/api/listings/vuetifyjs--mcp/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

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](#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.

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

plugin.json Β· Manifest Β· 15 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

This file has changed since it was scanned, so this is not exactly the text that was scanned, and no line is marked. The findings are listed with the safety scan above.

  1. {
  2. "$schema": "https://agent-plugins.org/schemas/1.0.0/plugin.schema.json",
  3. "name": "vuetify-mcp",
  4. "version": "1.0.0",
  5. "description": "Official hosted Vuetify MCP. Public docs at /mcp (no account). Authenticate with Vuetify One at /one for ecosystem sites. Privacy: https://vuetifyjs.com/en/legal/mcp-privacy",
  6. "author": {
  7. "name": "Vuetify LLC",
  8. "email": "hello@vuetifyjs.com",
  9. "url": "https://vuetifyjs.com"
  10. },
  11. "homepage": "https://0.vuetifyjs.com/guide/tooling/vuetify-mcp",
  12. "repository": "https://github.com/vuetifyjs/mcp",
  13. "license": "MIT",
  14. "keywords": ["vuetify", "mcp", "vue", "documentation"]
  15. }
README.md Β· README Β· 464 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

This file has changed since it was scanned, so this is not exactly the text that was scanned, and no line is marked. The findings are listed with the safety scan above.

  1. <div align="center">
  2. <picture>
  3. <source media="(prefers-color-scheme: dark)" srcset="https://cdn.vuetifyjs.com/docs/images/one/logos/vmcp-logo-dark.png">
  4. <img alt="Vuetify MCP Logo" src="https://cdn.vuetifyjs.com/docs/images/one/logos/vmcp-logo-light.png" height="100">
  5. </picture>
  6. </div>
  7. <p align="center">
  8. <a href="https://www.npmjs.com/package/@vuetify/mcp"><img src="https://img.shields.io/npm/v/@vuetify/mcp.svg" alt="npm version"></a>
  9. <a href="https://npm.chart.dev/@vuetify/mcp"><img src="https://img.shields.io/npm/dm/@vuetify/mcp?color=blue" alt="npm downloads"></a>
  10. <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="License: MIT"></a>
  11. <a href="https://discord.gg/vuetify"><img src="https://discord.com/api/guilds/1513968811047522396/widget.png" alt="Discord"></a>
  12. </p>
  13. Model Context Protocol (MCP) server providing Vuetify component information and documentation to any MCP-compatible client or IDE.
  14. ## Overview
  15. 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.
  16. This MCP server enables IDEs and other Model Context clients to assist with:
  17. - Generating Vuetify components with proper props and attributes
  18. - Creating common UI layouts and patterns following best practices
  19. - Providing comprehensive information about Vuetify features and APIs
  20. - Accessing installation guides, FAQs, and release notes without leaving your IDE
  21. - Working with @vuetify/v0 composables and headless components for building custom design systems
  22. 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.
  23. ## Quick Start
  24. ### Hosted HTTP Server (Easiest)
  25. Two URLs. Use `/mcp` unless you subscribe to Vuetify One.
  26. | URL | Auth | Tools |
  27. |-----|------|--------|
  28. | `https://mcp.vuetifyjs.com/mcp` | none | docs, APIs, install/upgrade guides |
  29. | `https://mcp.vuetifyjs.com/one` | Vuetify One OAuth | docs plus ecosystem sites (Bin, Play, Link, and the rest of One) |
  30. The `claude` CLI below is **Claude Code**, not Claude Desktop β€” see [Claude Desktop](#claude-desktop) for that GUI client.
  31. ```bash
  32. # Claude Code β€” public docs
  33. claude mcp add --transport http vuetify-mcp https://mcp.vuetifyjs.com/mcp
  34. # Optional β€” authenticate with Vuetify One
  35. claude mcp add --transport http vuetify-one https://mcp.vuetifyjs.com/one
  36. ```
  37. 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.
  38. ### Local Installation
  39. Run Vuetify MCP locally:
  40. ```bash
  41. # Start the Vuetify MCP server
  42. npx -y @vuetify/mcp
  43. ```
  44. This command downloads and runs the latest version of the Vuetify MCP server, making it immediately available to your MCP-compatible clients.
  45. ## Cursor / Agent Plugin
  46. This repo is an [Agent Plugins](https://agent-plugins.org/) 1.0.0 package (`plugin.json` + `mcp.json`) that points compatible clients at the hosted server.
  47. - Hosted MCP (docs): https://mcp.vuetifyjs.com/mcp
  48. - Hosted MCP (One / OAuth): https://mcp.vuetifyjs.com/one
  49. - Privacy: https://vuetifyjs.com/en/legal/mcp-privacy
  50. Local test: copy or symlink this repo to `~/.cursor/plugins/local/vuetify-mcp`.
  51. ## Configuration
  52. You can configure the Vuetify MCP server in your IDE or client by running the interactive CLI or by manually updating your settings file.
  53. ### Using the Interactive CLI
  54. The interactive CLI provides the simplest way to configure your environment:
  55. ```bash
  56. # Configure for hosted remote server
  57. npx -y @vuetify/mcp config --remote
  58. # Or configure for local installation
  59. npx -y @vuetify/mcp config
  60. ```
  61. The CLI will:
  62. 1. Detect supported IDEs on your system (VS Code, Claude, Cursor, Trae, Windsurf)
  63. 2. Prompt you if multiple IDEs are found
  64. 3. Apply the necessary settings automatically to your selected environment
  65. 4. Use the hosted server (with `--remote`) or local installation
  66. ### Manual Configuration
  67. 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.
  68. | IDE | Settings File Path | JSON Key Path |
  69. |----------|------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------|
  70. | VSCode | `<user home>/.config/Code/User/settings.json` | `mcp.servers.vuetify-mcp` |
  71. | Claude | `<user home>/Library/Application Support/Claude/claude_desktop_config.json` (macOS)<br>`%APPDATA%\Claude\claude_desktop_config.json` (Windows) | `mcpServers.vuetify-mcp` |
  72. | Cursor | `<user home>/.config/Cursor/User/mcp.json` | `mcpServers.vuetify-mcp` |
  73. | Trae | `<user home>/.config/Trae/User/mcp.json` | `mcpServers.vuetify-mcp` |
  74. | Windsurf | `<user home>/.config/Windsurf/User/mcp.json` | `mcpServers.vuetify-mcp` |
  75. **Local stdio (most IDEs):**
  76. ```json
  77. {
  78. "mcpServers": {
  79. "vuetify-mcp": {
  80. "command": "npx",
  81. "args": ["-y", "@vuetify/mcp"]
  82. }
  83. }
  84. }
  85. ```
  86. **Hosted remote server (most IDEs):**
  87. ```json
  88. {
  89. "mcpServers": {
  90. "vuetify-mcp": {
  91. "url": "https://mcp.vuetifyjs.com/mcp"
  92. },
  93. "vuetify-one": {
  94. "url": "https://mcp.vuetifyjs.com/one"
  95. }
  96. }
  97. }
  98. ```
  99. Omit `vuetify-one` unless you have a Vuetify One subscription.
  100. ### Claude Desktop
  101. 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.
  102. **Local stdio:**
  103. ```json
  104. {
  105. "mcpServers": {
  106. "vuetify-mcp": {
  107. "command": "npx",
  108. "args": ["-y", "@vuetify/mcp"]
  109. }
  110. }
  111. }
  112. ```
  113. **Hosted via [`mcp-remote`](https://www.npmjs.com/package/mcp-remote) bridge** (consumes the hosted server over stdio):
  114. ```json
  115. {
  116. "mcpServers": {
  117. "vuetify-mcp": {
  118. "command": "npx",
  119. "args": ["-y", "mcp-remote", "https://mcp.vuetifyjs.com/mcp"]
  120. }
  121. }
  122. }
  123. ```
  124. **Hosted via mcp-remote on Windows + WSL2:**
  125. ```json
  126. {
  127. "mcpServers": {
  128. "vuetify-mcp": {
  129. "command": "wsl",
  130. "args": ["npx", "-y", "mcp-remote", "https://mcp.vuetifyjs.com/mcp"]
  131. }
  132. }
  133. }
  134. ```
  135. 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`.
  136. ### Authentication
  137. Hosted `/mcp` needs no login. `/one` authenticates with Vuetify One so subscribers can access ecosystem sites β€” do not paste an API key there.
  138. Local stdio or self-hosted HTTP can still use a Vuetify API key. How you pass it depends on transport:
  139. **Local stdio servers** use environment variables:
  140. ```json
  141. {
  142. "mcpServers": {
  143. "vuetify-mcp": {
  144. "command": "npx",
  145. "args": ["-y", "@vuetify/mcp"],
  146. "env": {
  147. "VUETIFY_API_KEY": "<YOUR_API_KEY>"
  148. }
  149. }
  150. }
  151. }
  152. ```
  153. **HTTP/remote servers** require headers (env vars don't work for HTTP transport):
  154. ```json
  155. {
  156. "mcpServers": {
  157. "vuetify-mcp": {
  158. "type": "http",
  159. "url": "https://mcp.vuetifyjs.com/mcp",
  160. "headers": {
  161. "Authorization": "Bearer <YOUR_API_KEY>"
  162. }
  163. }
  164. }
  165. }
  166. ```
  167. The server accepts either `Authorization: Bearer <token>` or `X-Vuetify-Api-Key: <token>` headers.
  168. **VSCode local:**
  169. ```json
  170. {
  171. "servers": {
  172. "vuetify-mcp": {
  173. "command": "npx",
  174. "args": ["-y", "@vuetify/mcp"],
  175. "env": {
  176. "VUETIFY_API_KEY": "<YOUR_API_KEY>",
  177. "GITHUB_TOKEN": "<YOUR_GITHUB_TOKEN>"
  178. }
  179. }
  180. }
  181. }
  182. ```
  183. **VSCode remote:**
  184. ```json
  185. {
  186. "servers": {
  187. "vuetify-mcp": {
  188. "url": "https://mcp.vuetifyjs.com/mcp"
  189. }
  190. }
  191. }
  192. ```
  193. **WSL (Windows Subsystem for Linux)**
  194. If you prefer to run the MCP server from Windows using WSL:
  195. ```json
  196. {
  197. "mcpServers": {
  198. "vuetify-mcp": {
  199. "command": "wsl.exe",
  200. "args": [
  201. "bash",
  202. "-c",
  203. "/home/<user>/.nvm/versions/node/<version>/bin/node /home/<user>/sites/mcp/dist/index.js"
  204. ]
  205. }
  206. }
  207. }
  208. ```
  209. Replace `<user>` and `<version>` with your actual WSL username and Node.js version.
  210. ### Self-Hosted HTTP Server
  211. Run your own HTTP server for remote access:
  212. ```bash
  213. # Start with HTTP transport
  214. npx -y @vuetify/mcp --transport=http --port=3000 --host=0.0.0.0 --stateless
  215. ```
  216. **Configuration:**
  217. ```json
  218. {
  219. "mcpServers": {
  220. "vuetify-mcp": {
  221. "url": "http://your-server:3000/mcp"
  222. }
  223. }
  224. }
  225. ```
  226. **CLI Arguments:**
  227. - `--transport=http` - Enable HTTP transport
  228. - `--port=3000` - Port number (default: 3000)
  229. - `--host=0.0.0.0` - Host address (default: localhost)
  230. - `--path=/mcp` - Endpoint path (default: /mcp)
  231. - `--stateless` - Stateless mode (recommended for public servers)
  232. ## Features
  233. 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.
  234. ### API Tools
  235. - `get_vuetify_api_by_version`: Download and cache Vuetify API types by version. Supports all major Vuetify versions (2.x and 3.x).
  236. - `get_component_api_by_version`: Return the API list for a specific Vuetify component, including props, events, slots, and exposed methods.
  237. - `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.
  238. ### Documentation Tools
  239. - `get_installation_guide`: Get detailed installation guides for various environments, including Vue CLI, Nuxt, Vite, and manual installation methods.
  240. - `get_feature_guides`: Get a list of available features in the documentation.
  241. - `get_feature_guide`: Get the information about a specific feature in the documentation.
  242. - `get_exposed_exports`: Get a list of exports from the Vuetify npm package, useful for understanding what can be imported directly.
  243. - `get_frequently_asked_questions`: Get the FAQ section from the Vuetify docs, providing answers to common questions and issues.
  244. - `get_release_notes_by_version`: Get release notes for one or more Vuetify versions, helping you understand changes between versions.
  245. - `get_vuetify_one_installation_guide`: Get the README contents for @vuetify/one package from GitHub.
  246. ### Upgrade (v2 β†’ v3)
  247. Start with `get_v3_upgrade_playbook`. Target **Vuetify 3.13 LTS** β€” do not jump to v4.
  248. - `get_v3_upgrade_playbook`: Ordered phases (baseline e2e, Vue 3 prerequisite, bundler/Nuxt, eslint --fix, component map, breaking-change scan).
  249. - `get_v3_upgrade_baseline_recipe`: Playwright recipe for `upgrade-baseline/` before the bump and `upgrade-after/` after. Functional tests are the source of truth; screenshots are classified, not a CI gate.
  250. - `get_v2_to_v3_component_map`: v2 component β†’ v3.13 status (core, renamed, removed, replaced).
  251. - `get_v3_breaking_changes`: Filterable v2 β†’ 3 catalog, including a `gotchas` category.
  252. - `get_upgrade_guide`: Full markdown. Use `version: "v2.7"` for v2 β†’ 3 (fetched from v3-stable).
  253. Prompt: `upgrade-v2-to-v3`.
  254. ### Upgrade (v3 β†’ v4)
  255. - `get_upgrade_guide`: Use `version: "v3"`.
  256. - `get_v4_breaking_changes`: Filterable Vuetify 4 breaking changes.
  257. ### Vuetify0 (@vuetify/v0) Tools
  258. Support for @vuetify/v0, a headless meta-framework providing unstyled components and composables for building design systems:
  259. - `get_vuetify0_installation_guide`: Get installation and usage instructions for @vuetify/v0 from GitHub.
  260. - `get_vuetify0_package_guide`: Get package-specific documentation for @vuetify/v0.
  261. - `get_vuetify0_composable_list`: List all 71 composables organized by category (foundation, registration, selection, forms, system, plugins, data, reactivity, transformers).
  262. - `get_vuetify0_component_list`: List all 40 headless components available in @vuetify/v0.
  263. - `get_vuetify0_composable_guide`: Get detailed documentation and source code for specific composables.
  264. - `get_vuetify0_component_guide`: Get detailed documentation and source code for specific components.
  265. ## Project Structure
  266. The Vuetify MCP server follows a modular architecture that separates concerns and makes the codebase easier to navigate and extend:
  267. ```text
  268. vuetify-mcp/
  269. β”œβ”€β”€ bin/
  270. β”‚ └── cli.js # CLI entry point with argument handling
  271. β”œβ”€β”€ src/
  272. β”‚ β”œβ”€β”€ index.ts # Main server entry point
  273. β”‚ β”œβ”€β”€ services/ # Core business logic
  274. β”‚ β”‚ β”œβ”€β”€ api.ts # API-related services
  275. β”‚ β”‚ β”œβ”€β”€ documentation.ts # Documentation services
  276. β”‚ β”‚ └── vuetify0.ts # @vuetify/v0 services
  277. β”‚ β”œβ”€β”€ tools/ # MCP tool definitions
  278. β”‚ β”‚ β”œβ”€β”€ api.ts # API tools
  279. β”‚ β”‚ β”œβ”€β”€ documentation.ts # Documentation tools (includes @vuetify/v0)
  280. β”‚ β”œβ”€β”€ transports/ # Transport implementations
  281. β”‚ β”‚ └── http.ts # HTTP transport with stateless/stateful modes
  282. β”‚ └── cli/ # Interactive CLI configuration
  283. β”œβ”€β”€ package.json
  284. β”œβ”€β”€ tsconfig.json
  285. └── README.md
  286. ```
  287. This structure makes it easy to locate specific functionality and extend the server with new features.
  288. ## Development
  289. 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:
  290. ```bash
  291. # Install dependencies
  292. pnpm install
  293. # Run development server
  294. pnpm dev
  295. ```
  296. The development server will start with hot-reloading enabled, allowing you to see your changes immediately.
  297. ### Adding New Features
  298. To add new features or extend existing ones:
  299. 1. Add or update service methods in the appropriate service file (e.g., `src/services/component.ts`)
  300. 2. Register the tool in the corresponding tools file (e.g., `src/tools/component.ts`)
  301. 3. Build and test your changes
  302. ## MCP SDK Integration
  303. 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:
  304. - Call specific tools defined in the server
  305. - Receive structured responses in a standardized format
  306. - Provide a better experience for Vuetify-related inquiries
  307. The implementation follows the standard MCP patterns with:
  308. - Server initialization using `McpServer` class
  309. - Parameter validation with Zod schemas for type safety
  310. - Multiple transport options: stdio (default) and HTTP with session management
  311. ### Example Tool Implementation
  312. Here's a simplified example of how a tool is implemented in the Vuetify MCP server:
  313. ```typescript
  314. // In src/tools/component.ts
  315. import { z } from 'zod';
  316. import { componentService } from '../services/component';
  317. export const getComponentApiByVersion = {
  318. name: 'get_component_api_by_version',
  319. description: 'Return the API list for a Vuetify component',
  320. parameters: z.object({
  321. component: z.string().describe('The component name (e.g., "VBtn")'),
  322. version: z.string().optional().describe('Vuetify version (defaults to latest)')
  323. }),
  324. handler: async ({ component, version }) => {
  325. return componentService.getComponentApi(component, version);
  326. }
  327. };
  328. ```
  329. ## Troubleshooting
  330. ### Common Issues
  331. - **Server Not Starting**: Ensure you have Node.js 16 or higher installed
  332. - **Configuration Not Working**: Verify the paths and JSON structure in your settings file
  333. - **Missing API Information**: Check that you're using a supported Vuetify version
  334. ### Getting Help
  335. If you encounter issues not covered here, please:
  336. 1. Check the [GitHub issues](https://github.com/vuetifyjs/mcp/issues) for similar problems
  337. 2. Join the [Vuetify Discord](https://discord.gg/vuetify) for community support
  338. 3. Open a new issue with detailed reproduction steps
  339. ## Version Compatibility
  340. The Vuetify MCP server is compatible with:
  341. - Vuetify 3.x
  342. - Node.js 22 and higher
  343. - All major MCP-compatible clients (Claude, VSCode, etc.)
  344. ## License
  345. Vuetify MCP is available under the [MIT](http://opensource.org/licenses/MIT) software license.
  346. Copyright (c) 2025-present Vuetify, LLC

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.