JinDaGe - laravel-mcp-companion MCP Details

article

README

🚀 Laravel MCP Companion

Laravel MCP Companion 是一款面向 Laravel 生态系统的综合文档聚合与导航工具。它并不生成内容，而是将 Laravel 生态系统中现有的高质量文档进行集中和整理，让你可以通过 AI 助手轻松找到所需文档。

⚠️ 重要提示

本项目处于早期开发阶段。功能可能无法按预期工作，且可能会在无通知的情况下发生重大变更。

🚀 快速开始

Laravel MCP Companion 是 Laravel 生态系统的文档聚合与导航工具，下面为你介绍使用前的安装步骤。

✨ 主要特性

与其他工具对比

| 特性 | Laravel MCP Companion | Context7 | |---------|:--------------------:|:--------:| | 即时文档检索（零延迟） | ✅ | ❌ | | Laravel 多版本支持（6.x - 最新版本） | ✅ | ❌ | | Laravel 服务文档（Forge、Vapor、Nova、Envoyer） | ✅ | ❌ | | 精选 Laravel 包推荐 | ✅ | ❌ | | 离线文档访问 | ✅ | ❌ | | 预处理 Markdown（节省令牌） | ✅ | ❌ | | 使用时无需网络请求 | ✅ | ❌ | | Laravel 特定搜索 | ✅ | ❌ | | 服务文档自动发现 | ✅ | ❌ | | 通用文档（非 Laravel） | ❌ | ✅ |

Context7 在通用文档检索方面表现出色，但 Laravel MCP Companion 专为 Laravel 开发者打造，具备更快、支持离线使用以及 Laravel 特定的功能。

你将获得以下功能

多版本 Laravel 文档（6.x 至最新版本），支持增强搜索
Laravel 服务自动发现 - Forge、Vapor、Envoyer、Nova
社区包文档 - Spatie、Livewire、Inertia、Filament
精选包推荐，附带详细的集成指南
统一搜索，可在 Laravel 核心文档、服务和包中进行搜索
智能导航 - 可根据你的使用场景精确找到所需内容
面向未来的更新 - 可自动适应 Laravel 服务的变化

自动发现与更新频率

本应用具备智能自动发现系统，可自动查找并索引 Laravel 文档。它每天会执行以下操作：

✅ 自动发现 Laravel 服务（Forge、Vapor、Nova、Envoyer）中的新文档部分
✅ 获取 6.x 版本以来所有版本的最新 Laravel 核心文档
✅ 获取社区包文档（Spatie、Livewire、Inertia、Filament）
✅ 自动适应 文档网站的结构变化
✅ 自动生成 新的补丁版本

📦 安装指南

通过 Smithery 快速安装

npx -y @smithery/cli install @brianirish/laravel-mcp-companion --client claude

注意：Smithery 会自动配置你的 AI 客户端。

Claude 桌面端

打开 Claude 桌面端设置
- 点击 Claude 菜单 → 设置 → 开发者 → 编辑配置

将以下内容添加到配置文件中

{
  "mcpServers": {
    "laravel-mcp-companion": {
      "command": "docker",
      "args": ["run", "--rm", "-i", "ghcr.io/brianirish/laravel-mcp-companion:latest"]
    }
  }
}

重启 Claude 桌面端 使更改生效

配置文件位置：

Windows：%APPDATA%\Claude\claude_desktop_config.json
macOS：~/Library/Application Support/Claude/claude_desktop_config.json

Claude 代码端

使用 claude mcp add 命令：

# 使用 Docker 添加
claude mcp add laravel-mcp-companion docker run --rm -i ghcr.io/brianirish/laravel-mcp-companion:latest

# 或者添加到项目特定配置（用于团队共享）
claude mcp add laravel-mcp-companion docker run --rm -i ghcr.io/brianirish/laravel-mcp-companion:latest --scope project

--scope project 选项会在项目根目录创建一个 .mcp.json 文件，可提交到版本控制中。

配置选项

这些选项可与 Docker 命令一起使用，例如：

# 仅更新 Laravel 11.x 的文档
docker run --rm -i ghcr.io/brianirish/laravel-mcp-companion:latest --version 11.x

# 强制更新所有文档
docker run --rm -i ghcr.io/brianirish/laravel-mcp-companion:latest --force-update

# 仅更新 Forge 和 Vapor 服务
docker run --rm -i ghcr.io/brianirish/laravel-mcp-companion:latest --services forge vapor

# 仅更新 Livewire 和 Filament 包
docker run --rm -i ghcr.io/brianirish/laravel-mcp-companion:latest --packages livewire filament

| 选项 | 描述 | 默认值 | |--------|-------------|---------| | --version VERSION | Laravel 版本（例如，"12.x"，"11.x"） | 最新版本 | | --docs-path PATH | 文档目录 | ./docs | | --log-level LEVEL | DEBUG、INFO、WARNING、ERROR、CRITICAL | INFO | | --update-docs | 启动时更新文档 | false | | --force-update | 强制更新文档 | false | | --external-only | 仅更新外部 Laravel 服务 | false | | --core-only | 仅更新 Laravel 核心文档 | false | | --packages-only | 仅更新社区包文档 | false | | --services SERVICE1 SERVICE2 | 更新特定服务（forge、vapor 等） | 所有服务 | | --packages PACKAGE1 PACKAGE2 | 更新特定包（spatie、livewire 等） | 所有包 | | --list-services | 列出可用的 Laravel 服务 | - | | --list-packages | 列出可用的社区包 | - | | --status | 显示所有来源的文档状态 | - |

📚 详细文档

当前功能

✅ 多版本 Laravel 文档 - 涵盖 6.x 到最新版本的所有版本
✅ 自动发现引擎 - 可在 Forge、Vapor、Nova、Envoyer 中查找新文档
✅ 社区包文档 - Spatie、Livewire、Inertia、Filament 的文档
✅ 智能包推荐 - 精选的 Laravel 生态系统包
✅ 统一搜索 - 可在所有文档来源中进行搜索
✅ 每日更新 - 自动与最新文档同步
✅ 经过实战检验 - 全面的测试套件确保可靠性

即将推出的功能

📚 v0.8.0：社区学习资源（Laravel 新闻、教程、指南）
🔍 v0.9.0：跨所有来源的高级搜索和智能导航
🚀 v1.0.0：完整的 Laravel 文档导航器

详细的路线图信息请参阅 ROADMAP.md。

📄 许可证

本项目采用 MIT 许可证，详情请参阅 LICENSE 文件。

贡献

欢迎贡献代码！贡献指南请参阅 CONTRIBUTING.md。

致谢

感谢 Laravel 提供优秀的文档
感谢 Laravel 包作者为生态系统做出的贡献

laravel-mcp-companion