Starwind UI MCP Server

Starwind UI MCP Server

site icon
2025.04.05 13
TypeScript开发工具UI 组件管理开发效率
Starwind UI MCP Server 是一个基于 TypeScript 实现的 Model Context Protocol (MCP) 服务器,专为 Starwind UI 组件开发设计。它提供了一系列工具,帮助开发者更高效地使用和管理 Starwind UI 组件,包括项目初始化、组件安装与更新、文档获取等功能。该服务器采用模块化设计,支持通过标准输入输出(stdio)与 AI 助手进行通信,适用于需要增强 AI 辅助开发能力的场景。
View on GitHub

Overview

基本能力

产品定位

Starwind UI MCP Server 是一个专为 Starwind UI 组件开发设计的 MCP 服务器,旨在通过提供一系列工具来增强开发者的工作效率和 AI 辅助开发能力。

核心功能

  • 工具化架构:模块化设计,便于添加新工具。
  • Starwind UI 文档工具:提供 Starwind UI 组件的文档链接。
  • 包管理器检测:自动检测并使用合适的包管理器(npm、yarn、pnpm)。
  • LLM 数据获取:从 starwind.dev 获取 LLM 数据,支持缓存和速率限制。
  • TypeScript 实现:基于 TypeScript 开发,提供更好的类型安全和开发体验。
  • 标准 I/O 传输:使用 stdio 与 AI 助手通信。

适用场景

  • 开发者在开发过程中需要快速获取 Starwind UI 组件文档。
  • 需要自动化管理 Starwind UI 组件的安装和更新。
  • 需要与 AI 助手集成以增强开发效率的场景。

工具列表

工具名称 描述
init_project 初始化一个新的 Starwind UI 项目
install_component 生成 Starwind UI 组件的安装命令
update_component 生成 Starwind UI 组件的更新命令
get_documentation 返回 Starwind UI 组件和指南的文档链接
fetch_llm_data 从 starwind.dev 获取 LLM 数据(支持速率限制和缓存)
get_package_manager 检测并返回当前包管理器信息

使用教程

使用依赖

  1. 确保已安装 Node.js 和 pnpm。
  2. 克隆项目仓库。

安装教程

# 安装依赖
pnpm install

# 构建 TypeScript 代码
pnpm build

# 启动服务器
pnpm start

调试方式

  1. 启动服务器后,可以通过标准输入输出与服务器通信。
  2. 使用 IDE 配置(如 Windsurf 或 Cursor)连接本地 MCP 服务器。

IDE 配置示例(Windsurf)

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

常见问题解答

  • 如何添加新工具?
  • src/tools/ 目录下创建新工具文件。
  • src/tools/index.ts 中注册工具。
  • src/config/settings.ts 中启用工具。
  • 重新构建并启动服务器。

  • 如何更改包管理器? 修改 package.json 文件中的命令以适应您的包管理器。

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。