Php MCP Server

🚀 PHP MCP Server Framework

This is a PHP-based MCP (Minecraft Command Platform) server framework that supports defining services through annotations. It offers various functional modules, including command processing, script execution, and RESTful API interfaces.

🚀 Quick Start

This is a PHP-based MCP (Minecraft Command Platform) server framework. It allows you to define services through annotations and provides multiple functional modules such as command processing, script execution, and RESTful API interfaces.

✨ Features

Command Processing

• Supported Command Types: Regular commands, function commands, script commands, and console commands.
• Automatic Documentation Generation: API documentation is automatically generated for all annotated commands.

Script Execution

• Script Languages: Supports PHP and Lua scripts.
• Task Scheduling: Supports scheduling of scheduled tasks and one-time tasks.

RESTful API Interface

• Functional Features:
  • Command Management: Create, query, modify, and delete commands.
  • Execution Log: View execution records, including results and error information.
  • Account Permissions: User authentication and permission management.

📦 Installation

1. Install Dependencies: Use Composer to install the required dependency packages:

   composer install
   

2. Run the Server: Execute the following command to start the MCP server:

   php server.php
   

   Or run it in a Docker environment:

   docker-compose up --build
   

💻 Usage Examples

Create an MCP Command

<?php

namespace App\Commands;

use Mcp\Annotations\Command;

/**
 * @Command(
 *     name="hello",
 *     description="Output a greeting message"
 * )
 */
class HelloCommand {
    public function execute() {
        echo "Hello, World!";
        return true;
    }
}

Create an MCP Script

<?php

namespace App\Scripts;

use Mcp\Annotations\Script;

/**
 * @Script(
 *     name="Welcome Message",
 *     description="Output a welcome message",
 *     schedule="0 * * * *"
 * )
 */
class WelcomeMessage {
    public function run() {
        echo "Welcome to the MCP framework!";
    }
}

📚 Documentation

Annotation Usage Instructions

1. Define an MCP Command

<?php

namespace App\Commands;

use Mcp\Annotations\Command;

/**
 * @Command(
 *     name="ping",
 *     description="Test network latency",
 *     permission="server.command.ping",
 *     aliases={"latency"}
 * )
 */
class PingCommand {
    public function execute() {
        // Implement the ping function
    }
}

2. Define an MCP Script

<?php

namespace App\Scripts;

use Mcp\Annotations\Script;

/**
 * @Script(
 *     name="Daily Task",
 *     description="Execute daily routine tasks",
 *     schedule="0 0 * * *"
 * )
 */
class DailyTask {
    public function run() {
        // Implement the daily task logic
    }
}

3. Define an MCP Console Command

<?php

namespace App\Commands\Console;

use Mcp\Annotations\ConsoleCommand;

/**
 * @ConsoleCommand(
 *     name="server.start",
 *     description="Start the game server"
 * )
 */
class StartServer {
    public function execute() {
        // Implement the server startup logic
    }
}

Return Type Instructions

Command Processing Module

• Regular Commands: Return a boolean value, with true indicating success.
• Function Commands: Return a custom data structure or basic type.

Script Execution Module

• Scheduled Tasks: No return value, considered successful by default.
• One-time Tasks: Return a boolean value, with true indicating successful completion.

🔧 Technical Details

Project Structure

src/
├── Commands/       # MCP command classes
├── Scripts/       # MCP script classes
└── Controllers/   # RESTful API controllers

Configuration File

Environment Variable Configuration

# Server Configuration
MCP_SERVER_NAME=Your service name
MCP_SERVER_VERSION=1.0.0

# Database Configuration
DB_HOST=Database address
DB_PORT=Database port
DB_NAME=Database name
DB_USER=Username
DB_PASS=Password

Project Advantages

• Modular Design: Each functional module is independent, facilitating maintenance and expansion.
• Automatic Documentation Generation: API documentation is automatically generated for all annotated interfaces.
• High Availability: Supports cluster deployment and load balancing.

Contribution Guidelines

Welcome to fork and submit Pull Requests! For more information, please visit GitHub Repository.

📄 License

This project uses the MIT License, with the specific content as follows:

The MIT License (MIT)

Contact Information

• Author: [Your Name]
• Email: [Your Email]
• GitHub: [Your GitHub Link]