What is Flux Ui Mcp

flux-ui-mcp is a TypeScript-based MCP server designed to provide reference information for Flux UI components, enabling AI assistants to access documentation and examples for these components.

Use cases

Use cases for flux-ui-mcp include assisting developers in finding component documentation quickly, providing examples for component usage, and enhancing the development workflow by integrating with AI assistants.

How to use

To use flux-ui-mcp, you need to configure it in your application. You can either build it locally and specify the path in your configuration file or use the npx command to run it directly. Configuration examples are provided for Claude Desktop, Windsurf, and Cursor.

Key features

Key features include tools to list all available Flux UI components, retrieve detailed information about specific components, get usage examples, and search components by keywords. It also scrapes and caches data from the official Flux UI documentation site.

Where to use

flux-ui-mcp can be used in software development environments where Flux UI components are utilized, particularly in applications that require dynamic user interfaces and component-based architecture.

Flux UI MCP Server

MCP server for Flux UI component references

This is a TypeScript-based MCP server that provides reference information for Flux UI components. It implements a Model Context Protocol (MCP) server that helps AI assistants access Flux UI component documentation and examples.

Features

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

Functionality

This server scrapes and caches information from:

• The official Flux UI documentation site (https://fluxui.dev)

It provides structured data including:

• Component descriptions
• Usage examples
• Props
• Code samples

Development

Install dependencies:

npm install

Build the server:

npm run build

For development with auto-rebuild:

npm run watch

Installation

Claude Desktop Configuration

To use with Claude Desktop, add the server config:

On MacOS: ~/Library/Application Support/Claude/claude_desktop_config.json
On Windows: %APPDATA%/Claude/claude_desktop_config.json

Option 1: Using local build

{
  "mcpServers": {
    "fluxui-server": {
      "command": "/path/to/fluxui-mcp-server/build/index.js"
    }
  }
}

Option 2: Using npx command

{
  "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"
      ]
    }
  }
}

Debugging

Since MCP servers communicate over stdio, debugging can be challenging. We recommend using the MCP Inspector, which is available as a package script:

npm run inspector

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