Starwind Ui MCP

🚀 Starwind UI MCP Server

A Starwind UI Model Context Protocol (MCP) server implemented in TypeScript, providing developers with tools to handle Starwind UI components.

🚀 Quick Start

# Install dependencies
pnpm install

# Build TypeScript code
pnpm build

# Start the server
pnpm start

Set Up Your IDE

The instructions for setting up a local MCP server vary depending on the IDE. Here's an example using Windsurf:

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

For detailed instructions:

• Windsurf MCP Setup
• Cursor MCP Setup

What is MCP?

The Model Context Protocol (MCP) is a protocol for extending AI capabilities through a local server. This implementation provides specific tools for Starwind UI to enhance functionality when collaborating with AI assistants. For more detailed information about MCP, 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 - Fetch Starwind UI information from starwind.dev (with rate limiting and caching).
• TypeScript implementation - Implemented in TypeScript for better type safety and development experience.
• Standard I/O transport - Communicate with AI assistants using stdio.

🛠️ Available Tools

💻 Development

This project uses PNPM as the package management tool for the development environment. If you don't use pnpm, you need to update the package.json file to suit the commands of your desired package manager.

📁 Project Structure

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

➕ Add 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 using pnpm build.
5. Restart the server using pnpm start.

📄 License

MIT License - For detailed information, please refer to the LICENSE file.