Starwind Ui MCP

🚀 星風UI MCP 服務器

星風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 設置

✨ 主要特性

• 基於工具的架構：採用模塊化設計，方便輕鬆添加新工具。
• Starwind UI 文檔工具：可訪問 Starwind UI 組件的文檔鏈接。
• 包管理器檢測：能檢測並使用適當的包管理器（如 npm、yarn、pnpm）。
• LLM 數據獲取器：從 starwind.dev 獲取 Starwind UI 信息，具備速率限制和緩存功能。
• TypeScript 實現：使用 TypeScript 編寫，提供更好的類型安全性和開發體驗。
• 標準 I/O 運輸：通過 stdio 與 AI 助手進行通信。

📦 安裝指南

該項目使用 PNPM 作為開發環境的包管理工具。若您不使用 pnpm，需更新 package.json 文件以適配您所需的包管理器命令。

💻 使用示例

可用工具列表

📚 詳細文檔

什麼是 MCP？

模型上下文協議 (MCP) 是一種通過本地服務器擴展 AI 功能的協議。此實現為 Starwind UI 提供特定工具，以增強與 AI 助手協作時的功能。有關 MCP 的更多詳細信息，請訪問 官方文檔。

項目結構

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 文件。