MCP 服务器

SillyTavern MCP Server

通过基于 WebSocket 的通信，实现外部工具的注册和执行，为 SillyTavern 提供一个统一的接口，用于实时工具管理。

README

SillyTavern 的 MCP 扩展

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

功能

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

安装

方法 1：Web 界面（推荐）

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

方法 2：手动安装

将此存储库克隆到您的 SillyTavern 插件目录：

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

安装依赖项：
```
cd mcp-extension
npm install
```
重启 SillyTavern

配置

可以通过 SillyTavern UI 在“设置”>“扩展”>“MCP 扩展”下配置扩展。

可用设置

WebSocket 端口：WebSocket 服务器的端口号（默认值：5005）
日志级别：日志记录详细程度（debug、info、warn、error）

用法

注册工具

要注册工具，请发送具有以下格式的 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            # 此文档

添加新工具

要添加新工具：

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

示例工具实现：

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
            }
        }));
    }
};