Laravel MCP Companion

🚀 Laravel MCP Companion

Laravel MCP Companion 是一款面向 Laravel 生態系統的綜合文檔聚合與導航工具。它並不生成內容，而是將 Laravel 生態系統中現有的高質量文檔進行集中和整理，讓你可以通過 AI 助手輕鬆找到所需文檔。

⚠️ 重要提示

本項目處於早期開發階段。功能可能無法按預期工作，且可能會在無通知的情況下發生重大變更。

🚀 快速開始

Laravel MCP Companion 是 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 桌面端

1. 打開 Claude 桌面端設置
   • 點擊 Claude 菜單 → 設置 → 開發者 → 編輯配置
2. 將以下內容添加到配置文件中

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

3. 重啟 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

📚 詳細文檔

當前功能

• ✅ 多版本 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 包作者為生態系統做出的貢獻