On this page

MCP Server

Use the Starwind UI MCP server to give compatible editors and AI tools live access to Starwind docs, validated CLI commands, project context, customization guidance, and Starwind Pro block search.

The published MCP server is available as @starwind-ui/mcp. It runs locally through your MCP client and does not require this docs repo to be checked out.

Quick Start

Select your MCP client and add the Starwind UI server configuration.

[mcp_servers.starwind_ui]
command = "npx"
args = ["-y", "@starwind-ui/mcp"]
enabled = true

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

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

{
  "$schema": "https://opencode.ai/config.json",
  "mcp": {
    "starwind-ui": {
      "type": "local",
      "command": ["npx", "-y", "@starwind-ui/mcp"],
      "enabled": true
    }
  }
}

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

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

After adding the configuration, restart your editor or reload its MCP servers.

What Is MCP?

Model Context Protocol is an open protocol that lets AI assistants connect to external tools and data sources. With the Starwind UI MCP server, an assistant can ask Starwind-specific tools for docs, install commands, project context, customization guidance, and Pro block search results.

How It Works

Your MCP client starts @starwind-ui/mcp locally with npx.
The assistant calls Starwind MCP tools when it needs current docs, commands, or block metadata.
The server returns Starwind-specific data, such as a docs result, validated install command, or Pro block search result.
The assistant applies the result in your project using the docs and, when installed, Starwind Skills.

Available Tools

Current MCP tools include:

Tool Name	Description
`starwind_init`	Generates an initialization command for a Starwind UI or Starwind Pro project.
`starwind_docs`	Fetches Starwind UI docs from starwind.dev, including topic-specific Markdown.
`starwind_add`	Generates validated install commands with package manager detection.
`search_starwind_pro_blocks`	Searches Starwind Pro blocks by query, category, or plan type.

Example Prompts

Once the MCP server is configured, try one of these prompts in your MCP-compatible assistant:

“Show me the Starwind docs for select and dialog.”
“Generate the command to add button, card, and select to this project.”
“Search Starwind Pro for free hero blocks.”
“Find Pro pricing blocks and tell me which ones require a license.”
“Get Starwind customization docs for dark mode and theme tokens.”

Detailed Client Instructions

Troubleshooting

If your editor does not show Starwind MCP tools after adding the config, restart the editor or reload the MCP server from the editor’s MCP settings.

If the server install fails, make sure the client can run npx -y @starwind-ui/mcp and that Node.js is available in the environment used by the editor.

If a Pro block install fails, confirm whether the block is free or premium. Premium blocks require Starwind Pro access and the setup steps in the Installation guide.