Skip to content
Back to search

shadcn-vue-mcp

Shadcn-vue and Tailwind CSS are essential for component development, offering developers a fast and high-quality experience in Vue component development.

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/helloggx--shadcn-vue-mcp/badge.svg)](/listings/helloggx--shadcn-vue-mcp)

HTML

<a href="/listings/helloggx--shadcn-vue-mcp"><img src="/api/listings/helloggx--shadcn-vue-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.

Prerequisites

Before you begin, ensure you have Node.js installed on your system.

- **Recommended Node.js version**: `18.20.1` or later.

> Using a different version might lead to installation errors like `Error: spawnSync code-insiders.cmd EINVAL`. Downgrading or upgrading to the recommended version is the best solution.

Qucik install: URL Quick Installation for copilot

First, you need to obtain a unique connection URL from the Smithery service that contains your personal credentials. Visit the [shadcn-vue-mcp page on Smithery](https://smithery.ai/server/@HelloGGX/shadcn-vue-mcp).

Step 1. Click the Generate URL button on the page.:

The system will generate a unique URL for you, which includes an API key for authentication. Copy this entire URL.

Step 2. Open vscode, open copilot and select Agent model, Next, add the URL you just obtained to your IDE's MCP configuration file. 1. In your IDE project, find or create the configuration file named mcp.json. 2. Add or merge the following JSON object into the servers field of that file.

Step 3: for vscode IDE, Select Add Server

Step 4: choose HTTP(HTTP or Server-Sent Events)

Step 5: paste the URL

Step 6: config like this:

{
  "servers": {
    "shadcn-vue-mcp": {
      "url": "https://server.smithery.ai/@HelloGGX/shadcn-vue-mcp/mcp?api_key=xxxx&profile=linguistic-landfowl-TWeEt8"
    }
  }
}

Config file locations:

- Cursor: `~/.cursor/mcp.json` - Trae: `~/.Trae/mcp.json` - Cline: `~/.cline/mcp_config.json` - Claude: `~/.claude/mcp_config.json`

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.

README.md · README · 209 lines

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

  1. <div align="center">
  2. <a href="https://smithery.ai/server/@HelloGGX/shadcn-vue-mcp">
  3. <img src="https://github.com/HelloGGX/tailwindcss-mcp/raw/fast-agent/docs/logo1.png" alt="shadcnVue MCP Logo" max-height="450">
  4. </a>
  5. <br />
  6. A powerful AI Agent tool that helps developers instantly create high-quality UI components
  7. [![GitHub forks](https://img.shields.io/github/forks/HelloGGX/shadcn-vue-mcp.svg?style=social&label=Fork)](https://GitHub.com/HelloGGX/shadcn-vue-mcp/network/)
  8. [![GitHub stars](https://img.shields.io/github/stars/HelloGGX/shadcn-vue-mcp.svg?style=social&label=Star)](https://GitHub.com/HelloGGX/shadcn-vue-mcp/stargazers/)
  9. [![GitHub commits](https://badgen.net/github/commits/HelloGGX/shadcn-vue-mcp)](https://GitHub.com/HelloGGX/shadcn-vue-mcp/commit/)
  10. [![smithery badge](https://smithery.ai/badge/@HelloGGX/shadcn-vue-mcp)](https://smithery.ai/server/@HelloGGX/shadcn-vue-mcp)
  11. [![License](https://img.shields.io/github/license/HelloGGX/shadcn-vue-mcp?colorA=00C586&colorB=000000)](https://github.com/HelloGGX/shadcn-vue-mcp/blob/main/LICENSE)
  12. [![Contributors](https://img.shields.io/github/contributors/HelloGGX/shadcn-vue-mcp?colorA=00C586&colorB=000000)](https://github.com/HelloGGX/shadcn-vue-mcp/graphs/contributors)
  13. [![MseeP.ai Security Assessment Badge](https://mseep.net/pr/helloggx-shadcn-vue-mcp-badge.png)](https://mseep.ai/app/helloggx-shadcn-vue-mcp)
  14. Shadcn-vue MCP Server is a powerful AI-driven tool that helps developers instantly create beautiful, modern UI components through natural language descriptions. It integrates the shadcn-vue component library and tailwindcss, seamlessly connects with mainstream IDEs, and provides a streamlined UI development workflow.
  15. <div align="center">
  16. 🌐 Available Languages: <a href="./docs/README-zh-CN.md"><img src="https://img.shields.io/badge/docs-中文版-yellow" alt="中文文档"></a>
  17. </div>
  18. </div>
  19. <a href="https://glama.ai/mcp/servers/@HelloGGX/shadcn-vue-mcp">
  20. <img width="380" height="200" src="https://glama.ai/mcp/servers/@HelloGGX/shadcn-vue-mcp/badge" alt="shadcn-vue-mcp MCP server" />
  21. </a>
  22. ## ❌ Without shadcn-vue MCP
  23. Developers face multiple challenges when building UI components:
  24. - ❌ **Tedious Development Workflow**: Constantly switching between the IDE, official documentation, and browser severely impacts development efficiency and focus.
  25. - ❌ **Difficulty in Component Selection**: Faced with numerous components from `shadcn-vue`, developers struggle to quickly find the best fit for their needs without intelligent recommendations.
  26. - ❌ **High Repetitive Workload**: Involves manually writing extensive boilerplate code and handling various component states and complex interaction logic.
  27. - ❌ **Insufficient Quality Assurance**: It's easy to overlook quality standards like accessibility (A11y), performance optimization, and best coding practices, leading to inconsistent component quality.
  28. - ❌ **High Maintenance Costs**: As the project grows, manually maintaining the style, behavior, and dependencies of all components becomes exceptionally difficult, making consistency hard to achieve.
  29. ## ✅ With shadcn-vue MCP
  30. shadcn-vue MCP provides an intelligent UI component development experience that revolutionizes the traditional workflow:
  31. - ✅ **One-Stop Development Experience**: Complete the entire process—from component selection and coding to preview—without ever leaving your editor, simply by describing your needs in natural language.
  32. - ✅ **Intelligent Component Recommendation**: The `components-filter` tool intelligently analyzes your requirements and recommends the most suitable `shadcn-vue` components.
  33. - ✅ **High-Quality Code Auto-Generation**: `component-builder` automatically generates high-quality Vue component code that complies with `shadcn-vue` and `tailwindcss` standards, with best practices built-in.
  34. - ✅ **Built-in Quality Assurance**: `component-quality-check` automatically performs accessibility (A11y) and code quality checks on the generated code, ensuring professional-grade components.
  35. - ✅ **Instant Documentation and Previews**: `component-usage-doc` provides real-time component documentation, APIs, and usage examples to get you started immediately.
  36. - ✅ **Ensures High Design Consistency**: All generated components strictly adhere to a unified design specification, ensuring visual and interactive consistency across the entire application and enhancing brand value.
  37. ## 🌟 Features
  38. - **Natural Language Descriptions**:
  39. - AI-Powered UI Generation: Create UI components by describing them in natural language
  40. - **Multi-IDE Support**:
  41. - [Cursor](https://cursor.com) IDE integration for seamless workflows.
  42. - [Trae](https://www.trae.ai/) support for advanced AI-driven development.
  43. - [VSCode](https://code.visualstudio.com/) support for a robust coding experience.
  44. - [VSCode + Cline](https://cline.bot) integration (Beta) for enhanced collaboration.
  45. - **Modern Component Library**:
  46. - Built on the shadcn-vue component library and tailwindcss for modern, responsive designs.
  47. - **TypeScript Support**:
  48. - Full TypeScript support ensures type-safe and scalable development.
  49. - **Intelligent Documentation Query**:
  50. - Real-time access to detailed shadcn-vue component documentation with integrated previews of usage and best practices.
  51. - **Component Enhancement**:
  52. - Accessibility: WCAG 2.1 compliant, keyboard navigation, ARIA support
  53. - Performance: Code splitting, tree shaking, optimized bundles
  54. - Consistency: Unified design system, consistent behavior patterns
  55. - Maintainability: Clean code architecture, well-documented components
  56. - Developer Experience: TypeScript support, hot reload, intuitive APIs
  57. ## 🚀 Getting Started
  58. ### Prerequisites
  59. Before you begin, ensure you have Node.js installed on your system.
  60. - **Recommended Node.js version**: `18.20.1` or later.
  61. > Using a different version might lead to installation errors like `Error: spawnSync code-insiders.cmd EINVAL`. Downgrading or upgrading to the recommended version is the best solution.
  62. ### Qucik install: URL Quick Installation for copilot
  63. First, you need to obtain a unique connection URL from the Smithery service that contains your personal credentials. Visit the [shadcn-vue-mcp page on Smithery](https://smithery.ai/server/@HelloGGX/shadcn-vue-mcp).
  64. Step 1. Click the Generate URL button on the page.:
  65. <img src="https://raw.githubusercontent.com/HelloGGX/shadcn-vue-mcp/fast-agent/docs/url.png" width="700" >
  66. The system will generate a unique URL for you, which includes an API key for authentication. Copy this entire URL.
  67. Step 2. Open vscode, open copilot and select Agent model, Next, add the URL you just obtained to your IDE's MCP configuration file.
  68. 1. In your IDE project, find or create the configuration file named mcp.json.
  69. 2. Add or merge the following JSON object into the servers field of that file.
  70. Step 3: for vscode IDE, Select Add Server
  71. <img src="https://raw.githubusercontent.com/HelloGGX/shadcn-vue-mcp/main/docs/add_server.png" width="600">
  72. Step 4: choose HTTP(HTTP or Server-Sent Events)
  73. <img src="https://raw.githubusercontent.com/HelloGGX/shadcn-vue-mcp/main/docs/choose_mcp_type.png" width="600">
  74. Step 5: paste the URL
  75. Step 6: config like this:
  76. ```json
  77. {
  78. "servers": {
  79. "shadcn-vue-mcp": {
  80. "url": "https://server.smithery.ai/@HelloGGX/shadcn-vue-mcp/mcp?api_key=xxxx&profile=linguistic-landfowl-TWeEt8"
  81. }
  82. }
  83. }
  84. ```
  85. Config file locations:
  86. - Cursor: `~/.cursor/mcp.json`
  87. - Trae: `~/.Trae/mcp.json`
  88. - Cline: `~/.cline/mcp_config.json`
  89. - Claude: `~/.claude/mcp_config.json`
  90. ## 🛠️ Tool List & Core Features
  91. ### Component Generation Tools
  92. - **`requirement-structuring`**
  93. - Analyzes natural language requirements
  94. - Converts user needs into structured JSON format
  95. - Considers core functionality and essential features
  96. - Built-in user interaction and edge case analysis
  97. ### Documentation & Analysis Tools
  98. - **`component-usage-doc`**
  99. - Real-time access to shadcn-vue component documentation
  100. - Interactive preview of component variants
  101. - Built-in markdown rendering in browser
  102. - Detailed API and usage examples
  103. ### Component Filtering & Management
  104. - **`components-filter`**
  105. - Smart component recommendation system
  106. - Supports multi-language description parsing
  107. - Component relationship analysis
  108. - Usage frequency statistics and weighting
  109. ### Code Quality & Testing
  110. - **`component-quality-check`**
  111. - Automated code quality assessment
  112. - A11y (Accessibility) compliance checking
  113. - Performance optimization suggestions
  114. - Best practices validation
  115. ### Smart Code Generation
  116. - **`component-builder`**
  117. - AI-powered component generation
  118. - shadcn-vue and Tailwind CSS integration
  119. - TypeScript type safety
  120. - Built-in best practices implementation
  121. ## Result Example
  122. User: /ui create a flight display component
  123. AI: Generated code as follows:
  124. ![UI Component Example](https://github.com/HelloGGX/tailwindcss-mcp/raw/fast-agent/docs/uiDemo.png)
  125. User: /check
  126. AI: ![alt text](https://github.com/HelloGGX/tailwindcss-mcp/raw/fast-agent/docs/check.png)
  127. AI: Generated code as follows:
  128. ## 🤝 Contribution Guide
  129. We welcome all forms of contributions! You can help us improve `@agent/shadcn-vue` by:
  130. - **Reporting Bugs:** If you find a bug, please create an issue in our [GitHub repository](https://github.com/HelloGGX/shadcn-vue-mcp/issues).
  131. - **Suggesting Enhancements:** Have an idea for a new feature or an improvement? Let us know by creating an issue.
  132. - **Submitting Pull Requests:** We are happy to review and merge pull requests. Before making significant changes, please open an issue first to discuss your ideas.
  133. The source code is open-sourced on [GitHub](https://github.com/HelloGGX/shadcn-vue-mcp).
  134. ## 👥 Community & Support
  135. - [Discord Community](https://discord.gg/82Kf65ut) - Join our active community
  136. ## 📝 License
  137. ## Licensed under the [Apache 2.0 License](./LICENSE).

Ratings and comments

Sign in to rate this skill.

Sign in

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