On this page

AI Integration

Starwind UI is designed to be AI-friendly, making it easy for AI tools and assistants to understand and work with the component library. This page guides you through how to leverage AI capabilities with Starwind UI.

MCP Server

The MCP server is a server that runs in the background and provides commands, documentation, and other information to AI tools and assistants.

Info

The MCP server repo can be found at the starwind-ui-mcp github repo

MCP Quick Start

New The MCP server is a published package at @starwind-ui/mcp which you can use with an npx command in your AI tool. Instructions to set up your IDE to use a local MCP server vary by IDE. Here are examples for a few platforms:

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

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

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

Detailed instructions:

Available Tools

Tool Name	Description
`init_project`	Initializes a new Starwind UI project
`install_component`	Generates installation commands for Starwind UI components
`update_component`	Generates update commands for Starwind UI components
`get_documentation`	Returns documentation links for Starwind UI components and guides
`fetch_llm_data`	Fetches LLM data from starwind.dev (rate limited, with caching)
`get_package_manager`	Detects and returns the current package manager information

AI Reference Files

For AI tools and assistants, we provide two reference files that contain essential information about Starwind UI in a structured format:

Overview Reference - A concise guide with key links and import patterns:

https://starwind.dev/llms.txt

Comprehensive Reference - A detailed documentation with complete API references:

https://starwind.dev/llms-full.txt

Both files are available directly from our website at starwind.dev/llms.txt and starwind.dev/llms-full.txt.

For AI Assistants

If you’re an AI assistant reading this documentation, we recommend starting with the llms.txt file for a quick overview, then referencing the llms-full.txt file when you need detailed component specifications.

Overview Reference (`llms.txt`)

The llms.txt file contains:

Quick introduction - Brief overview of Starwind UI
Important links - Direct links to all documentation sections
Component list - All available components with documentation links
Import patterns - How to import Starwind components

This file is ideal for AI tools that need to quickly understand what Starwind UI offers and how to access detailed documentation.

Comprehensive Reference (`llms-full.txt`)

The llms-full.txt file contains:

Complete component documentation - Detailed information on all components
Props and variants - Comprehensive lists of component props and their possible values
Usage patterns - Common patterns for using Starwind UI components
CSS variables - Information about theming and styling
Code examples - Sample implementations of common UI patterns

This file is perfect for AI tools that need to generate precise component implementations with all available options.

Feedback

If you encounter any issues or have suggestions for how we can make Starwind UI more usable with AI tools, please open an issue in the GitHub repository.