AI Integration

# 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.

<span class="sr-only">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. Both files are available directly from this website at [starwind.dev/llms.txt](https://starwind.dev/llms.txt) and [starwind.dev/llms-full.txt](https://starwind.dev/llms-full.txt).</span>

## 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 has been completely revamped with new tools and improved functionality. Try it out!

### MCP Quick Start

The MCP server is a published package at [@starwind-ui/mcp](https://www.npmjs.com/package/@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:

<DocsTabs defaultValue="windsurf" syncKey="ide" class="min-h-[140.49px]">
<DocsTabsList>
<DocsTabsTrigger value="windsurf">Windsurf</DocsTabsTrigger>
<DocsTabsTrigger value="cursor">Cursor</DocsTabsTrigger>
<DocsTabsTrigger value="claude">Claude Code</DocsTabsTrigger>
<DocsTabsTrigger value="codex">Codex</DocsTabsTrigger>
</DocsTabsList>
<DocsTabsContent value="windsurf">
```json title="mcp_config.json"
{
  "mcpServers": {
    "starwind-ui": {
      "command": "npx",
      "args": ["-y", "@starwind-ui/mcp"],
      "env": {}
    }
  }
}
```
</DocsTabsContent>
<DocsTabsContent value="cursor">
```json title="mcp.json"
{
  "mcpServers": {
    "starwind-ui": {
      "command": "npx",
      "args": ["-y", "@starwind-ui/mcp"],
      "env": {}
    }
  }
}
```
</DocsTabsContent>
<DocsTabsContent value="claude">
```json title=".mcp.json"
{
  "mcpServers": {
    "starwind-ui": {
      "command": "npx",
      "args": ["-y", "@starwind-ui/mcp"],
      "env": {}
    }
  }
}
```
</DocsTabsContent>
<DocsTabsContent value="codex">
```toml title=".codex/config.toml"
[mcp_servers.starwind_ui]
command = "npx"
args = ["-y", "@starwind-ui/mcp"]
```
</DocsTabsContent>
</DocsTabs>

Detailed instructions:

- [Windsurf MCP Setup](https://docs.windsurf.com/windsurf/cascade/mcp)
- [Cursor MCP Setup](https://cursor.com/docs/context/mcp)
- [Claude Code MCP Setup](https://docs.anthropic.com/en/docs/claude-code/mcp)

### Available Tools

<DocsBadge variant="info" text="New" size="md" class="mr-1" /> The MCP server has been completely revamped with new tools and improved functionality.

| Tool Name                    | Description                                                                   |
| ---------------------------- | ----------------------------------------------------------------------------- |
| `starwind_init`              | Initializes a Starwind UI project                                             |
| `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                 |

## AI Reference Files

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

1. **Overview Reference** - A concise guide with key links and import patterns:
```
https://starwind.dev/llms.txt
```

2. **Comprehensive Reference** - A detailed documentation with complete API references:
```
https://starwind.dev/llms-full.txt
```

Both files are available directly from this website at [starwind.dev/llms.txt](https://starwind.dev/llms.txt) and [starwind.dev/llms-full.txt](https://starwind.dev/llms-full.txt).

### 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](https://github.com/starwind-ui/starwind-ui/issues) in the GitHub repository.