Starwind UI MCP 服务器

一个用于 Starwind UI 的模型上下文协议 (MCP) 服务器的 TypeScript 实现，提供工具来帮助开发者使用 Starwind UI 组件。

快速开始

# 安装依赖
pnpm install

# 构建 TypeScript 代码
pnpm build

# 启动服务器
pnpm start

设置你的 IDE

设置你的 IDE 以使用本地 MCP 服务器的说明因 IDE 而异。以下是 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 特定的工具，以增强在使用 Starwind UI 时的 AI 助手功能。 有关 MCP 本身的更多信息，请访问官方文档。

特性

• 基于工具的架构 - 模块化设计，易于添加新工具
• Starwind UI 文档工具 - 访问 Starwind UI 组件的文档链接
• 包管理器检测 - 检测并使用适当的包管理器 (npm, yarn, pnpm)
• LLM 数据获取器 - 检索 Starwind UI 信息以供 LLM 使用，具有缓存和速率限制
• TypeScript 实现 - 使用 TypeScript 构建，以获得更好的类型安全性和开发者体验
• 标准 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	检测并返回当前的包管理器信息

开发

此项目设置为使用 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 文件。