Rx Module Mcpserver

🚀 MCP Server for Rhymix

MCP Server is a Model Context Protocol (MCP) server module applicable to the Rhymix CMS. It offers a standardized interface for AI clients to access Rhymix's data and functionality. This module is a port of php-mcp/server for use in Rhymix. For MCP tool, prompt, and plugin development, refer to the above repository.

⚠️ Important Note

This module demands advanced knowledge of servers and Rhymix during installation. When altering server settings, you must be fully aware of your actions and proceed accordingly.

🚀 Quick Start

What is Model Context Protocol (MCP)?

MCP is an open - standard protocol designed to enable AI assistants to securely connect to external tools and data sources. This allows AI clients to leverage the capabilities of various applications and services.

Installation Requirements

• PHP 8.2 or higher
• Rhymix 2.1 or higher
• Linux Shell access required

Installation Method

1. Copy the module to the modules/mcpserver directory of Rhymix.
2. Configure settings in Advanced > Installed Modules > MCP Server.

Running MCP Server

This module requires running a server separate from Rhymix. Refer to Module > Configuration Manual to run the script and make necessary reverse proxy configuration changes in server programs like nginx.

✨ Features

• ✨ Standardized MCP Protocol support
• 🔧 Extensible Tool System - Users can develop their own MCP tools
• 🔍 Automatic Directory Scanning - Automatically scans for MCP plugins from separate modules

📦 Installation

Installation Requirements

• PHP 8.2 or higher
• Rhymix 2.1 or higher
• Linux Shell access required

Installation Method

1. Copy the module to the modules/mcpserver directory of Rhymix.
2. Configure settings in Advanced > Installed Modules > MCP Server.

💻 Usage Examples

Developing Custom MCP Tools

Basic Structure

Custom MCP tools are created in the modules/(any module)/mcp/ directory. All MCP tool classes must inherit from \Rhymix\Modules\Mcpserver\Models\MCPServerInterface.

Example: Calculator Tool (ExampleCalculatorElements.php)

<?php

namespace Rhymix\Modules\Mcpserver\Mcp;

use Rhymix\Modules\Mcpserver\Models\MCPServerInterface;
use PhpMcp\Server\Attributes\McpTool;
use PhpMcp\Server\Attributes\Schema;

/**
 * Example MCP tool providing calculator functionality
 */
class ExampleCalculatorElements extends MCPServerInterface
{
    /**
     * Adds two numbers.
     * 
     * @param int $a First number
     * @param int $b Second number  
     * @return int Sum of two numbers
     */
    #[McpTool(name: 'add_numbers')]
    public function add(int $a, int $b): int
    {
        return $a + $b;
    }

    /**
     * Calculates power with validation.
     */
    #[McpTool(name: 'calculate_power')]
    public function power(
        #[Schema(type: 'number', minimum: 0, maximum: 1000)]
        float $base,
        
        #[Schema(type: 'integer', minimum: 0, maximum: 10)]
        int $exponent
    ): float {
        return pow($base, $exponent);
    }
}

Creating New MCP Tool Classes

1. Create File: Create a new PHP file (YourCustomTool.php) in the modules/example/mcp/ directory.
2. Basic Class Structure:

<?php

namespace Rhymix\Modules\Example\Mcp;

use Rhymix\Modules\Mcpserver\Models\MCPServerInterface;
use PhpMcp\Server\Attributes\McpTool;
use PhpMcp\Server\Attributes\Schema;

/**
 * Custom MCP Tool
 */
class YourCustomTool extends MCPServerInterface
{
    /**
     * Example tool method
     */
    #[McpTool(name: 'your_tool_name')]
    public function yourMethod($param1, $param2)
    {
        // Implement business logic here
        return "Result";
    }
}

Rhymix Database Access Example

<?php

namespace Rhymix\Modules\Example\Mcp;

use Rhymix\Modules\Mcpserver\Models\MCPServerInterface;
use PhpMcp\Server\Attributes\McpTool;

class RhymixDatabaseTool extends MCPServerInterface
{
    /**
     * Retrieves member information.
     */
    #[McpTool(name: 'get_member_info')]
    public function getMemberInfo(int $member_srl): array
    {
        // Execute Rhymix database query
        $output = executeQuery('member.getMemberInfoByMemberSrl', ['member_srl' => $member_srl]);
        
        if (!$output->toBool()) {
            throw new \Exception('Cannot get member info: ' . $output->getMessage());
        }
        
        $member = $output->data;
        return [
           'member_srl' => $member->member_srl,
            'user_id' => $member->user_id,
            'nick_name' => $member->nick_name,
            'email_address' => $member->email_address
        ];
    }

    /**
     * Retrieves document list.
     */
    #[McpTool(name: 'get_document_list')]
    public function getDocumentList(int $module_srl, int $page = 1): array
    {
        $args = new \stdClass();
        $args->module_srl = $module_srl;
        $args->page = $page;
        $args->list_count = 10;
        
        $output = executeQueryArray('document.getDocumentList', $args);
        
        if (!$output->toBool()) {
            throw new \Exception('Cannot get document list: ' . $output->getMessage());
        }
        
        return [
            'total_count' => $output->total_count,
            'documents' => $output->data
        ];
    }
}

Schema Validation

In MCP tools, you can set validation for input parameters using the Schema attribute:

#[McpTool(name: 'validated_tool')]
public function validatedMethod(
    #[Schema(type: 'string', minLength: 1, maxLength: 100)]
    string $text,
    
    #[Schema(type: 'integer', minimum: 1, maximum: 999)]
    int $number,
    
    #[Schema(type: 'number', minimum: 0.0, maximum: 100.0)]
    float $percentage
): array {
    return [
        'text' => $text,
        'number' => $number,
        'percentage' => $percentage
    ];
}

📚 Documentation

Configuration Options

Server Settings

Communication Settings

Logging Settings

Debugging

Log Checking

The MCP server outputs detailed logs according to configuration. Through logs, you can check:

• Client connection/disconnection
• Tool calls and responses
• Error and exception information

Connection Testing

Use the "Local Connection Test" function on the admin page to verify that the MCP server is working properly.

Precautions

• Use the MCP server with appropriate firewall settings in security - critical environments.
• It is recommended to disable the DEBUG log level in production environments.
• Perform appropriate permission checks when working with databases in custom tools.

📄 License

This module is distributed under the GPL v2 license.

Developer

• Waterticket (waterticket@potatosoft.kr)
• Website: https://potatosoft.kr
• Module Generator: https://www.poesis.dev/

Technical Support

If you encounter problems or need help:

1. Ask questions in the Rhymix Official Community
2. Register GitHub issues (if applicable)