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/