Starwind UI

Provides live Starwind UI docs, component validation, Pro blocks search, and package manager detection via a local MCP server.

typescript

33

GitHub Stars

typescript

Language

6 months ago

First Indexed

2 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

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

You can run and connect to a Starwind UI MCP server to extend AI capabilities locally for Starwind UI components. This TypeScript MCP server provides live documentation access, component validation, Pro blocks search, and automatic package manager detection, making it easier to integrate Starwind UI with AI tools while keeping everything self-contained on your machine.

How to use

To use the Starwind UI MCP server, install and run the local MCP server on your development machine, then configure your MCP client to connect to it. You will be able to fetch live Starwind UI docs, validate components against the live list, search Starwind Pro blocks, and benefit from automatic package manager detection during your AI-assisted workflows.

How to install

Prerequisites you need before installing the MCP server:

Install Node.js (which includes npm) from the official site or use your system package manager.
Verify installation with: node -v and npm -v.

Step-by-step setup to run the MCP server locally using npx (no local install required):

# Run the MCP server using npx. This pulls the Starwind UI MCP package and starts the server.
npx -y @starwind-ui/mcp

If you prefer to point a local client to a reusable configuration, prepare an MCP config snippet like this and use it in your MCP client setup.

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

Additional sections

Configuration details, security considerations, and troubleshooting tips are described below to help you smoothly use the MCP server with your development workflow.

Notes on usage and capabilities

This MCP server offers live documentation access, component validation against the live Starwind UI component list, Pro blocks search by query or category, and automatic detection of package managers. It is built with TypeScript for strong typing and safer integration with AI tools.

Available tools

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