星风UI MCP 服务器

一个使用 TypeScript 实现的 Starwind UI 模型上下文协议 (MCP) 服务器，为开发人员提供工具以帮助处理 Starwind UI 组件。

快速开始

# 安装依赖
pnpm install

# 构建 TypeScript 代码
pnpm build

# 启动服务器
pnpm start

设置您的 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 设置

什么是 MCP？

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

特性

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

可用工具

开发

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

项目结构

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

添加新工具

要在服务器中添加自己的工具：

1. 在 src/tools/ 目录下创建一个新的工具文件
2. 在 src/tools/index.ts 中注册该工具
3. 在 src/config/settings.ts 中启用该工具
4. 使用 pnpm build 重建服务器
5. 使用 pnpm start 重启服务器

许可证

MIT License - 有关详细信息，请参阅 LICENSE 文件。