Php MCP Server

🚀 PHP MCP 服務器框架

這是一個基於 PHP 的 MCP（Minecraft 命令平臺）服務器框架，支持通過標註定義服務。該框架提供了命令處理、腳本執行和 RESTful API 接口等多種功能模塊，能有效提升開發效率與服務質量。

🚀 快速開始

你可以參考以下快速開始示例，快速上手本框架：

創建一個 MCP 命令

<?php

namespace App\Commands;

use Mcp\Annotations\Command;

/**
 * @Command(
 *     name="hello",
 *     description="輸出問候信息"
 * )
 */
class HelloCommand {
    public function execute() {
        echo "Hello, World!";
        return true;
    }
}

創建一個 MCP 腳本

<?php

namespace App\Scripts;

use Mcp\Annotations\Script;

/**
 * @Script(
 *     name="歡迎信息",
 *     description="輸出歡迎消息",
 *     schedule="0 * * * *"
 * )
 */
class WelcomeMessage {
    public function run() {
        echo "歡迎使用 MCP 框架！";
    }
}

✨ 主要特性

• 模塊化設計：各個功能模塊獨立，便於維護和擴展。
• 自動文檔生成：所有標註過的接口自動生成 API 文檔。
• 高可用性：支持集群部署和負載均衡。

📦 安裝指南

安裝依賴

使用 Composer 安裝所需的依賴包：

composer install

運行服務器

執行以下命令啟動 MCP 服務器：

php server.php

或者在 Docker 環境中運行：

docker-compose up --build

💻 使用示例

基礎用法

定義 MCP 命令

<?php

namespace App\Commands;

use Mcp\Annotations\Command;

/**
 * @Command(
 *     name="ping",
 *     description="測試網絡延遲",
 *     permission="server.command.ping",
 *     aliases={"latency"}
 * )
 */
class PingCommand {
    public function execute() {
        // 實現 ping 功能
    }
}

定義 MCP 腳本

<?php

namespace App\Scripts;

use Mcp\Annotations\Script;

/**
 * @Script(
 *     name="每日任務",
 *     description="執行每日例行任務",
 *     schedule="0 0 * * *"
 * )
 */
class DailyTask {
    public function run() {
        // 實現每日任務邏輯
    }
}

定義 MCP 控制檯命令

<?php

namespace App\Commands\Console;

use Mcp\Annotations\ConsoleCommand;

/**
 * @ConsoleCommand(
 *     name="server.start",
 *     description="啟動遊戲服務器"
 * )
 */
class StartServer {
    public function execute() {
        // 實現服務器啟動邏輯
    }
}

高級用法

返回類型說明

• 命令處理模塊：
  • 普通命令：返回布爾值，true 表示成功。
  • 函數命令：返回自定義數據結構或基礎類型。
• 腳本執行模塊：
  • 定時任務：無返回值，默認視為成功。
  • 一次性任務：返回布爾值，true 表示成功完成。

📚 詳細文檔

核心功能模塊

命令處理

• 支持的命令類型：普通命令、函數命令、腳本命令和控制檯命令。
• 自動生成文檔：所有標註過的命令會自動生成 API 文檔。

腳本執行

• 腳本語言：支持 PHP 和 Lua 腳本。
• 任務調度：支持定時任務和一次性任務的調度。

RESTful API 接口

• 功能特性：
  • 命令管理：創建、查詢、修改和刪除命令。
  • 執行日誌：查看執行記錄，包括結果和錯誤信息。
  • 賬戶權限：用戶身份驗證與權限管理。

項目結構

src/
├── Commands/       # MCP 命令類
├── Scripts/       # MCP 腳本類
└── Controllers/   # RESTful API 控制器

配置文件

環境變量配置

# 服務器配置
MCP_SERVER_NAME=你的服務名
MCP_SERVER_VERSION=1.0.0

# 數據庫配置
DB_HOST=數據庫地址
DB_PORT=數據庫端口
DB_NAME=數據庫名
DB_USER=用戶名
DB_PASS=密碼

🔧 技術細節

本框架基於 PHP 開發，利用了 PHP 的註解功能來定義服務，通過 Composer 管理依賴。在命令處理方面，支持多種命令類型，並能自動生成 API 文檔；腳本執行模塊支持 PHP 和 Lua 腳本，還能進行任務調度；RESTful API 接口提供了命令管理、執行日誌查看和賬戶權限管理等功能。框架採用模塊化設計，各個功能模塊相互獨立，便於維護和擴展，同時支持集群部署和負載均衡，具有較高的可用性。

📄 許可證

本項目使用 MIT 許可證，具體內容如下：

The MIT License (MIT)

聯繫方式

• 作者：[你的名字]
• 郵箱：[你的郵箱]
• GitHub：[你的 GitHub 鏈接]

貢獻指南

歡迎 fork 和提交 Pull Request！ 更多信息請訪問 GitHub 倉庫。