What is Starwind Ui Mcp

starwind-ui-mcp is a TypeScript implementation of a Model Context Protocol (MCP) server designed specifically for Starwind UI. It provides tools to enhance the development experience when working with Starwind UI components and can be used with various AI tools like Cursor and Windsurf.

Use cases

starwind-ui-mcp can be used for developing applications with Starwind UI, integrating AI tools for enhanced functionality, and providing developers with easy access to documentation and component management commands.

How to use

To use starwind-ui-mcp, first install the dependencies using ‘pnpm install’. Then, build the TypeScript code with ‘pnpm build’ and start the server using ‘pnpm start’. For IDE setup, configure the MCP server in your IDE settings as per the provided examples.

Key features

Key features include a tool-based architecture for easy tool addition, a Starwind UI documentation tool for quick access to component documentation, package manager detection, an LLM data fetcher with caching and rate limiting, and a TypeScript implementation for improved type safety.

Where to use

undefined

Starwind UI MCP Server

A TypeScript implementation of a Model Context Protocol (MCP) server for Starwind UI, providing tools to help developers work with Starwind UI components.

Quick Start

# Install dependencies
pnpm install

# Build the TypeScript code
pnpm build

# Start the server
pnpm start

Installing via Smithery

To install Starwind UI MCP Server for Claude Desktop automatically via Smithery:

npx -y @smithery/cli install @Boston343/starwind-ui-mcp --client claude

Setup Your IDE

Instructions to set up your IDE to use a local MCP server vary by IDE. Here is an example for Windsurf:

{
  "mcpServers": {
    "starwind ui": {
      "command": "node",
      "args": [
        "c:\\path\\to\\folder\\starwind-ui-mcp\\dist\\server.js"
      ],
      "env": {}
    }
  }
}

Detailed instructions:

• Windsurf MCP Setup
• Cursor MCP Setup

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

• Tool-based Architecture - Modular design for easy addition of new tools
• Starwind UI Documentation Tool - Access documentation links for Starwind UI components
• Package Manager Detection - Detect and use the appropriate package manager (npm, yarn, pnpm)
• LLM Data Fetcher - Retrieve Starwind UI information for LLMs with caching and rate limiting
• TypeScript Implementation - Built with TypeScript for better type safety and developer experience
• Standard I/O Transport - Uses stdio for communication with AI assistants

Available Tools

Development

This project is set up to use PNPM for package manager for development purposes. If you are not using pnpm, you will need to update the package.json file with the appropriate package manager commands you need.

Project Structure

src/
  ├── config/         # Server configuration
  │   └── settings.ts # Configuration settings
  ├── tools/          # MCP tools implementations
  │   ├── index.ts    # Tool registration
  │   └── *.ts        # Individual tool implementations
  ├── utils/          # Utility functions
  └── server.ts       # Main MCP server implementation

Adding New Tools

To add your own tools to the server:

1. Create a new tool file in the src/tools/ directory
2. Register the tool in src/tools/index.ts
3. Enable the tool in src/config/settings.ts
4. Rebuild the server with pnpm build
5. Restart the server with pnpm start

License

MIT License - See LICENSE file for details.

Security