Rx Module Mcpserver

🚀 Rhymix的MCP服务器

MCP Server是一个可应用于Rhymix CMS的模型上下文协议（Model Context Protocol，MCP）服务器模块。该模块为AI客户端访问Rhymix的数据和功能提供了标准化接口。

🇰🇷 韩语 | 🇺🇸 英语

🚀 快速开始

概述

MCP Server是一个能应用于Rhymix CMS的模型上下文协议（MCP）服务器模块。它为AI客户端访问Rhymix的数据和功能提供了标准化接口。此模块是将 php-mcp/server 移植到Rhymix中使用的程序。若要进行MCP工具、提示词和插件开发，可参考上述仓库。

⚠️ 重要提示

此模块在安装过程中需要具备服务器和Rhymix的高级知识。在更改服务器设置时，必须清楚自己的操作并谨慎进行。

什么是模型上下文协议（MCP）？

MCP是一种开放标准协议，旨在允许AI助手安全地连接到外部工具和数据源。这使得AI客户端能够利用各种应用程序和服务的功能。

安装要求

• PHP 8.2或更高版本
• Rhymix 2.1或更高版本
• 需要有Linux Shell访问权限

安装方法

1. 将模块复制到Rhymix的 modules/mcpserver 目录。
2. 在 高级 > 已安装模块 > MCP Server 中配置设置。

运行MCP服务器

此模块需要在Rhymix之外单独运行一个服务器。请参考 模块 > 配置手册 来运行脚本，并在nginx等服务器程序中进行必要的反向代理配置更改。

调试

日志检查

MCP服务器会根据配置输出详细日志。通过日志，你可以检查以下信息：

• 客户端连接/断开连接情况
• 工具调用和响应情况
• 错误和异常信息

连接测试

使用管理页面上的“本地连接测试”功能来验证MCP服务器是否正常工作。

注意事项

• 在安全要求较高的环境中，请使用适当的防火墙设置来使用MCP服务器。
• 建议在生产环境中禁用DEBUG日志级别。
• 在自定义工具中处理数据库时，请进行适当的权限检查。

技术支持

如果你遇到问题或需要帮助：

1. 在 Rhymix官方社区 提问。
2. （若适用）在GitHub上提交问题。

✨ 主要特性

• ✨ 支持标准化的MCP协议
• 🔧 可扩展的工具系统 - 用户可以开发自己的MCP工具
• 🔍 自动目录扫描 - 自动从单独的模块中扫描MCP插件

📦 安装指南

安装要求

• PHP 8.2或更高版本
• Rhymix 2.1或更高版本
• 需要有Linux Shell访问权限

安装方法

1. 将模块复制到Rhymix的 modules/mcpserver 目录。
2. 在 高级 > 已安装模块 > MCP Server 中配置设置。

配置选项

服务器设置

通信设置

日志记录设置

💻 使用示例

基础用法

以下是一个计算器工具的示例（ExampleCalculatorElements.php）：

<?php

namespace Rhymix\Modules\Mcpserver\Mcp;

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

/**
 * 提供计算器功能的示例MCP工具
 */
class ExampleCalculatorElements extends MCPServerInterface
{
    /**
     * 两数相加。
     * 
     * @param int $a 第一个数字
     * @param int $b 第二个数字  
     * @return int 两数之和
     */
    #[McpTool(name: 'add_numbers')]
    public function add(int $a, int $b): int
    {
        return $a + $b;
    }

    /**
     * 计算幂并进行验证。
     */
    #[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);
    }
}

高级用法

创建新的MCP工具类

1. 创建文件：在 modules/example/mcp/ 目录中创建一个新的PHP文件（YourCustomTool.php）。
2. 基本类结构：

<?php

namespace Rhymix\Modules\Example\Mcp;

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

/**
 * 自定义MCP工具
 */
class YourCustomTool extends MCPServerInterface
{
    /**
     * 示例工具方法
     */
    #[McpTool(name: 'your_tool_name')]
    public function yourMethod($param1, $param2)
    {
        // 在此实现业务逻辑
        return "结果";
    }
}

Rhymix数据库访问示例

<?php

namespace Rhymix\Modules\Example\Mcp;

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

class RhymixDatabaseTool extends MCPServerInterface
{
    /**
     * 获取会员信息。
     */
    #[McpTool(name: 'get_member_info')]
    public function getMemberInfo(int $member_srl): array
    {
        // 执行Rhymix数据库查询
        $output = executeQuery('member.getMemberInfoByMemberSrl', ['member_srl' => $member_srl]);
        
        if (!$output->toBool()) {
            throw new \Exception('无法获取会员信息: ' . $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
        ];
    }

    /**
     * 获取文档列表。
     */
    #[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('无法获取文档列表: ' . $output->getMessage());
        }
        
        return [
            'total_count' => $output->total_count,
            'documents' => $output->data
        ];
    }
}

模式验证

在MCP工具中，你可以使用 Schema 属性为输入参数设置验证：

#[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
    ];
}

更多信息，请参考 php-mcp/server。

📄 许可证

此模块在GPL v2许可证下分发。

🔧 技术细节

本模块是将 php-mcp/server 移植到Rhymix中使用的程序。它为AI客户端访问Rhymix的数据和功能提供了标准化接口，支持标准化的MCP协议，具备可扩展的工具系统和自动目录扫描功能。在安装和使用过程中，需要注意服务器和Rhymix的相关设置，以及数据库操作的权限检查等。

开发者

• Waterticket (waterticket@potatosoft.kr)
• 网站: https://potatosoft.kr
• 模块生成器: https://www.poesis.dev/