{"id":30032307,"url":"https://github.com/varletjs/mcp","last_synced_at":"2025-08-06T21:16:33.745Z","repository":{"id":307036415,"uuid":"1013642072","full_name":"varletjs/mcp","owner":"varletjs","description":null,"archived":false,"fork":false,"pushed_at":"2025-07-29T05:06:20.000Z","size":136,"stargazers_count":3,"open_issues_count":0,"forks_count":1,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-07-29T05:37:19.817Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/varletjs.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-07-04T08:24:12.000Z","updated_at":"2025-07-29T05:06:23.000Z","dependencies_parsed_at":"2025-07-29T05:37:21.344Z","dependency_job_id":"da8a154f-c17e-4f12-82f6-2cb4f00843c6","html_url":"https://github.com/varletjs/mcp","commit_stats":null,"previous_names":["varletjs/mcp"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/varletjs/mcp","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/varletjs%2Fmcp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/varletjs%2Fmcp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/varletjs%2Fmcp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/varletjs%2Fmcp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/varletjs","download_url":"https://codeload.github.com/varletjs/mcp/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/varletjs%2Fmcp/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":269158300,"owners_count":24369989,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-06T02:00:09.910Z","response_time":99,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-08-06T21:16:31.270Z","updated_at":"2025-08-06T21:16:33.735Z","avatar_url":"https://github.com/varletjs.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Varlet MCP Server\n\n\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"https://varlet.gitee.io/varlet-ui/varlet_icon.png\" width=\"150\" height=\"150\" alt=\"Varlet Logo\"\u003e\n  \u003ch3\u003eA Model Context Protocol Server for Varlet UI\u003c/h3\u003e\n  \u003cp\u003eProvides AI assistants with comprehensive access to Varlet UI documentation, component APIs, and development resources.\u003c/p\u003e\n  \n  [![npm version](https://badge.fury.io/js/@varlet%2Fmcp.svg)](https://badge.fury.io/js/@varlet%2Fmcp)\n  [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n  [![TypeScript](https://img.shields.io/badge/TypeScript-007ACC?logo=typescript\u0026logoColor=white)](https://www.typescriptlang.org/)\n\u003c/div\u003e\n\n## 📖 Guides\n\n- **🚀 [Quick Start](./QUICK_START.md)** - Get up and running in 5 minutes\n- **📚 [User Guide](./USER_GUIDE.md)** - A comprehensive guide to usage\n- **🔧 [Troubleshooting](./USER_GUIDE.md#troubleshooting)** - Solutions to common problems\n\n## 🌟 Features\n\n- 🔍 **Component API Access**: Get detailed information about Varlet UI components, props, events, and slots.\n- 📚 **Documentation Tools**: Access installation guides, feature documentation, and best practices.\n- 🎯 **Smart Prompts**: Pre-built prompts for component usage, layout design, and troubleshooting.\n- 🚀 **Performance Optimized**: Built-in caching and efficient data retrieval.\n- 🌐 **Multi-language Support**: Support for internationalization.\n- 🔄 **Version Management**: Support for multiple Varlet UI versions.\n- 📱 **Mobile First**: Optimized for mobile development workflows.\n- 🛠️ **Developer Experience**: Rich tools and debugging features.\n\n## 📦 Installation\n\n### Prerequisites\n\n- Node.js 18+\n- npm or pnpm\n- Claude Desktop or other MCP-compatible client\n\n### Install from npm (Recommended)\n\n```bash\nnpm install -g @varlet/mcp\n```\n\n### Install from Source\n\n```bash\ngit clone https://github.com/varletjs/varlet-mcp.git\ncd varlet-mcp\npnpm install\npnpm run build\nnpm link\n```\n\n### Verify Installation\n\n```bash\nvarlet-mcp-server --version\n```\n\n## 🚀 Usage\n\n```json\n{\n  \"mcpServers\": {\n    \"varlet-ui\": {\n      \"command\": \"npx\",\n      \"args\": [\n        \"-y\",\n        \"@fe-fast/varlet-mcp\"\n      ],\n      \"env\": {\n        \"VARLET_VERSION\": \"latest\",\n        \"CACHE_TTL\": \"3600000\"\n      }\n    }\n  }\n}\n```\n\n### Integration with Claude Desktop\n\nAdd to your Claude Desktop configuration file:\n\n**macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`  \n**Windows**: `%APPDATA%/Claude/claude_desktop_config.json`  \n**Linux**: `~/.config/Claude/claude_desktop_config.json`\n\n```json\n{\n  \"mcpServers\": {\n    \"varlet-ui\": {\n      \"command\": \"varlet-mcp-server\",\n      \"args\": [],\n      \"env\": {\n        \"VARLET_VERSION\": \"latest\",\n        \"CACHE_TTL\": \"3600000\"\n      }\n    }\n  }\n}\n```\n\n### Integration with Other MCP Clients\n\nStart the server directly:\n\n```bash\nvarlet-mcp-server\n```\n\nOr use npx:\n\n```bash\nnpx @varlet/mcp\n```\n\n### Usage Examples in Claude\n\nOnce configured, you can ask Claude questions like:\n\n- \"How do I use the Varlet Button component?\"\n- \"Show me the installation guide for Vite\"\n- \"What are the props for var-input?\"\n- \"Generate a mobile layout using Varlet components\"\n- \"Help me migrate from Element Plus to Varlet\"\n\n## 🛠️ Available Tools\n\n### API Tools\n\n| Tool | Description | Parameters |\n|------|-------------|------------|\n| `get_varlet_api_by_version` | Downloads and caches Varlet API types | `version` (string) |\n| `get_component_api_by_version` | Gets detailed component API information | `componentName`, `version` |\n| `get_directive_api_by_version` | Gets directive API information | `directiveName`, `version` |\n| `get_varlet_components_list` | Gets a list of all available components | `version` |\n\n### Documentation Tools\n\n| Tool | Description | Parameters |\n|------|-------------|------------|\n| `get_installation_guide` | Gets installation instructions | `platform`, `ssr`, `fresh` |\n| `get_feature_guides` | Gets a list of available features | - |\n| `get_feature_guide` | Gets a detailed feature guide | `feature` |\n| `get_varlet_exports` | Gets a list of package exports | - |\n| `get_frequently_asked_questions` | Gets the content of frequently asked questions | - |\n| `get_release_notes_by_version` | Gets release notes for a version | `version` |\n| `get_varlet_playground_examples` | Gets playground examples | `component` |\n\n### Smart Prompts\n\n| Prompt | Description | Use Case |\n|--------|-------------|----------|\n| `varlet_component_usage` | Generates component usage examples | Learning component APIs |\n| `varlet_layout_design` | Generates layout design suggestions | Building application layouts |\n| `varlet_migration_guide` | Generates migration guides | Switching from other UI libraries |\n| `varlet_troubleshooting` | Generates troubleshooting guides | Debugging issues |\n| `varlet_performance_optimization` | Generates optimization guides | Improving application performance |\n\n## 📚 Resources\n\nThe server provides several structured resources:\n\n| Resource URI | Content Type | Description |\n|--------------|--------------|-------------|\n| `varlet://api/components` | `application/json` | A complete list of Varlet components, categorized |\n| `varlet://api/directives` | `application/json` | Available directives with usage examples |\n| `varlet://api/utilities` | `application/json` | Utility functions, services, and helpers |\n| `varlet://examples/quick-start` | `text/markdown` | A quick start guide with code examples |\n\n### Resource Example\n\n```javascript\n// Access the component list\nconst components = await mcp.readResource('varlet://api/components')\n\n// Get the quick start guide\nconst guide = await mcp.readResource('varlet://examples/quick-start')\n```\n\n## 🔧 Development\n\n### Setup\n\n```bash\ngit clone https://github.com/varletjs/varlet-mcp.git\ncd varlet-mcp\npnpm install\n```\n\n### Development Mode\n\n```bash\npnpm run dev\n```\n\n### Build\n\n```bash\npnpm run build\n```\n\n### Testing\n\n```bash\npnpm test\n```\n\n### Linting\n\n```bash\npnpm run lint\npnpm run lint:fix\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvarletjs%2Fmcp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvarletjs%2Fmcp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvarletjs%2Fmcp/lists"}