@uview-pro/mcp

uView Pro 组件库的 Model Context Protocol (MCP) 服务器，为 AI 编辑器提供组件文档查询支持。

功能特性

• 🔍 组件搜索 - 支持中英文名称模糊搜索
• 📖 API 查询 - 获取 Props、Events、Methods、Slots
• 💡 代码示例 - 查看组件使用示例
• 🌐 平台兼容 - 查询各小程序平台支持情况
• ⚙️ Hooks/Tools - 查询组合式函数和工具函数
• 📚 指南文档 - 获取代码规范、主题配置等
• ✅ 代码验证 - 检查组件使用是否符合规范
• ⚡ 极速响应 - 预构建缓存，毫秒级响应

支持的 AI 编辑器

• ✅ Cursor
• ✅ Claude Desktop
• ✅ Trae AI
• ✅ 其他支持 MCP 协议的编辑器

快速开始

在 AI 编辑器中使用

Cursor:

创建 .cursor/mcp.json：

{
  "mcpServers": {
    "uview-pro": {
      "command": "npx",
      "args": ["-y", "@uview-pro/mcp"]
    }
  }
}

Claude Desktop:

编辑 claude_desktop_config.json：

{
  "mcpServers": {
    "uview-pro": {
      "command": "npx",
      "args": ["-y", "@uview-pro/mcp"]
    }
  }
}

Trae:

创建 .trae/mcp.json：

{
  "mcpServers": {
    "uview-pro": {
      "command": "npx",
      "args": ["-y", "@uview-pro/mcp"]
    }
  }
}

直接运行

npx @uview-pro/mcp

使用示例

在 AI 编辑器中直接提问：

- "uview 有哪些表单组件？"
- "button 组件有哪些属性？"
- "如何使用 useToast？"
- "检查这段代码是否正确使用了 form 组件"

技术栈

• 语言: TypeScript
• 运行时: Node.js 18+
• MCP SDK: @modelcontextprotocol/sdk
• 传输方式: stdio

开发指南

安装依赖

npm install

构建

npm run build

开发模式

npm run dev

构建缓存数据

npm run build:cache

运行测试

npm test

项目结构

├── src/
│   ├── index.ts           # MCP 服务器入口
│   ├── types/             # TypeScript 类型定义
│   ├── parser/            # 文档解析器
│   ├── tools/             # MCP 工具实现
│   └── cache/             # 数据缓存管理
├── scripts/
│   └── build-cache.ts     # 缓存构建脚本
├── data/
│   └── cache.json         # 预解析的数据缓存
├── package.json
├── tsconfig.json
└── README.md

数据来源

本项目的数据来源于 uView Pro 官方文档，文档内容遵循 MIT 许可证。

许可证

MIT License

贡献

欢迎提交 Issue 和 Pull Request！

联系方式

如有问题或建议，请通过以下方式联系：

• GitHub: https://github.com/uview-pro/mcp
• WeChat: anyupxing

Made with ❤️ by uview-pro