Starwind UI MCP 服务器

Starwind UI MCP Server 是一个为 Starwind UI 组件设计的 Model Context Protocol (MCP) 服务器实现,基于 TypeScript 开发,旨在帮助开发者更高效地使用 Starwind UI 组件。它提供了一系列工具,包括项目初始化、组件安装与更新、文档获取、LLM 数据获取等功能,支持通过标准 I/O 与 AI 助手进行通信。

  • by nookeshkarri7
  • 更新于
在 GitHub 查看 nookeshkarri7/starwind-ui-mcp2

使用说明

Starwind UI MCP 服务器

产品定位

Starwind UI MCP Server 是一个专为 Starwind UI 组件设计的 MCP 服务器实现,旨在通过提供一系列工具来增强开发者与 Starwind UI 组件的交互体验。

核心功能

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

适用场景

  • 开发 Starwind UI 组件项目时,需要快速初始化项目或安装/更新组件。
  • 需要获取 Starwind UI 组件的文档或 LLM 数据。
  • 需要与 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

# 构建 TypeScript 代码
pnpm build

# 启动服务器
pnpm start

通过 Smithery 安装

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

调试方式

启动服务器后,可以通过标准 I/O 与服务器进行通信。确保服务器正常运行并响应命令。

开发

项目使用 PNPM 作为包管理器进行开发。如果不是使用 pnpm,需要更新 package.json 文件中的命令。

添加新工具

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