关于 Laravel Codebase Introspection and Analysis
Laravel Codebase Introspection and Analysis 是一个 MCP 服务,基于 mateffy/laravel-introspect 包,让 AI 无需逐个读取文件即可查询 Laravel 项目的视图、路由、类和模型。适合使用 AI 工具开发大型 Laravel 应用的开发者。
主要功能
- 01查询视图、路由、类和模型的结构化信息
- 02支持通配符匹配多个对象
- 03按继承、接口、trait 等条件过滤类
- 04概览模型及其关系、属性和类型转换
- 05支持查询 Laravel 扩展包中的内容
适用场景
- 01查找使用特定控制器的所有路由
- 02重构视图前确认其未被其他位置引用
- 03查找使用某个 trait 或接口的模型
- 04检查路由是否使用了正确的中间件
MCP 相关
该项目以 MCP 服务形式运行,向 Aider、Cursor、Claude Code 等支持 MCP 的 AI Agent 暴露 Laravel 代码库的查询能力。
配置
本地服务的配置在各客户端中通用,复制后粘贴到客户端的 MCP 配置文件即可。
我们还没有获取到这个服务的安装包或远程地址,请按项目 README 中的说明安装。
工具
本地服务需要在你的电脑上运行后才能读取工具,维护者暂未提供工具列表。
详细介绍
用于 Laravel 代码库智能分析与内省的 MCP 服务
AI 要理解你的代码库,就需要了解其中包含的内容。 虽然向量搜索是搜索代码的强大工具,但它会消耗大量令牌,而且对于视图或路由等内容,也无法呈现代码库的完整情况。 此软件包为 mateffy/laravel-introspect 软件包实现了一个 Model Context Protocol(MCP)服务,可用于内省代码库并获取其结构化信息。
- 🔍 让 AI 查询视图、路由、类和模型,无需通读所有代码
- 🔍 还可以使用通配符(
*)匹配多个视图、路由、类和模型 - 🔍 支持查询 Laravel 软件包中的内容,这是大多数文件搜索工具无法做到的
- 🪄 快速展示数据模型及其关系概况
- 🤖 支持任何实现了 MCP 协议 的 AI Agent
| 查询 | 可用筛选条件 |
|---|---|
| 视图 | 名称、路径、被哪个视图使用、使用哪个视图、继承 |
| 路由 | 名称、URI、控制器 + 函数、方法、中间件 |
| 类 | 名称 / 命名空间、继承的父类、实现的接口、使用的 trait |
| ⤷ 模型 | ... 关系、属性、类型转换、可填充、隐藏、可读 / 写 |
| ⤷ 命令 | ... 签名、描述(即将推出) |
名称和其他一些查询也支持通配符查询(例如:
components.*.paragraph)
适用人群
如果你使用 Aider、Cursor、Windsurf 或 Claude Code 等 AI 工具来协助构建应用,那么此软件包就是为你准备的。 只需在 Agent 中配置 MCP 服务,它就能自动查询代码库中的视图、路由、类和模型。
这对于大型代码库尤其有用,因为在其中搜索代码不太实际。
示例任务
- 向 AI 展示数据模型及其关系概况
- 重构视图,并确保它没有在其他地方使用
- 查找所有使用特定控制器的路由
- 查找使用特定 trait 或接口的模型
- 确保所有路由都使用正确的中间件
laravel-codebase-mcp 与 laravel-introspect 的区别
MCP 服务使用 laravel-introspect 软件包来内省代码库并获取其结构化信息。
如果你想编写测试或多次运行相同的查询,也可以直接使用此软件包。
## 安装
通过 composer 安装此软件包:
composer require mateffy/laravel-codebase-mcp --dev
说明
目前,
php-mcp/server(#23)和 ReactPHP(#542)存在依赖问题。如果安装laravel-codebase-mcp时遇到问题,可能需要暂时使用这些修补过的 fork,并将以下内容添加到composer.json:{ "repositories": [ { "type": "vcs", "url": "https://github.com/leantime/php-mcp-server.git" }, { "type": "vcs", "url": "https://github.com/Leantime/reactphp-http.git" } ] }
然后将其添加到 AI Agent 的 MCP 配置中:
{
"mcpServers": {
"laravel-introspect": {
"command": "php",
"args": [
"/path/to/your/codebase/artisan",
"introspect:mcp"
]
}
}
}
重要
此 MCP 服务仍处于 Beta 阶段,很可能会有 Bug!
可用查询
如需查看所有可用查询,请查阅 laravel-introspect package documentation。
致谢
此 MCP 服务使用 php-mcp/server 软件包实现 MCP 协议。
许可证
MIT 许可证(MIT)。更多信息请参阅 许可证文件。
评论
一个开放协议,规定了 AI 应用如何以统一方式连接外部工具与数据源。客户端负责与模型对话,MCP 服务负责提供工具、资源和提示模板,两者通过标准消息通信,同一个服务可以被不同客户端复用。