Sillytavern MCP Extension

🚀 簡單酒館 MCP 擴展

此擴展為 SillyTavern 增添了基於 WebSocket 的工具執行支持，藉助統一接口實現外部工具的註冊與運行，極大提升了系統的擴展性與靈活性。

🚀 快速開始

本擴展為 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 設置，可配置以下選項：

使用說明

工具註冊

通過發送以下 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. 檢查 GitHub Issues 以查看已知問題。
2. 若未發現相關問題，請創建新 Issue。
3. 加入 SillyTavern Discord 社區尋求幫助。

📄 許可證

本項目採用 MIT 許可證，具體條款詳見 LICENSE 文件。