使用说明

项目简介

Starwind UI MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器，专为 Starwind UI 组件库设计。它旨在通过提供一系列工具，增强 AI 助手在 Starwind UI 开发过程中的能力。开发者可以利用此服务器，在 AI 辅助下更高效地进行 Starwind UI 项目的初始化、组件安装、文档查询等操作。

主要功能点

工具化架构：采用模块化设计，方便扩展和添加新的 Starwind UI 相关工具。
Starwind UI 文档工具：快速访问 Starwind UI 组件和指南的官方文档链接。
包管理器检测：自动检测项目使用的包管理器 (npm, yarn, pnpm)。
LLM 数据获取：为 LLM 提供 Starwind UI 相关数据，支持缓存和速率限制，优化数据获取效率。
标准 I/O 传输：使用 stdio 作为与 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': 检测并返回当前项目使用的包管理器信息。

安装步骤

安装依赖：确保你的开发环境中已安装 Node.js 和 pnpm。克隆仓库到本地后，在仓库根目录运行 'pnpm install' 命令安装项目依赖。
```
pnpm install
```
构建项目：运行 'pnpm build' 命令编译 TypeScript 代码。
```
pnpm build
```
启动服务器：运行 'pnpm start' 命令启动 MCP 服务器。
```
pnpm start
```

服务器配置

MCP 服务器需要配置在支持 MCP 协议的客户端（如 Windsurf, Cursor）中。配置信息通常为 JSON 格式，以下是一个配置示例，你需要根据你的实际环境进行调整。

{
	"mcpServers": {
		"starwind ui": { // 服务器名称，可以自定义，用于在客户端中标识
			"command": "node", // 启动服务器的命令，通常为 node
			"args": ["/path/to/starwind-ui-mcp/dist/server.js"], // 启动参数，指向编译后的服务器入口文件 server.js，请替换为实际路径
			"env": {} // 环境变量，如果服务器需要特定的环境变量，可以在这里配置，通常为空
		}
	}
}

配置说明:

'"starwind ui"': 服务器名称，在客户端中用于标识和选择此服务器，可以自定义。
'"command": "node"': 指定启动服务器的命令为 'node'，表示使用 Node.js 运行时环境。
'"args": ["/path/to/starwind-ui-mcp/dist/server.js"]': 重要：这里需要配置服务器启动参数。
- '"/path/to/starwind-ui-mcp/dist/server.js"': 你需要将 '/path/to/starwind-ui-mcp' 替换为 你本地仓库 'starwind-ui-mcp' 文件夹的绝对路径。 'dist/server.js' 是编译后的服务器入口文件。
'"env": {}': 用于设置服务器运行时的环境变量，通常情况下为空对象 '{}'。

请务必根据你的实际仓库路径，修改 'args' 数组中的文件路径。

基本使用方法

确保 MCP 服务器已成功启动 ('pnpm start')。
在你的 MCP 客户端中，按照客户端的指引（例如 Windsurf 或 Cursor 的 MCP 配置文档），配置并连接到 "starwind ui" 服务器。
连接成功后，你可以在 AI 客户端中，通过自然语言指令调用 Starwind UI MCP 服务器提供的工具，例如：
- 在 AI 编辑器中输入指令，让 AI 助手初始化 Starwind UI 项目。
- 询问如何安装某个 Starwind UI 组件，AI 助手会调用 'install_component' 工具并返回安装命令。
- 请求查询某个组件的文档链接，AI 助手会调用 'get_documentation' 工具并返回文档 URL。

具体工具的使用和参数，可以参考仓库 'README.md' 中 "Available Tools" 表格的描述，以及各个工具 'inputSchema' 的定义。

关键词