MCP Extension for SillyTavern

此扩展为SillyTavern增加了基于WebSocket的工具执行支持，允许通过标准化接口注册和执行外部工具。

功能

• 实时通信的WebSocket服务器
• 工具注册和执行系统
• 工具定义的JSON Schema验证
• 实时执行状态更新
• 可配置的日志记录和WebSocket设置
• 集成到SillyTavern中的Web设置界面

安装

方法1：Web界面（推荐）

请参阅INSTRUCTIONS.md，了解通过SillyTavern的Web界面进行安装的分步说明。

方法2：手动安装

1. 将此仓库克隆到你的SillyTavern插件目录中：

   cd /path/to/SillyTavern/plugins
   git clone https://github.com/CG-Labs/SillyTavern-MCP-Extension.git mcp-extension
   

2. 安装依赖项：

   cd mcp-extension
   npm install
   

3. 重启SillyTavern

配置

该扩展可以通过SillyTavern UI下的“设置”>“扩展”>“MCP扩展”进行配置。

可用设置

• WebSocket端口：WebSocket服务器的端口号（默认：5005）
• 日志级别：日志详细程度（调试、信息、警告、错误）

使用

注册一个工具

要注册一个工具，请发送具有以下格式的WebSocket消息：

{
    "type": "register_tool",
    "data": {
        "name": "example_tool",
        "schema": {
            "type": "object",
            "properties": {
                "param1": {
                    "type": "string",
                    "description": "第一个参数"
                },
                "param2": {
                    "type": "number",
                    "description": "第二个参数"
                }
            },
            "required": ["param1"]
        }
    }
}

执行一个工具

要执行已注册的工具，请发送具有以下格式的WebSocket消息：

{
    "type": "execute_tool",
    "data": {
        "executionId": "unique_execution_id",
        "name": "example_tool",
        "args": {
            "param1": "value1",
            "param2": 42
        }
    }
}

执行状态更新

扩展程序向所有连接的客户端广播执行状态更新：

执行开始

{
    "type": "tool_execution_started",
    "data": {
        "executionId": "unique_execution_id",
        "name": "example_tool",
        "args": {
            "param1": "value1",
            "param2": 42
        }
    }
}

执行完成

{
    "type": "tool_execution_completed",
    "data": {
        "executionId": "unique_execution_id",
        "result": {
            // 工具特定的结果数据
        }
    }
}

执行失败

{
    "type": "tool_execution_failed",
    "data": {
        "executionId": "unique_execution_id",
        "error": {
            "code": "ERROR_CODE",
            "message": "错误消息"
        }
    }
}

错误代码

• INVALID_NAME：无效的工具名称
• INVALID_SCHEMA：无效的工具模式
• INVALID_URI：无效的资源URI
• INVALID_HANDLER：无效的处理程序实现
• INVALID_ARGUMENTS：无效的工具参数
• TOOL_EXISTS：工具已注册
• TOOL_NOT_FOUND：未找到工具
• TOOL_EXECUTION_FAILED：工具执行失败
• SERVER_ERROR：内部服务器错误

开发

项目结构

mcp-extension/
├── index.js              # 主插件入口点
├── manifest.json         # 插件清单
├── package.json          # 依赖项和脚本
├── public/              # 公共资产
│   ├── script.js        # 客户端JavaScript
│   ├── style.css        # 客户端样式
│   └── templates/       # HTML模板
├── utils/               # 工具模块
│   ├── errors.js        # 错误处理
│   ├── logger.js        # 日志工具
│   └── validation.js    # 输入验证
└── README.md            # 此文档

添加新工具

要添加新工具：

1. 连接到WebSocket服务器
2. 使用模式注册您的工具
3. 监听执行请求
4. 处理执行并返回结果

示例工具实现：

const ws = new WebSocket('ws://localhost:5005');

ws.onopen = () => {
    // 注册工具
    ws.send(JSON.stringify({
        type: 'register_tool',
        data: {
            name: 'example_tool',
            schema: {
                type: 'object',
                properties: {
                    input: {
                        type: 'string'
                    }
                },
                required: ['input']
            }
        }
    }));
};

ws.onmessage = (event) => {
    const message = JSON.parse(event.data);
    
    if (message.type === 'execute_tool' && 
        message.data.name === 'example_tool') {
        // 处理执行
        const result = doSomething(message.data.args.input);
        
        // 发送结果
        ws.send(JSON.stringify({
            type: 'tool_execution_completed',
            data: {
                executionId: message.data.executionId,
                result
            }
        }));
    }
};

贡献

1. 分叉仓库
2. 创建功能分支
3. 提交更改
4. 推送到分支
5. 创建拉取请求

支持

如果您遇到任何问题或有疑问：

1. 检查GitHub Issues以查看现有问题
2. 如果您的问题尚未报告，请创建一个新的问题
3. 加入SillyTavern Discord社区以获得支持

许可证

MIT许可证 - 详情见LICENSE文件