Laravel Docs MCP

Laravel MCP伴侣

*前身为Laravel Docs MCP服务器*

](https://github.com/brianirish/laravel-mcp-companion/releases) ](https://www.python.org/downloads/) ](https://github.com/brianirish/laravel-mcp-companion/actions/workflows/ci.yaml)   ](https://github.com/brianirish/laravel-mcp-companion/pkgs/container/laravel-mcp-companion) ](https://github.com/brianirish/laravel-mcp-companion) ](https://github.com/brianirish/laravel-mcp-companion)

⚠️ 测试版软件 -该项目正在积极开发中。功能可能会发生变化，也可能发生重大变化。

Laravel MCP伴侣 是Laravel生态系统的文档聚合器和导航器。它集中和组织了Laravel生态系统中的高质量文档，使其易于通过人工智能助手发现。

如何比较

使用Boost 在编写代码时，您需要项目感知上下文。 使用上下文7 对于非Laravel库。 使用伴侣 学习、研究或需要Laravel文档参考时。

您将获得：

• Laravel多版本文档 （6.x至最新版本）具有增强的搜索功能
• 学习路径 -按主题和技能水平划分的结构化学习序列
• “我需要X”查找器 -描述你需要什么，获取相关文件
• 过滤困难 -按初级/中级/高级组织的内容
• 15个语义类别 -按主题区域浏览文档
• 自动发现Laravel服务 -锻造、蒸汽、发送、Nova（117+部分）
• 社区包文档 -来自Spatie、Livewire、Inertia、Filament的42000+行
• 包装集成指南 -50多个精选套餐的安装和设置
• 跨包兼容性 -了解哪些包可以很好地协同工作
• 统一搜索 跨核心Laravel文档、服务和包
• 每日更新 -自动与最新文档同步

安装

克劳德桌面

1. 打开克劳德桌面设置

- 点击克劳德菜单→ 设置→ 开发者→ 编辑配置

1. 添加到配置文件中：

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

1. 重新启动克劳德桌面 使更改生效

配置文件位置：

• 窗户： %APPDATA%\Claude\claude_desktop_config.json
• macOS： ~/Library/Application Support/Claude/claude_desktop_config.json

克劳德代码

使用 claude mcp add 命令：

# Add with Docker
claude mcp add laravel-mcp-companion -- docker run --rm -i ghcr.io/brianirish/laravel-mcp-companion:latest

# Or add to project-specific config (for team sharing)
claude mcp add laravel-mcp-companion --scope project -- docker run --rm -i ghcr.io/brianirish/laravel-mcp-companion:latest

这 --scope project 选项创建 .mcp.json 项目根目录中可以提交到版本控制的文件。

配置选项

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

# Pin to a specific older Laravel version
docker run --rm -i ghcr.io/brianirish/laravel-mcp-companion:latest --version 11.x

# Force update all documentation
docker run --rm -i ghcr.io/brianirish/laravel-mcp-companion:latest --force-update

特性（v0.9.0）

文档聚合

• 多版本Laravel文档 -从6.x到最新版本的所有版本
• 自动发现引擎 -在Forge、Vapor、Nova和Envoyer中查找新文档
• 社区包文档 -来自Spatie、Livewire、Inertia、Filament的42000+行
• 每日更新 -自动与最新文档同步

学习与发现（v0.9.0中的新功能）

• 学习路径 -任何Laravel主题的结构化序列
• 难度等级 -按初级、中级或高级筛选
• 15个类别 -通过身份验证、数据库、测试等进行浏览。
• “我需要X”查找器 -自然语言文档发现
• 相关资源 -自动查找连接的文档

搜索和导航

• 用例映射 -描述你需要什么，获得相关的包
• 包装集成指南 -50多个软件包的安装和设置
• 跨包兼容性 -包装组合文件
• 统一搜索 -跨所有文档源进行一次搜索

即将到来的

• v0.10.0：MCP 2025-11-25规范支持，注册表发布
• v0.11.0：生产强化、监控、安全审计
• v1.0.0：第一个有LTS承诺的稳定版本

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

TOON格式输出

Laravel MCP Companion使用 TOON（面向令牌的对象表示法） 用于结构化输出，节省 30%至60%的代币 与JSON/makdown相比。

输出示例

当你搜索包或列表文档时，你会得到高效的结构化数据：

context: "authentication for SPA"
count: 2
packages[2]{id,name,description,categories,install}:
  laravel/sanctum,Laravel Sanctum,"Featherweight authentication for SPAs",[authentication,spa],"composer require laravel/sanctum"
  laravel/passport,Laravel Passport,"Full OAuth2 implementation",[authentication,api],"composer require laravel/passport"

与等效的JSON（几乎是令牌的2倍）相比：

{"context":"authentication for SPA","count":2,"packages":[{"id":"laravel/sanctum","name":"Laravel Sanctum",...}]}

为什么是TOON？

• 代币高效：LLM本机理解TOON-无解析开销
• 结构化数据：没有JSON冗长的数组、对象和元数据
• AI友好：专为LLM上下文窗口设计

自动发现和更新频率

此应用程序具有 智能自动发现系统 它可以自动查找Laravel文档并为其建立索引。每一天，它：

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

发展

先决条件

• Python 3.12+
• Node.js 18+（用于MCP检查器）

设置

git clone https://github.com/brianirish/laravel-mcp-companion
cd laravel-mcp-companion
python -m venv venv
source venv/bin/activate  # Windows: venv\Scripts\activate
pip install -r requirements.txt -r requirements-dev.txt

运行测试

# All tests with coverage
pytest --cov --cov-report=html

# Unit tests only
pytest tests/unit/

# Integration tests only
pytest tests/integration/

# Protocol compliance tests
pytest tests/protocol/ -m protocol

使用MCP检查员进行手动测试

这 MCP检查员 提供了一个用于测试MCP服务器的可视化UI。

# Launch Inspector (opens browser at http://localhost:6274)
npx @modelcontextprotocol/inspector python laravel_mcp_companion.py

# With specific version
npx @modelcontextprotocol/inspector python laravel_mcp_companion.py --version 11.x

使用检查器可以：

• “工具”选项卡：使用自动生成的输入表单测试所有工具
• 资源选项卡：浏览 laravel:// 和 laravel-external:// 资源
• 提示选项卡：测试提示模板

代码质量

ruff check --fix .     # Linting
mypy --ignore-missing-imports .  # Type checking
black .                # Formatting

许可证

此项目根据MIT许可证获得许可-有关详细信息，请参阅许可证文件。

贡献

欢迎投稿！有关指南，请参阅CONTRIBUTING.md。

致谢

• Laravel的优秀文档
• Laravel包作者对生态系统的贡献