Starwind Ui MCP Server

🚀 星风UI MCP 服务器

一个基于 TypeScript 实现的 Starwind UI 模型上下文协议（MCP）服务器，为开发者提供与 Starwind UI 组件进行交互的工具，助力开发工作。

🚀 快速开始

手动安装

# 安装依赖
pnpm install

# 构建 TypeScript 代码
pnpm build

# 启动服务器
pnpm start

通过 Smithery 安装

要通过 Smithery 自动安装 Starwind UI MCP Server，可执行以下命令：

npx -y @smithery/cli install @Boston343/starwind-ui-mcp --client claude

配置您的 IDE

根据不同的 IDE，配置使用本地 MCP 服务器的说明也有所不同。以下是一个适用于 Windsurf 的示例：

{
    "mcpServers": {
        "starwind ui": {
            "command": "node",
            "args": ["c:\\path\\to\\folder\\starwind-ui-mcp\\dist\\server.js"],
            "env": {}
        }
    }
}

详细说明可参考：

• Windsurf MCP 配置
• Cursor MCP 配置

✨ 主要特性

• 基于工具的架构✨ - 模块化设计，可轻松添加新工具。
• Starwind UI 文档工具📄 - 可访问 Starwind UI 组件的文档链接。
• 包管理器检测🧐 - 自动检测并使用适当的包管理器（npm、yarn、pnpm）。
• LLM 数据获取器📈 - 从 starwind.dev 获取 LLM 数据（带速率限制和缓存）。
• TypeScript 实现💪 - 使用 TypeScript 编写，提供更好的类型安全性和开发体验。
• 标准 I/O 运输📡 - 使用 stdio 与 AI 助手通信。

📚 详细文档

什么是MCP？

模型上下文协议（MCP）是一种通过本地服务器扩展 AI 功能的协议。此实现为 Starwind UI 提供了特定工具，以增强与 AI 助手在处理 Starwind UI 组件时的功能。有关 MCP 的更多详细信息，请访问 官方文档。

可用工具

🔧 技术细节

开发

该项目使用 PNPM 作为开发环境的包管理工具。如果您不使用 pnpm，则需要更新 package.json 文件，以使用适合您的包管理器命令。

项目结构

src/
  ├── config/         # 服务器配置
  │   └── settings.ts # 配置设置
  ├── tools/          # MCP 工具实现
  │   ├── index.ts    # 工具注册
  │   └── *.ts        # 各个工具的实现文件
  ├── utils/          # 工具函数
  └── server.ts       # 服务器主文件

🤝 贡献

欢迎为该项目做贡献！请参考 CONTRIBUTING.md 文件以获取更多信息。

📄 许可证

本项目受 MIT License 保护。