🚀 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 仓库。