article
README
🚀 Laravel 工具 MCP
一组专为与 Cursor IDE 集成设计的 Laravel 辅助工具,能直接在编辑器中提升开发工作流和调试能力,让开发更高效。
🚀 快速开始
此包目前处于 alpha 阶段,API 和功能可能会发生变化,恕不另行通知。在生产环境中使用此包请自行承担风险。
✨ 主要特性
- 此包专为增强你在 Cursor IDE 中的 Laravel 开发体验而构建。所有工具均可直接通过 Cursor 的命令 palette 访问,并与你的开发流程无缝集成。
- 提供了一系列实用工具,如查看日志、搜索错误、执行 Artisan 命令、显示模型信息等。
📦 安装指南
- 克隆仓库:
git clone https://github.com/your-username/laravel-mcp.git
cd laravel-mcp
- 创建 shell 脚本包装器(例如
~/bin/run-laravel-mcp):
#!/bin/bash
# 指向你的 Laravel 项目路径
export LARAVEL_PATH=/path/to/your/laravel/project
# 运行 MCP 服务器
mcp run /path/to/laravel-helpers-mcp/server.py
- 赋予脚本执行权限:
chmod +x ~/bin/run-laravel-mcp
- 确保
~/bin在你的 PATH 中:
echo 'export PATH="$HOME/bin:$PATH"' >> ~/.zshrc # 或 ~/.bashrc
source ~/.zshrc # 或 source ~/.bashrc
💻 使用示例
基础用法
此包提供了多个实用工具,以下是各工具的使用说明:
tail_log_file:在 Cursor 中查看 Laravel 日志文件中的最新条目。search_log_errors:搜索特定错误模式,结果直接在编辑器中显示。run_artisan_command:直接从 Cursor 执行 Laravel Artisan 命令。show_model:显示模型信息和关系,在你的编辑器中展示。
📚 详细文档
兼容性要求
- PHP 8.1+
- Laravel 10.0+
- Cursor IDE
- UV - 现代 Python 包装工具
贡献指南
此项目正在积极开发中。欢迎提出问题和拉取请求。
📄 许可证
[许可类型] - 详细信息请参见 LICENSE 文件
Scan to join WeChat group