Livewire Flux MCP

An MCP (Model Context Protocol) server that provides access to Livewire Flux Components and Layouts from Livewire Flux. This server allows AI assistants to fetch and search through Flux component and layout documentation on demand.

⚠️ Disclaimer

This is a personal project and is not affiliated with Livewire Flux.

What it does

This MCP server scrapes and provides structured access to the Livewire Flux documentation, enabling AI assistants to:

• Fetch documentation for specific Flux components from https://fluxui.dev/components/
• Fetch documentation for specific Flux layouts from https://fluxui.dev/layouts/
• Access component and layout reference sections with API details, props, and usage patterns
• Search through component and layout documentation content
• List all available Flux components
• Browse and search all available Heroicons for use with flux:icon component
• Access up-to-date documentation directly from the official Flux website
• High-performance caching with 24-hour expiration for optimal response times

Why not just Laravel Boost?

Boost already indexes Flux through its search-docs tool, and for a lot of questions that is enough. Two things it does not do:

• Scoped answers. search-docs is a semantic search over a 17k-document corpus, so a broad Flux question can come back as a several-thousand-token dump (laravel/boost#290). This server fetches the one component page you asked for, plus its reference section.
• Pro-tier awareness. Boost's bundled fluxui-development skill carries a hardcoded component list and does not tell your agent which components need a paid Flux license. This server reads the tier live and flags it, so your agent stops writing markup you cannot ship.

If you are on Boost, npx livewire-flux-mcp install wires both together — see AI Guidelines & Skills. The two are complementary: keep Boost for Laravel, Livewire, Pest and the rest; let this server answer Flux.

Set Up Your Agents

The server runs over stdio and is launched with npx, so there is nothing to install globally. Every agent stores that differently — pick yours below.

{
    "mcpServers": {
        "flux-docs": {
            "command": "npx",
            "args": ["-y", "livewire-flux-mcp"]
        }
    }
}

claude mcp add --transport stdio --scope project flux-docs -- npx -y livewire-flux-mcp

{
    "mcpServers": {
        "flux-docs": {
            "command": "npx",
            "args": ["-y", "livewire-flux-mcp"]
        }
    }
}

codex mcp add flux-docs -- npx -y livewire-flux-mcp

[mcp_servers.flux-docs]
command = "npx"
args = ["-y", "livewire-flux-mcp"]

gemini mcp add --scope project flux-docs npx -y livewire-flux-mcp

{
    "mcpServers": {
        "flux-docs": {
            "command": "npx",
            "args": ["-y", "livewire-flux-mcp"]
        }
    }
}

{
    "servers": {
        "flux-docs": {
            "type": "stdio",
            "command": "npx",
            "args": ["-y", "livewire-flux-mcp"]
        }
    }
}

code --add-mcp '{"name":"flux-docs","command":"npx","args":["-y","livewire-flux-mcp"]}'

{
    "mcpServers": {
        "flux-docs": {
            "command": "npx",
            "args": ["-y", "livewire-flux-mcp"]
        }
    }
}

AI Guidelines & Skills

Registering the server tells your agent the tools exist. It does not tell it when to reach for them — and in a Laravel Boost project it actively will not, because Boost ships a fluxui-development skill that sends Flux lookups to its own search-docs tool and carries a hardcoded component list. This package ships guidance that fixes that:

npx livewire-flux-mcp install

The installer detects what applies: livewire/flux-pro in composer.json selects the fluxui-pro guideline key, livewire/flux selects fluxui-free, and a .claude/ directory adds the subagent. Restrict it with --boost or --claude, point it elsewhere with --path <dir>, or preview with --dry-run. Afterwards run php artisan boost:update so Boost picks the files up.

On overwriting. The skill is a deliberate replacement — Boost resolves custom skills last and keys them on the frontmatter name, so fluxui-development has to match for the override to land. The guideline is never clobbered: an existing file at that path, or the guideline shipped inside the Flux package itself, is preserved below our block, which is delimited by {{-- livewire-flux-mcp:begin --}} markers so re-running only refreshes that section. Any file the installer did not write is left alone unless you pass --force.

To undo, delete the installed files and run php artisan boost:update — Boost restores its own versions.

Laravel Boost only auto-discovers guidelines and skills from Composer packages, so an npm package cannot register them automatically. This installer writes to the paths Boost documents for custom guidelines and skills, which is why it works and survives boost:update.

Support Me

Hey folks,

Do you like this package? Do you find it useful, and it fits well in your project?

I am glad to help you, and I would be so grateful if you considered supporting my work.

You can even choose 😃:

• You can sponsor me 😎
• You can buy me a coffee ☕ or a pizza 🍕
• You can "Star ⭐" this repository (it's free BTW 😉)

Available MCP Tools

The server provides four MCP tools:

1. fetch_flux_docs - Fetches documentation for components or layouts
   • component (optional): Specific component name to fetch docs for
   • layout (optional): Specific layout name to fetch docs for (e.g., "header", "sidebar")
   • version (optional): Flux major version to target — 'v1' or 'v2' (default 'v2')
   • Automatically includes reference sections when available
   • Fetches from https://fluxui.dev/components/{component} or https://fluxui.dev/layouts/{layout} (v2); routes to https://v1.fluxui.dev/components/{component} when version='v1'
   • When the page is a paid Flux component, a [NOTICE] This is a Flux Pro component … line is prepended to the response