项目简介

Laravel MCP Companion 是一个专为Laravel开发者和AI助手设计的模型上下文协议（MCP）服务器。它聚合并管理来自Laravel核心、其官方服务（如Forge, Vapor, Nova, Envoyer）以及流行社区包（如Spatie, Livewire, Inertia, Filament等）的高质量文档。通过提供统一的搜索、阅读和智能推荐功能，该服务器能够让AI助手以极低的延迟访问和利用这些丰富的知识，从而显著提升Laravel开发效率。所有文档可在本地离线访问，且支持自动更新，确保内容始终最新。

主要功能点

多版本Laravel文档支持： 聚合并管理Laravel从6.x到最新版本的核心文档。
Laravel服务文档： 自动发现并索引Forge、Vapor、Envoyer、Nova等官方服务的文档。
社区包文档： 包含Spatie、Livewire、Inertia、Filament等流行Laravel社区包的详细文档。
智能包推荐： 基于特定用例或功能需求，为开发者智能推荐合适的Laravel生态系统包。
统一搜索与导航： 提供跨所有文档源的统一搜索能力，并支持智能导航。
离线访问与自动更新： 所有文档可下载至本地，支持离线查阅，并具备每日自动更新机制。

安装步骤

Laravel MCP Companion 主要通过Docker容器运行，并推荐使用Smithery CLI 或直接在支持MCP的AI客户端中进行配置。

环境准备： 确保您的系统已安装 'Python 3.12+' 和 'Docker'。
通过Smithery CLI 快速安装 (推荐)： 如果您已经安装了 'npm' (Node.js 包管理器)，可以直接运行以下命令进行安装和配置：
```
npx -y @smithery/cli install @brianirish/laravel-mcp-companion --client claude
```
此命令会自动下载Docker镜像，并配置您的AI客户端（如Claude）以连接到服务器。
手动Docker安装与配置： 如果选择手动配置，您需要先拉取并运行Docker镜像。服务器会在第一次启动时自动下载和缓存文档。

服务器配置 (面向MCP客户端)

MCP服务器需要被您的AI客户端（如Claude Desktop, Claude Code等）配置，以便客户端知道如何启动并连接到它。以下是您需要提供给AI客户端的配置信息示例（通常是JSON格式）：

'mcpServers'：客户端配置文件中的顶层键，用于定义所有MCP服务器。
'laravel-mcp-companion'：这是您为该MCP服务器定义的名称，可以自定义。
'command'：启动服务器所使用的命令。对于Docker镜像，通常是 '"docker"'。
'args'：传递给 'command' 的参数列表。这包括 Docker 命令的子命令和服务器自身的启动参数。
- 'run'：Docker 命令，用于运行容器。
- '--rm'：容器停止时自动移除。
- '-i'：保持标准输入流打开（交互模式）。
- 'ghcr.io/brianirish/laravel-mcp-companion:latest'：指定要运行的Docker镜像。
- '--version VERSION'：可选参数，指定要使用的Laravel文档版本（例如 "12.x", "11.x"），默认最新版本。
- '--docs-path PATH'：可选参数，指定文档存储目录，默认在当前运行目录下创建 'docs' 文件夹。
- '--log-level LEVEL'：可选参数，设置日志级别（DEBUG, INFO, WARNING, ERROR, CRITICAL），默认INFO。
- '--update-docs'：可选参数，在服务器启动时更新文档。
- '--force-update'：可选参数，强制更新文档，即使已是最新。
- '--host HOST'：可选参数，如果使用网络传输（如WebSocket），指定监听的主机地址。
- '--port PORT'：可选参数，如果使用网络传输，指定监听的端口。
- '--transport TRANSPORT'：可选参数，指定传输协议（stdio, websocket, sse），默认stdio。

Claude Desktop 配置示例（在 'claude_desktop_config.json' 文件中添加）：

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

Claude Code 配置示例（在终端运行，或添加到项目根目录的 '.mcp.json'）：

# 添加到全局配置
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

基本使用方法

配置完成后，您的AI客户端将能够发现并调用 Laravel MCP Companion 提供的功能。您可以直接向AI助手提问，例如：

"请帮我查找 Laravel 12.x 的路由文档。"
"我需要一个实现订阅支付功能的 Laravel 包，有什么推荐吗？"
"请列出所有关于 Laravel Vapor 的文档。"
"如何使用 Laravel Sanctum 进行 API 认证？"
"请告诉我 Laravel Horizon 的主要功能。"

关键词

信息