Sillytavern MCP Extension

🚀 簡易酒場 MCP 拡張

この拡張機能は、SillyTavernにWebSocketベースのツール実行サポートを追加し、統一インターフェースを介して外部ツールの登録と実行を可能にします。

✨ 主な機能

• WebSocketサーバーによるリアルタイム通信
• ツールの登録と実行システム
• JSON Schemaによるツール定義の検証
• 実行状態のリアルタイム更新
• ログ記録とWebSocket設定の構成可能化
• SillyTavernのWeb基本設定画面への統合

📦 インストール

方法一：Web インターフェースによるインストール（推奨）

INSTRUCTIONS.md を参照して、SillyTavernのWebインターフェースからインストールしてください。

方法二：手動インストール

1. リポジトリをローカルにクローンします：

git clone https://github.com/CG-Labs/SillyTavern-MCP-Extension.git

2. プロジェクトディレクトリに移動し、依存関係をインストールします：

cd SillyTavern-MCP-Extension
npm install

📚 ドキュメント

設定情報

SillyTavernのUI設定を通じて、以下のオプションを構成できます：

• WebSocketポート：デフォルトは 3000
• ログレベル：debug、info、warn、error の4つのレベルをサポート

使用説明

基本的な使用法

ツールの登録

以下のJSON形式のメッセージをWebSocketサーバーに送信します：

{
    "type": "register_tool",
    "data": {
        "name": "tool_name",
        "schema": {
            // ツールパラメータを定義するJSON Schema
        }
    }
}

ツールの実行

以下の形式のメッセージを送信してツールを実行します：

{
    "type": "execute_tool",
    "data": {
        "executionId": "unique_id",
        "toolName": "tool_name",
        "args": {
            // 実行パラメータ
        }
    }
}

実行状態の更新

以下の形式のメッセージを受信して実行状態を取得します：

{
    "type": "tool_execution_status",
    "data": {
        "executionId": "unique_id",
        "status": "running|success|failed",
        "message": "状態情報"
    }
}

エラーコード

• ERROR_100: ツールが登録されていません
• ERROR_101: パラメータが無効です
• ERROR_102: 実行がタイムアウトしました
• ERROR_103: 内部サーバーエラー

プロジェクト構造

SillyTavern-MCP-Extension/
├── index.js          # メインプラグインのエントリーポイント
├── config.js        # 設定管理
├── tools/           # ツールの登録と管理
│   └── tool1.js    # サンプルツールの実装
└── package.json     # プロジェクトの依存関係管理

開発ガイド

高度な使用法

新しいツールを tools/ ディレクトリに追加し、その動作を定義します：

// example_tool.js
module.exports = {
    name: 'example_tool',
    schema: {
        type: 'object',
        properties: {
            input: { type: 'string' }
        },
        required: ['input']
    },
    execute: function(args) {
        // 実行ロジック
        return result;
    }
};

貢献ガイド

1. リポジトリを個人アカウントにForkします
2. 機能ブランチを作成します
3. コードの変更をコミットします
4. ブランチにプッシュします
5. Pull Requestを提出します

サポート情報

問題や質問がある場合は：

1. GitHub Issues を確認して既知の問題を確認します
2. 関連する問題が見つからない場合は、新しいIssueを作成します
3. SillyTavern Discordコミュニティに参加して支援を求めます

📄 ライセンス

このプロジェクトはMITライセンスの下で提供されています。詳細な条項はLICENSEファイルを参照してください。