Starwind Ui MCP Server

🚀 Starwind UI MCP Server

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

🚀 Quick Start

Manual Installation

# Install dependencies
pnpm install

# Build TypeScript code
pnpm build

# Start the server
pnpm start

Installation via Smithery

To automatically install the Starwind UI MCP Server via Smithery:

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

Configure Your IDE

The instructions for configuring the use of the local MCP server vary depending on the IDE. Here is an example for Windsurf:

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

For detailed instructions:

• Windsurf MCP Configuration
• Cursor MCP Configuration

💡 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 the functionality of AI assistants when dealing with Starwind UI components. For more detailed information about MCP, 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 - Fetch LLM data from starwind.dev (with rate limiting and caching)
• TypeScript implementation - Written 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 use commands suitable for your package manager.

📁 Project Structure

src/
  ├── config/         # Server configuration
  │   └── settings.ts # Configuration settings
  ├── tools/          # MCP tool implementations
  │   ├── index.ts    # Tool registration
  │   └── *.ts        # Implementation files for each tool
  ├── utils/          # Utility functions
  └── server.ts       # Main server file

🤝 Contribution

Contributions to this project are welcome! Please refer to the CONTRIBUTING.md file for more information.

📄 License

This project is protected by the MIT License.