### Development Setup Source: https://github.com/vuetifyjs/mcp/blob/master/README.md Commands to set up the development environment for the Vuetify MCP server, including installing dependencies and running the development server. ```bash # Install dependencies pnpm install # Run development server pnpm dev ``` -------------------------------- ### Start Vuetify MCP Server Source: https://github.com/vuetifyjs/mcp/blob/master/README.md Command to download and run the latest version of the Vuetify MCP server. ```bash npx -y @vuetify/mcp ``` -------------------------------- ### Example Tool Implementation Source: https://github.com/vuetifyjs/mcp/blob/master/README.md A simplified TypeScript example demonstrating how a tool is implemented in the Vuetify MCP server using Zod for parameter validation and service handlers. ```typescript // 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); } }; ``` -------------------------------- ### Documentation Tools Source: https://github.com/vuetifyjs/mcp/blob/master/README.md Tools for accessing Vuetify documentation, including installation guides, feature lists, FAQs, and release notes. Supports various Vuetify versions. ```APIDOC get_installation_guide: description: Get detailed installation guides for various environments. parameters: environment: The installation environment (e.g., "Vue CLI", "Nuxt", "Vite", "manual") returns: Detailed installation guide for the specified environment get_available_features: description: Get a list of available Vuetify features. returns: List of components, directives, and composables get_exposed_exports: description: Get a list of exports from the Vuetify npm package. returns: List of directly importable exports get_frequently_asked_questions: description: Get the FAQ section from the Vuetify docs. returns: Answers to common questions and issues get_release_notes_by_version: description: Get release notes for one or more Vuetify versions. parameters: versions: Array of Vuetify versions (e.g., ["3.0.0", "3.1.0"]) returns: Release notes for the specified Vuetify versions ``` -------------------------------- ### WSL Configuration for Vuetify MCP Server Source: https://github.com/vuetifyjs/mcp/blob/master/README.md Example JSON snippet for configuring the Vuetify MCP server to run from Windows using WSL, specifying the Node.js path. ```json { "mcpServers": { "vuetify-mcp": { "command": "wsl.exe", "args": [ "bash", "-c", "/home//.nvm/versions/node//bin/node /home//sites/mcp/dist/index.js" ] } } } ``` -------------------------------- ### Manual Configuration for VSCode Source: https://github.com/vuetifyjs/mcp/blob/master/README.md Example JSON snippet for manually configuring the Vuetify MCP server in VSCode, including optional environment variables for API keys. ```json { "mcp": { "servers": { "vuetify-mcp": { "command": "npx", "args": ["-y", "@vuetify/mcp"], "env": { "VUETIFY_API_KEY": "", "GITHUB_TOKEN": "" } } } } } ``` -------------------------------- ### Manual Configuration for Most IDEs (Non-VS Code) Source: https://github.com/vuetifyjs/mcp/blob/master/README.md Example JSON snippet for manually configuring the Vuetify MCP server in IDEs like Claude, Cursor, Trae, and Windsurf. ```json { "mcpServers": { "vuetify": { "command": "npx", "args": [ "-y", "@vuetify/mcp" ] } } } ``` -------------------------------- ### Run Configuration Helper Source: https://github.com/vuetifyjs/mcp/blob/master/README.md Command to run the interactive CLI for configuring the Vuetify MCP server. ```bash npx -y @vuetify/mcp config ``` -------------------------------- ### Release Commands Source: https://github.com/vuetifyjs/mcp/blob/master/RELEASE.md Commands to automate the release process, including performing a release, pushing changes, and performing a dry run. ```bash pnpm release git push --follow-tags pnpm release:dry ``` -------------------------------- ### Project Structure Source: https://github.com/vuetifyjs/mcp/blob/master/README.md The modular architecture of the Vuetify MCP server, outlining the directory structure for services, tools, and transports. ```text 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/ │ ├── component.ts # Component-related tools (API, props, etc.) │ ├── documentation.ts # Documentation-related tools (guides, FAQs, etc.) │ └── transports/ │ ├── auth.ts # Authentication transport wrapper ├── package.json # Project dependencies ├── tsconfig.json # TypeScript configuration └── README.md # This file ``` -------------------------------- ### Commit Convention for Release Automation Source: https://github.com/vuetifyjs/mcp/blob/master/RELEASE.md Defines the commit message conventions used by release-it to automatically determine version bumps and generate changelogs. ```markdown feat: New features fix: Bug fixes docs: Documentation changes style: Code style changes refactor: Code refactoring perf: Performance improvements test: Test updates chore: Build process or auxiliary tool changes Example: feat: add support for Vuetify 3.5 ``` -------------------------------- ### API Tools Source: https://github.com/vuetifyjs/mcp/blob/master/README.md Tools for retrieving Vuetify API information, including component APIs and directive details. Supports various Vuetify versions. ```APIDOC get_vuetify_api_by_version: description: Download and cache Vuetify API types by version. parameters: version: The Vuetify version (e.g., "3.0.0") returns: API types for the specified Vuetify version get_component_api_by_version: description: Return the API list for a specific Vuetify component. parameters: component: The component name (e.g., "VBtn") version: The Vuetify version (defaults to latest) returns: API list including props, events, slots, and exposed methods for the component get_directive_api_by_version: description: Return the API information for a specific Vuetify directive. parameters: directive: The directive name (e.g., "v-ripple") version: The Vuetify version (defaults to latest) returns: Directive description, arguments, default values, and source reference ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.