Flux UI MCP server

This MCP server provides reference information for Flux UI components, allowing AI assistants to access component documentation and examples through the Model Context Protocol (MCP). It serves as a bridge to Flux UI component references, making it easier to work with the component library.

Features

Available Tools

• list_flux_components - Get a list of all available Flux UI components
• get_flux_component_details - Get detailed information about a specific component
• get_flux_component_examples - Get usage examples for a specific component
• search_flux_components - Search for components by keyword

Installation

Prerequisites

Before installing, make sure you have Node.js installed on your system.

Installation Options

You can install and use the Flux UI MCP server in two ways:

1. Install via npm:

   npm install -g fluxui-mcp-server
   

2. Use without installation via npx:

   npx -y fluxui-mcp-server
   

Configuration

Claude Desktop

To use with Claude Desktop, add the server configuration:

On MacOS: Edit ~/Library/Application Support/Claude/claude_desktop_config.json

On Windows: Edit %APPDATA%/Claude/claude_desktop_config.json

Add the following configuration:

{
  "mcpServers": {
    "fluxui-server": {
      "command": "npx",
      "args": ["-y", "fluxui-mcp-server"]
    }
  }
}

Windsurf Configuration

Add this to your ./codeium/windsurf/model_config.json:

{
  "mcpServers": {
    "fluxui-server": {
      "command": "npx",
      "args": ["-y", "fluxui-mcp-server"]
    }
  }
}

Cursor Configuration

Add this to your .cursor/mcp.json:

{
  "mcpServers": {
    "fluxui-server": {
      "command": "npx",
      "args": ["-y", "fluxui-mcp-server"]
    }
  }
}

Usage Examples

Listing All Components

To get a complete list of all available Flux UI components, use the list_flux_components tool.

Getting Component Details

To retrieve detailed information about a specific component:

1. Use the get_flux_component_details tool
2. Provide the component name as a parameter

This will return information such as:

• Component description
• Available props
• Usage patterns

Finding Component Examples

To see practical examples of a component:

1. Use the get_flux_component_examples tool
2. Provide the component name as a parameter

This returns code samples showing how to implement the component.

Searching Components

To find components related to a specific functionality:

1. Use the search_flux_components tool
2. Provide keywords related to what you're looking for

Troubleshooting

If you encounter issues with the MCP server, you can use the MCP Inspector for debugging:

npx fluxui-mcp-server --inspector

This will provide a URL to access debugging tools in your browser.

How to add this MCP server to Cursor

There are two ways to add an MCP server to Cursor. The most common way is to add the server globally in the ~/.cursor/mcp.json file so that it is available in all of your projects.

If you only need the server in a single project, you can add it to the project instead by creating or adding it to the .cursor/mcp.json file.

Adding an MCP server to Cursor globally

To add a global MCP server go to Cursor Settings > MCP and click "Add new global MCP server".

When you click that button the ~/.cursor/mcp.json file will be opened and you can add your server like this:

{
    "mcpServers": {
        "cursor-rules-mcp": {
            "command": "npx",
            "args": [
                "-y",
                "cursor-rules-mcp"
            ]
        }
    }
}

Adding an MCP server to a project

To add an MCP server to a project you can create a new .cursor/mcp.json file or add it to the existing one. This will look exactly the same as the global MCP server example above.

How to use the MCP server

Once the server is installed, you might need to head back to Settings > MCP and click the refresh button.

The Cursor agent will then be able to see the available tools the added MCP server has available and will call them when it needs to.

You can also explictly ask the agent to use the tool by mentioning the tool name and describing what the function does.