Laravel MCP Companion

原名为 Laravel Docs MCP Server

⚠️ 测试版软件 - 该项目尚处于早期开发阶段。功能可能无法按预期工作，并且可能会发生未经通知的重大变更。

Laravel MCP Companion 是一个全面的文档聚合器和导航器，适用于 Laravel 生态系统。它不生成内容，而是集中并组织来自整个 Laravel 生态系统的高质量现有文档，使其可以通过您的AI助手轻松发现。

为什么选择 Laravel MCP Companion？

功能	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（超过 117 个部分）
• 社区包文档 - 来自 Spatie, Livewire, Inertia, Filament 的 42,000 多行
• 用例映射 - 描述您需要什么，立即获取相关包
• 包集成指南 - 安装和设置 50 多个精选包
• 跨包兼容性 - 学习哪些包可以很好地协同工作
• 统一搜索 跨核心 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 Desktop

1. 打开 Claude Desktop 设置

   • 单击 Claude 菜单 → 设置 → 开发者 → 编辑配置

2. 在配置文件中添加以下内容：

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

3. 重启 Claude Desktop 以使更改生效

配置文件位置：

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

Claude Code

使用 claude mcp add 命令：

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

# 或添加到项目特定配置（用于团队共享）
claude m
cp 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

选项	描述	默认值
--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

功能和路线图

当前功能（v0.8.0）

• ✅ 多版本 Laravel 文档 - 从 6.x 到最新版本的所有版本
• ✅ 自动发现引擎 - 查找 Forge, Vapor, Nova, Envoyer 上的新文档
• ✅ 社区包文档 - 来自 Spatie, Livewire, Inertia, Filament 的 42,000 多行
• ✅ 用例映射 - 描述您需要什么，获取相关包
• ✅ 包集成指南 - 50 多个包的安装和设置
• ✅ 跨包兼容性 - 包组合的文档
• ✅ 统一搜索 - 跨所有文档来源的一次搜索
• ✅ 每日更新 - 自动同步最新文档
• ✅ 经受考验 - 全面的测试套件确保可靠性

即将推出的功能

• 📰 v0.9.0: Laravel 新闻、训练营、教程和高级发现
• 🔍 v0.10.0: 生态系统智能和实时更新
• 🚀 v1.0.0: 完整的 Laravel 文档导航器

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

许可证

本项目根据 MIT 许可证发布 - 详情见 LICENSE 文件。

贡献

欢迎贡献！请参阅 CONTRIBUTING.md 获取指南。

致谢

• Laravel 因其出色的文档
• Laravel 包作者们对生态系统的贡献