Croft

🚀 Croft MCP Server for Local Laravel Development

This project provides Artisan commands to enhance the performance of your AI code assistants, such as ChatGPT, when used in conjunction with Laravel.

It is specifically optimized for local development environments. You can add more features through the hosting service provided by croft.fyi.

🚀 Quick Start

Artisan commands offer tools to enhance the performance of your AI code assistants, like ChatGPT, when used with Laravel. This project is optimized for local development. You can add more features via the hosting service at croft.fyi.

✨ Features

• Screenshot URL links
• Get the current date and time
• View the latest X log records
• View and filter database structures - tables, fields, indexes, foreign keys
• List and filter routes
• List Artisan commands
• List available config() keys (dot notation)
• List available env() keys (without revealing any secrets)

📦 Installation

Install the package via Composer:

composer require ashleyhindle/croft --dev

Publish the configuration file:

php artisan vendor:publish --tag="croft-config"

Add more features through the hosting service provided by croft.fyi.

💻 Usage Examples

Basic Usage

To use Croft, you need to add it as an MCP server to your preferred tool. The command that the MCP client needs to run is ./artisan croft.

Cursor (Documentation) We recommend creating a .cursor/mcp.json file in the project root directory:

{
  "mcpServers": {
    "croft": {
      "command": "./artisan",
      "args": ["croft"]
    }
  }
}

Advanced Usage

To add your own tools, simply create a new class that extends the Croft\Feature\Tool\AbstractTool class and ensure it is registered in your croft.php configuration file.

<?php

declare(strict_types=1);

namespace Croft\Tools;

use Croft\Feature\Tool\AbstractTool;
use Croft\Feature\Tool\ToolResponse;

class {{CLASSNAME}} extends AbstractTool
{
    public function __construct()
    {
        // Set annotations according to the MCP specification
        $this->setTitle('{{NAME}}')
            ->setReadOnly(true)        // Only list commands without making any modifications
            ->setDestructive(false)    // Do not perform destructive operations
            ->setIdempotent(true);     // Safe to retry
    }

    public function getName(): string
    {
        return '{{NAME}}';
    }

    public function getDescription(): string
    {
        return 'You must provide a detailed description of the tool\'s functionality so that the MCP client can decide when to use it.';
    }

    /**
    * What parameters does the MCP client need to provide to use this tool?
    **/
    public function getInputSchema(): array
    {
        return [
            'type' => 'object',
            'properties' => (object) [
            ],
            'required' => [],
        ];
    }

    public function handle(array $arguments): ToolResponse
    {
        return ToolResponse::text("Hello, this is the start of something great.");
    }
}

After adding a tool, you need to restart the server or have the MCP client re - list the available tools.

📄 License

This project is developed by Ashley Hindle. If you like it, please give it a thumbs up, share it, and let me know!

• Blue sky
• Twitter
• Website https://ashleyhindle.com