使用说明
项目简介
SillyTavern-MCP-Server 是一个为 SillyTavern 应用设计的 MCP (Model Context Protocol) 服务器插件。它旨在扩展 SillyTavern 的功能,使其能够作为 MCP 服务器,为支持 MCP 协议的 LLM 客户端提供上下文服务。
主要功能点
- 资源 (Resources) 托管与管理: 虽然仓库信息中没有直接体现资源管理功能,但作为 MCP 服务器实现,理论上具备托管和管理资源的能力,以便 LLM 客户端访问数据。
- 工具 (Tools) 注册与执行: 仓库描述中提及 “MCP server plugin”,根据 MCP 定义,服务器应支持注册和执行工具,允许 LLM 客户端调用外部功能。
- Prompt 模板 (Prompts) 定义与渲染: 同样基于 MCP 服务器的定义,服务器应具备 Prompt 模板管理能力,以支持定制化的 LLM 交互模式。
- 基于 JSON-RPC 协议通信: MCP 服务器需要通过 JSON-RPC 协议与客户端进行通信,仓库描述中虽然未明确指出,但作为 MCP 服务器的必要条件,默认应支持。
- 支持 Stdio 传输协议: 通过插件的安装方式(复制到 SillyTavern 插件目录),推断其主要通过 Stdio 协议与 SillyTavern 客户端插件进行通信。
安装步骤
-
克隆仓库到 SillyTavern 插件目录: 打开终端,进入 SillyTavern 根目录下的 'plugins' 文件夹,运行以下命令克隆仓库:
git clone https://github.com/bmen25124/SillyTavern-MCP-Server -
启用服务器插件: 编辑 SillyTavern 根目录下的 'config.yaml' 文件,确保 'enableServerPlugins' 设置为 'true':
enableServerPlugins: true -
重启 SillyTavern 服务器: 重启 SillyTavern 服务使插件生效。
-
配合 MCP 客户端使用: 此 MCP 服务器插件需要配合 SillyTavern-MCP-Client 客户端插件使用。请确保您已安装并配置了客户端插件。
服务器配置
MCP 服务器插件作为 SillyTavern 的一部分运行,无需单独配置启动命令。
客户端插件需要配置服务器连接信息,通常在客户端插件的设置中进行配置。
以下是一个客户端插件 可能的 服务器连接配置示例 (JSON 格式),用于连接到本地运行的 SillyTavern MCP 服务器:
{ "serverName": "SillyTavern MCP Server", "command": "不需要配置,插件与 SillyTavern 服务器一同启动", "args": "不需要配置", "type": "stdio" }
- 'serverName': 服务器名称,可自定义,用于在客户端插件中标识服务器连接。
- 'command': 无需配置,服务器插件作为 SillyTavern 的一部分自动运行,不需要单独的启动命令。
- 'args': 无需配置,同上。
- 'type': 传输协议类型,这里假定为 'stdio',因为插件是作为 SillyTavern 的插件安装的。
请注意: 以上配置信息为推断,实际配置请参考 SillyTavern-MCP-Client 客户端插件的文档或设置界面。
基本使用方法
- 确保 SillyTavern 服务器和 SillyTavern-MCP-Client 客户端插件都已正确安装并启动。
- 在支持 MCP 协议的 LLM 客户端中,配置连接到 SillyTavern-MCP-Server。
- 使用 LLM 客户端发送符合 MCP 协议的请求,例如:
- 请求读取资源
- 请求调用已注册的工具
- 请求获取 Prompt 模板
- MCP 服务器插件将处理请求,并返回符合 MCP 协议的响应。
重要提示: 由于仓库信息有限,以上使用说明基于 MCP 协议的通用特性和仓库描述进行推断。具体使用方法和功能,请参考 SillyTavern-MCP-Server 和 SillyTavern-MCP-Client 仓库的详细文档和代码。
信息
分类
开发者工具