Rx Module Mcpserver

🚀 Rhymix用MCPサーバー

MCP Serverは、Rhymix CMSに適用できるModel Context Protocol (MCP)サーバーモジュールです。このモジュールは、AIクライアントがRhymixのデータと機能にアクセスするための標準化されたインターフェースを提供します。

🇰🇷 한국어 | 🇺🇸 英語

🚀 クイックスタート

MCP Serverは、Rhymix CMSに適用可能なModel Context Protocol (MCP)サーバーモジュールです。このモジュールを使用することで、AIクライアントはRhymixのデータと機能にアクセスするための標準化されたインターフェースを利用できます。

インストールに必要な条件

• PHP 8.2以上
• Rhymix 2.1以上
• Linux Shellへのアクセスが必要

インストール方法

1. モジュールをRhymixのmodules/mcpserverディレクトリにコピーします。
2. 高度な設定 > インストール済みモジュール > MCP Serverで設定を構成します。

MCPサーバーの実行

このモジュールは、Rhymixとは別にサーバーを実行する必要があります。モジュール > 設定マニュアルを参照してスクリプトを実行し、nginxなどのサーバープログラムで必要なリバースプロキシ設定を変更します。

⚠️ 重要提示

このモジュールのインストールプロセスでは、サーバーとRhymixに関する高度な知識が必要です。サーバー設定を変更する際には、自分が行っていることを理解し、適切に進める必要があります。

✨ 主な機能

• ✨ 標準化されたMCPプロトコルのサポート
• 🔧 拡張可能なツールシステム - ユーザーが独自のMCPツールを開発できます
• 🔍 自動ディレクトリスキャン - 別のモジュールからMCPプラグインを自動的にスキャンします

📦 インストール

インストールに必要な条件

インストール方法

1. モジュールをRhymixのmodules/mcpserverディレクトリにコピーします。
2. 高度な設定 > インストール済みモジュール > MCP Serverで設定を構成します。

設定オプション

サーバー設定

通信設定

ロギング設定

💻 使用例

基本的な使用法

<?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
{
    /**
     * 2つの数値を加算します。
     * 
     * @param int $a 最初の数値
     * @param int $b 2番目の数値  
     * @return int 2つの数値の合計
     */
    #[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
    ];
}

🔧 技術詳細

Model Context Protocol (MCP)とは？

MCPは、AIアシスタントが外部ツールやデータソースに安全に接続できるように設計されたオープンな標準プロトコルです。これにより、AIクライアントはさまざまなアプリケーションやサービスの機能を活用できます。

📄 ライセンス

このモジュールは、GPL v2ライセンスの下で配布されています。

開発者

• Waterticket (waterticket@potatosoft.kr)
• ウェブサイト: https://potatosoft.kr
• モジュールジェネレーター: https://www.poesis.dev/

技術サポート

問題が発生した場合や支援が必要な場合は、以下の方法で問い合わせてください。

1. Rhymix公式コミュニティで質問する
2. 該当する場合は、GitHubのイシューを登録する

デバッグ

ログの確認

MCPサーバーは設定に応じて詳細なログを出力します。ログを通じて、以下の情報を確認できます。

• クライアントの接続/切断
• ツールの呼び出しと応答
• エラーや例外の情報

接続テスト

管理ページの「ローカル接続テスト」機能を使用して、MCPサーバーが正常に動作していることを確認できます。

注意事項

• セキュリティが重要な環境では、適切なファイアウォール設定とともにMCPサーバーを使用してください。
• 本番環境では、DEBUGログレベルを無効にすることをお勧めします。
• カスタムツールでデータベース操作を行う場合は、適切な権限チェックを実行してください。