Flux UI

Provides MCP access to Flux UI component data by listing components, retrieving details, showing examples, and enabling searches

javascript

91

GitHub Stars

javascript

Language

6 months ago

First Indexed

2 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

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

You can run Flux UI MCP Server to provide reference data for Flux UI components to MCP clients. It exposes a set of tools that let you list components, fetch details and examples, and search by keyword, making it easy to integrate Flux UI documentation into AI assistants and code editors.

How to use

Connect your MCP client to Flux UI MCP Server to access component data. You can run the server locally and then point your client to the local process or to a remote instance if you deploy the server elsewhere. The server exposes tools to list components, retrieve details, get usage examples, and search by keyword, enabling you to fetch component information and code samples on demand.

How to install

# Prerequisites
- Node.js is installed on your system (recommended via Node Version Manager).
- npm is available with Node.js.

# Install dependencies for the MCP server project
npm install

# Build the server for local run
npm run build

# Optional: start in watch mode for auto-rebuild during development
npm run watch

Additional content

Two practical ways to run the Flux UI MCP Server are available. Use the local build approach if you want to run the server from your filesystem, or use npx to launch the server without a local install. Both methods expose the same MCP interfaces to your clients.

Configured MCP server connections

Below are the explicit MCP connection configurations that you can use. One describes running the server via a local build, and the other shows running the server with npx. Each configuration uses stdio to start the server process.

{
  "mcpServers": {
    "fluxui-mcp_local": {
      "type": "stdio",
      "name": "fluxui_mcp_local",
      "command": "node",
      "args": ["build/index.js"]
    },
    "fluxui-mcp_npx": {
      "type": "stdio",
      "name": "fluxui_mcp_npx",
      "command": "npx",
      "args": ["-y", "fluxui-mcp-server"]
    }
  }
}

Available tools

list_flux_components

Retrieve a list of all available Flux UI components so you can present options to users or filter results programmatically.

get_flux_component_details

Fetch detailed information about a specific Flux UI component, including props, descriptions, and usage notes.

get_flux_component_examples

Obtain usage examples for a specific component to demonstrate correct usage and integration patterns.

search_flux_components

Search components by keyword to help users discover relevant Flux UI components quickly.