Installation

基本能力

产品定位

Croft 是一个专为本地 Laravel 开发设计的 MCP 服务器，旨在提供一系列工具来帮助 AI 结对程序员更高效地工作。

核心功能

• 截图 URL
• 读取最后 X 条日志条目
• 读取和过滤数据库结构（表、列、索引、外键）
• 列出/过滤路由
• 列出 artisan 命令
• 列出可用的 config() 键（点表示法）
• 列出可用的 env() 键（不泄露敏感信息）

适用场景

• 本地 Laravel 开发
• AI 结对编程辅助
• 数据库和路由管理
• 配置和环境变量管理

工具列表

1. Screenshot URLs：截图 URL 功能。
2. Read last X log entries：读取最后 X 条日志条目。
3. Read & filter database structure：读取和过滤数据库结构。
4. List/filter routes：列出/过滤路由。
5. List artisan commands：列出 artisan 命令。
6. List available config() keys：列出可用的 config() 键。
7. List available env() keys：列出可用的 env() 键。

常见问题解答

• 如何添加自定义工具？：创建一个继承 Croft\Feature\Tool\AbstractTool 的类，并在 croft.php 配置文件中注册。
• 如何重启服务器或重新列出工具？：重启服务器或让 MCP 客户端重新列出工具。

使用教程

使用依赖

• 需要安装 Composer 和 Laravel 环境。

安装教程

1. 通过 Composer 安装包： bash composer require ashleyhindle/croft --dev
2. 发布配置文件： bash php artisan vendor:publish --tag="croft-config"

调试方式

1. 在 MCP 客户端中添加 Croft 作为服务器，运行命令： bash ./artisan croft
2. 推荐在项目中添加 .cursor/mcp.json 文件： json { "mcpServers": { "croft": { "command": "./artisan", "args": ["croft"] } } }

许可证

该项目遵循 MIT 开源许可条款，请参阅 MIT 了解完整条款。