KoboldCPP-MCP-Server 使用说明

项目简介

KoboldCPP-MCP-Server 是一个基于 Model Context Protocol (MCP) 标准构建的服务器，旨在弥合 MCP 客户端应用和 KoboldAI 文本生成引擎之间的鸿沟。通过此服务器，你可以使用任何兼容 MCP 协议的客户端，便捷地调用 KoboldAI 的各种功能，包括文本生成、聊天对话、图像生成（Stable Diffusion）等。

主要功能点

文本生成能力: 利用 KoboldAI 强大的文本生成能力，支持多种参数配置，满足不同的生成需求。
持久化聊天记忆: 支持带有记忆的聊天对话，让对话更连贯自然。
OpenAI 兼容 API: 提供部分 OpenAI API 兼容的接口，方便现有应用的迁移和集成。
Stable Diffusion 集成: 集成 Stable Diffusion，支持文生图和图生图功能。
多种实用工具: 包括音频转录、文本转语音、网页搜索等工具，扩展了 LLM 应用的边界。
基于 MCP SDK: 使用官方 MCP SDK 构建，保证了与 MCP 协议的兼容性和规范性。

安装步骤

安装 Node.js: 确保你的系统已安装 Node.js (v16 或更高版本) 和 npm 或 yarn 包管理器。

安装 KoboldCPP-MCP-Server: 打开终端，运行以下命令安装服务器：

npm install kobold-mcp-server

安装 KoboldAI: 确保已安装并成功运行 KoboldAI 服务。KoboldCPP-MCP-Server 需要连接到正在运行的 KoboldAI 实例才能工作。

服务器配置

MCP 客户端需要配置以下信息以连接到 KoboldCPP-MCP-Server。以下是一个 JSON 格式的配置示例，请根据你的实际情况进行调整。

{
  "serverName": "kobold-server",  // MCP 服务器名称，代码中定义为 "kobold-server"
  "command": "node",           // 启动服务器的命令，这里使用 node.js 运行时
  "args": [
    "node_modules/kobold-mcp-server/dist/index.js" // 服务器入口文件路径，相对于 MCP 客户端的工作目录
  ],
  "transport": "stdio"         // 使用 stdio 作为传输协议，与服务器代码配置一致
}

配置参数说明:

'serverName': 服务器的名称，用于在 MCP 客户端中标识和管理不同的服务器连接。
'command': 启动服务器进程的可执行命令。由于 KoboldCPP-MCP-Server 是 Node.js 应用，这里使用 'node' 命令。
'args': 传递给 'command' 的参数列表。这里指定了服务器入口文件 'index.js' 的路径。请注意，'node_modules/kobold-mcp-server/dist/index.js' 是相对于 MCP 客户端程序运行目录的路径。 如果你的客户端程序和 'node_modules' 不在同一目录下，请根据实际情况调整此路径。
'transport': 指定 MCP 服务器使用的传输协议。KoboldCPP-MCP-Server 默认使用 'stdio' (标准输入输出) 协议，因此这里配置为 'stdio'。

重要提示:

确保 KoboldAI 服务已启动并可通过配置中的 'apiUrl' 访问 (默认为 'http://localhost:5001')。
如果 KoboldAI 服务运行在不同的主机或端口，你需要通过环境变量或修改配置文件来调整 'apiUrl'。

基本使用方法

启动 MCP 客户端: 打开并配置你的 MCP 客户端应用。
配置 MCP 服务器: 在 MCP 客户端中添加上述服务器配置信息。
连接服务器: 在 MCP 客户端中连接到 "kobold-server"。
调用工具: 连接成功后，你就可以在 MCP 客户端中使用 KoboldCPP-MCP-Server 提供的各种工具了，例如 'kobold_generate' (文本生成), 'kobold_chat' (聊天), 'kobold_txt2img' (文生图) 等。具体工具列表请参考服务器的 'ListTools' 接口或 MCP 客户端的工具列表。

通过 KoboldCPP-MCP-Server，你可以方便地将 KoboldAI 的强大功能集成到任何支持 MCP 协议的 LLM 应用或工作流中。

关键词