livewire-flux-mcp gives AI assistants live Flux UI docs

lines of HTML codes

If you build Laravel apps with Livewire Flux, your AI coding assistant probably does not know which components are free, which require a paid Pro license, or what the current API looks like. livewire-flux-mcp fixes that by connecting your agent directly to live Flux documentation.

What It Does

The package is an MCP server that scrapes and serves structured Flux documentation on demand. It exposes four tools:

  • fetch_flux_docs: Pulls the full doc page for a specific component or layout, including the reference section with props and API details. When the component requires a paid Flux Pro license, the response is prepended with a [NOTICE] line flagging it.
  • list_flux_components: Lists all available Flux components. Accepts a tier filter (free, pro, or all) and annotates each entry accordingly.
  • list_flux_layouts: Lists all available Flux layouts. Returns a friendly notice if you request v1, which has no layouts route.
  • list_flux_component_icons: Fetches Heroicons from the GitHub repository for use with the flux:icon component, with filtering by variant and search term.

Why Not Just Laravel Boost?

Laravel Boost already indexes Flux through its search-docs tool, but two gaps remain. First, a broad Flux question can return a several-thousand-token dump from a 17k-document corpus. This server fetches the single component page you asked for. Second, Boost ships a hardcoded component list and does not flag which components need a paid license. This server reads tier data live from fluxui.dev/pricing, with a hardcoded fallback if the pricing page is unreachable.

The two tools are designed to work together: keep Boost for Laravel, Livewire, and Pest; let this server handle Flux.

Version and Pro-Tier Support

The server supports both Flux v2 (default, at fluxui.dev) and v1 (at v1.fluxui.dev). The version argument is accepted on fetch_flux_docs, list_flux_components, and list_flux_layouts. Icon lookups are version-independent since Heroicons are not part of Flux versioning.

Setup

The server runs over stdio via npx, so nothing needs a global install. For Claude Code:

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

For Cursor, add to .cursor/mcp.json:

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

Codex, Gemini CLI, VS Code with Copilot Chat (requires v1.102+), and JetBrains Junie are also supported with agent-specific config snippets in the README. On Windows, wrap the command as cmd /c npx -y livewire-flux-mcp.

Running npx livewire-flux-mcp install in a Laravel Boost project writes an AI skill file, guideline files, and optionally a Claude Code subagent. The skill file deliberately replaces Boost’s bundled fluxui-development skill so Flux lookups route to this server instead.

Caching

Responses are cached in memory with a 24-hour expiration. Cache keys are scoped by component, layout, version, tier, and variant. The icon tool can make up to four GitHub API calls per uncached request, so the cache also serves as GitHub rate-limit protection. Cache resets on server restart.

The package is MIT licensed and available on npm.

Stay on top of AI & Automation with BizStack Newsletter
BizStack  —  Entrepreneur’s Business Stack
Logo