Croft

🚀 專用於本地 Laravel 開發的 Croft MCP 服務器

本項目提供了一系列 Artisan 命令，可增強 AI 代碼助手（如 ChatGPT）與 Laravel 結合使用時的表現。它專為本地開發環境優化，還能通過 croft.fyi 提供的主機服務添加更多功能。

🚀 快速開始

要使用 Croft MCP 服務器，您需要完成安裝和配置步驟，然後將其添加到您的首選工具中。

📦 安裝指南

安裝包

通過 Composer 安裝包：

composer require ashleyhindle/croft --dev

發佈配置文件

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

添加更多功能

通過 croft.fyi 提供的主機服務添加更多功能。

💻 使用示例

基礎用法

要使用 Croft，您需要將其作為 MCP 服務器添加到您的首選工具中。MCP 客戶端需要運行的命令是 ./artisan croft。

以 Cursor 為例（文檔），我們建議在項目根目錄下創建一個 .cursor/mcp.json 文件：

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

✨ 主要特性

• 截圖 URL 鏈接：提供截圖的 URL 鏈接功能。
• 獲取當前日期和時間：可獲取當前的日期和時間。
• 查看最近的 X 條日誌記錄：方便查看最近的日誌信息。
• 查看並過濾數據庫結構：支持查看和過濾數據庫的表、字段、索引、外鍵等結構。
• 列出並篩選路由：能夠列出和篩選項目中的路由。
• 列出 artisan 命令：可查看所有可用的 artisan 命令。
• 列出可用的 config() 鍵（點表示法）：以點表示法列出可用的 config() 鍵。
• 列出可用的 env() 鍵：列出可用的 env() 鍵，且不會洩露任何秘密。

🔧 額外功能

通過 croft.fyi 提供的主機服務添加更多功能。

🔧 添加自定義工具

要添加自己的工具，只需創建一個擴展 Croft\Feature\Tool\AbstractTool 類的新類，並確保它在您的 croft.php 配置文件中註冊即可。

示例代碼

<?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()
    {
        // 根據 MCP 規範設置註解
        $this->setTitle('{{NAME}}')
            ->setReadOnly(true)        // 只列出命令，不做任何修改
            ->setDestructive(false)    // 不執行破壞性操作
            ->setIdempotent(true);     // 安全重試
    }

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

    public function getDescription(): string
    {
        return '必須詳細說明該工具的功能，以便 MCP 客戶端決定何時使用它。';
    }

    /**
    * MCP 客戶端需要提供哪些參數才能使用此工具？
    **/
    public function getInputSchema(): array
    {
        return [
            'type' => 'object',
            'properties' => (object) [
            ],
            'required' => [],
        ];
    }

    public function handle(array $arguments): ToolResponse
    {
        return ToolResponse::text("你好，這是開始的偉大事物。");
    }
}

注意事項

添加工具後，您需要重新啟動服務器，或讓 MCP 客戶端重新列出可用工具。

📄 支持與致謝

此項目由 Ashley Hindle 開發。如果您喜歡它，請點贊、分享，並告訴我！

• 藍 sky
• Twitter
• 網站 https://ashleyhindle.com