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 文件。