Livewire Flux MCP

一个提供对Livewire Flux组件和布局访问的MCP（模型上下文协议）服务器。此服务器允许AI助手按需获取和搜索Flux组件和布局文档。

⚠️ 免责声明

这是一个个人项目，并未与Livewire Flux官方有任何关联。

支持我

大家好，

你喜欢这个包吗？你觉得它有用，并且适合你的项目吗？

我很高兴能帮助你们，如果你们考虑支持我的工作，我会非常感激。

你可以选择 😃：

• 你可以赞助我 😎
• 你可以给我买杯咖啡 ☕ 或披萨 🍕
• 你可以“点赞 ⭐”这个仓库（顺便说一句，这免费的 😉）

功能

这个MCP服务器抓取并提供了对Livewire Flux文档的结构化访问，使AI助手能够：

• 获取特定Flux组件的文档，从https://fluxui.dev/components/
• 获取特定Flux布局的文档，从https://fluxui.dev/layouts/
• 访问带有API详情、属性和使用模式的组件和布局参考部分
• 搜索组件和布局文档内容
• 列出所有可用的Flux组件
• 浏览和搜索所有可用的Heroicons以供flux:icon组件使用
• 直接从官方Flux网站获取最新的文档
• 高性能缓存，24小时过期，以实现最佳响应时间

可用的MCP工具

服务器提供了四个MCP工具：

1. fetch_flux_docs - 获取组件或布局的文档

   • component（可选）：要获取文档的具体组件名称
   • layout（可选）：要获取文档的具体布局名称（例如，“header”，“sidebar”）
   • search（可选）：用于过滤内容的搜索词
   • 自动包括可用的参考部分
   • 从https://fluxui.dev/components/{component}或https://fluxui.dev/layouts/{layout}获取

2. list_flux_components - 列出所有可用的Flux组件

   • 不需要参数
   • 返回带有https://fluxui.dev/components/前缀的组件
   • 提供组件名称及其文档路径

3. list_flux_layouts - 列出所有可用的Flux布局

   • 不需要参数
   • 返回带有https://fluxui.dev/layouts/前缀的布局
   • 提供布局名称及其文档路径

4. list_flux_component_icons - 列出所有可用于flux:icon组件的Heroicons

   • variant（可选）：按图标变体过滤（outline，solid，mini，micro）
   • search（可选）：用于过滤图标名称的搜索词
   • 从Heroicons GitHub仓库获取实际图标名称
   • 提供每个变体的使用示例、尺寸和GitHub链接
   • 返回所有可用图标的综合列表，附带正确的Flux语法

示例用法

一旦MCP服务器运行，AI助手可以使用它来：

• 获取特定组件的文档：“显示Button组件文档”
• 获取特定布局的文档：“显示header布局文档”
• 搜索内容：“查找所有与表单相关的组件”
• 列出可用组件：“有哪些可用的Flux组件？”
• 列出可用布局：“有哪些可用的Flux布局？”
• 浏览所有可用图标：“显示所有可用于flux:icon的Heroicons”
• 搜索特定图标：“查找所有outline变体的箭头图标”
• 获取图标使用示例：“如何使用solid变体的用户图标？”

服务器会自动从fluxui.dev/components、fluxui.dev/layouts以及GitHub上的Heroicons获取最新文档，并以结构化的格式呈现，便于AI助手轻松消费。在获取组件或布局文档时，它会包括主要内容和带有详细API信息的参考部分。

手动注册MCP服务器

有时你需要手动将Livewire Flux MCP服务器注册到你选择的编辑器中。 你应该使用以下细节注册MCP服务器：

<table> <tr><td><strong>命令</strong></td><td><code>npx</code></td></tr> <tr><td><strong>参数</strong></td><td><code>livewire-flux-mcp</code></td></tr> </table>

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

性能与缓存

MCP服务器包括智能缓存以提供最佳性能：

• 24小时缓存过期 - 内容缓存1天，平衡新鲜度与性能
• 自动缓存管理 - 过期条目自动清理
• 智能缓存键 - 不同参数（组件、布局、搜索、变体）有不同的缓存条目
• GitHub API速率限制保护 - 防止在获取Heroicons时达到GitHub API限制
• 即时响应 - 缓存请求在毫秒内返回，而不是几秒钟

缓存行为

• 文档请求：根据组件/布局和搜索词组合进行缓存
• 组件列表：全局缓存（每天刷新一次）
• 布局列表：全局缓存（每天刷新一次）
• 图标列表：根据变体和搜索组合进行缓存
• 缓存存储：内存中（服务器重启时重置）

缓存系统特别有利于list_flux_component_icons工具，它可以每次请求最多进行4次GitHub API调用而无需缓存。

更新日志

请参阅更新日志了解最近的变化。

贡献

请参阅贡献指南了解详情。

安全漏洞

请查阅我们的安全政策，了解如何报告安全漏洞。

致谢

• Maurizio
• 所有贡献者

许可证

MIT许可证。请参阅许可证文件了解更多信息。