Skip to content

Give AI the full power of Starwind UI - setup new projects, add components, get documentation, search blocks, and more

License

Notifications You must be signed in to change notification settings

starwind-ui/starwind-ui-mcp

Repository files navigation

Starwind UI MCP Server

Verified on MseeP

A TypeScript implementation of a Model Context Protocol (MCP) server for Starwind UI and Starwind Pro, providing tools to help developers work with Starwind UI and Pro components when leveraging AI tools like Claude, Windsurf, Cursor, and more.

Quick Start

Using npx

Instructions to set up your IDE to use a local MCP server vary by IDE. Here are examples for different platforms:

Windsurf:

{
  "mcpServers": {
    "starwind-ui": {
      "command": "npx",
      "args": ["-y", "@starwind-ui/mcp"],
      "env": {}
    }
  }
}

Cursor:

{
  "mcpServers": {
    "starwind-ui": {
      "command": "npx",
      "args": ["-y", "@starwind-ui/mcp"],
      "env": {}
    }
  }
}

Claude Code:

{
  "mcpServers": {
    "starwind-ui": {
      "command": "npx",
      "args": ["-y", "@starwind-ui/mcp"],
      "env": {}
    }
  }
}

Detailed instructions:

Available Tools

Tool Name Description
starwind_init Initializes a Starwind UI project (Pro by default). Use this FIRST.
starwind_docs Fetches live documentation from starwind.dev with caching and topic filtering
starwind_add Generates validated install commands with package manager detection
search_starwind_pro_blocks Searches Starwind Pro blocks by query, category, or plan type

What is MCP?

The Model Context Protocol (MCP) is a protocol for extending AI capabilities through local servers. This implementation provides Starwind UI-specific tools to enhance AI assistant capabilities when working with Starwind UI. For more information about MCP itself, please visit the official documentation.

Features

  • Live Documentation - Fetches up-to-date docs from starwind.dev/llms.txt
  • Component Validation - Validates components against the live component list
  • Pro Blocks Search - Search and discover Starwind Pro blocks by query, category, or plan
  • Package Manager Detection - Auto-detects npm, yarn, or pnpm
  • Caching & Rate Limiting - Efficient caching with sensible rate limits
  • TypeScript - Built with TypeScript for type safety

License

MIT License - See LICENSE file for details.

Security

MseeP.ai Security Assessment Badge

About

Give AI the full power of Starwind UI - setup new projects, add components, get documentation, search blocks, and more

Resources

License

Stars

Watchers

Forks

Sponsor this project

Packages

No packages published

Contributors 5