项目简介

Croft Laravel 是一个实现了 Model Context Protocol (MCP) 的 PHP 包，专为 Laravel 框架设计。它作为本地的 MCP 服务器运行，使得支持 MCP 协议的 AI 客户端（如 AI 编程助手）能够安全、标准化地访问和交互本地 Laravel 项目的内部信息和功能。

主要功能点

提供丰富的开发工具： 集成了多种实用的工具，允许 AI 客户端执行如列出项目路由、Artisan 命令、配置文件键、环境变量键、查询数据库结构和数据、读取日志、甚至获取应用页面截图等操作。
支持资源访问： 允许将项目内的特定文件、数据库模式或其他信息作为“资源”暴露给 AI 客户端，提供更深入的上下文理解。
支持 Prompt 模板： 支持定义和渲染 Prompt 模板，帮助 AI 客户端生成更符合项目需求的交互内容。
标准化通信： 通过 JSON-RPC 协议与客户端通信，确保互操作性。
可扩展性： 开发者可以轻松创建自定义的工具、资源和 Prompt，以满足特定项目需求。

安装步骤

在你的 Laravel 项目根目录下，使用 Composer 安装 Croft Laravel 包：

composer require usecroft/croft-laravel --dev

（'--dev' 标记表明这是一个开发依赖）

发布 Croft 的配置文件。这将会在 'config' 目录下创建一个 'croft.php' 文件，你可以在其中配置要启用的工具、资源和 Prompt：
```
php artisan vendor:publish --tag="croft-config"
```
根据需要在 'config/croft.php' 文件中启用或禁用默认提供的工具，或添加你自己的工具、资源和 Prompt 类。注意某些工具（如数据库读写查询）可能需要你在配置文件中明确启用。
确保你的 Laravel 项目配置正确，特别是 'APP_URL' 环境变量，因为某些工具（如截图）依赖它。

服务器配置

安装并配置好 Croft Laravel 包后，你需要在你的 MCP 客户端（例如 Cursor、VS Code 插件等）中配置连接到这个服务器。MCP 客户端通常需要知道如何启动 MCP 服务器进程。

对于 Croft Laravel，启动命令是通过 Laravel 的 Artisan 控制台完成的。典型的客户端配置会指定：

命令 (command): 'php' (或 './artisan')
参数 (args): 'artisan croft' (或 'croft')
名称 (name): 一个易于识别的名称，例如 'croft' 或 'laravel'。

具体的配置方法请参考你的 MCP 客户端文档。例如，在 Cursor 客户端中，你可能需要在 '.cursor/mcp.json' 文件中添加类似以下的条目：

{
  "mcpServers": {
    "myLaravelCroft": { // 服务器的内部名称
      "command": "./artisan", // 启动命令的可执行文件路径
      "args": ["croft"] // 传递给启动命令的参数
    }
    // ... 其他服务器配置
  }
}

基本使用方法

安装配置完毕后，在支持 MCP 的 AI 开发工具或客户端中连接到你配置好的 Croft 服务器。一旦连接成功，AI 客户端将能够：

列出并理解 Croft 服务器提供的各种工具的功能和输入参数。
根据你提出的任务，自动调用相应的工具（例如，如果你询问关于某个路由的信息，AI 可能会调用“List Routes”工具来查找）。
访问服务器提供的资源，获取项目上下文。
利用 Prompt 模板进行更有效的交互。

现在，你可以开始使用 AI 助手来更便捷地进行本地 Laravel 开发了。

关键词

信息