使用说明

项目简介

Room MCP 是一个实现了 Model Context Protocol (MCP) 协议的服务器工具，它专注于为 LLM (如 Claude) 提供虚拟房间管理功能。通过 Room MCP，LLM 客户端可以创建和加入虚拟房间，在房间内与其他 Agent 进行协作，共同完成特定目标。该工具利用 MCP 协议提供的标准化接口，使得 LLM 能够方便地获取上下文信息和调用房间管理功能。

主要功能点

虚拟房间管理: 支持创建、加入和管理虚拟房间，为 Agent 提供隔离和协作的工作空间。
Room 协议集成: 基于 Room 协议实现房间的创建和连接，方便 Agent 在对等网络中进行交互。
邀请机制: 通过 '@agree-able/invite' 包提供房间邀请功能，方便 Agent 邀请其他参与者加入房间。
会话记录: 支持将房间对话记录保存到本地文件，方便后续回顾和分析。
MCP 标准支持: 完全遵循 Model Context Protocol 协议，为 LLM 客户端提供标准的上下文服务接口。

安装步骤

安装 Node.js 和 npm: 确保你的系统已经安装了 Node.js 和 npm (Node 包管理器)。
全局安装 Room MCP: 打开终端，运行以下命令全局安装 Room MCP：
```
npm install -g @agree-able/room-mcp
```
或者，如果你只想在当前项目中使用，可以去掉 '-g' 参数。

服务器配置

要将 Room MCP 配置为 Claude Desktop 的 MCP 服务器，你需要编辑 'claude_desktop_config.json' 文件，添加以下 server 配置信息。这里的 'command' 和 'args' 告诉 Claude Desktop 如何启动 Room MCP 服务器。

{
  "mcpServers": {
    "room": {  // 服务器名称，可以自定义，例如 "room"
      "command": "npx", // 启动命令，这里使用 npx 来运行 npm 包
      "args": [ // 启动参数
        "-y",  // npx 参数，自动确认执行
        "@agree-able/room-mcp" // 要执行的 npm 包名称，即 Room MCP
      ],
      "env": { // 环境变量（可选）
        "ROOM_TRANSCRIPTS_FOLDER": "/path/to/transcripts" // (可选) 设置房间记录保存路径，请替换为实际路径，不设置则不保存
      }
    }
  }
}

注意:

'server name': "room" 可以自定义，用于在 Claude Desktop 中标识这个 MCP 服务器。
'command' 和 'args': 配置了使用 'npx' 命令来运行 '@agree-able/room-mcp' 包。这表示 Claude Desktop 将通过 'npx -y @agree-able/room-mcp' 命令来启动 Room MCP 服务器。
'env': 'ROOM_TRANSCRIPTS_FOLDER' 是一个可选的环境变量，用于指定房间对话记录的保存路径。你可以根据需要设置或删除此项。

基本使用方法

启动 Room MCP 服务器: 当 Claude Desktop 启动并加载配置后，Room MCP 服务器将自动启动。
创建房间: 在 Claude 中，你可以通过与 Room MCP 服务器交互，指示其创建一个新的虚拟房间。具体指令和操作方式取决于 Claude 客户端的实现。通常，你可能需要使用特定的 Prompt 或指令来触发房间创建。
加入房间: 类似地，你可以指示 Claude 客户端加入一个已存在的房间。这可能需要房间的邀请码或其他房间标识信息。
房间内协作: 一旦加入房间，Claude 可以与其他 Agent 在该房间内进行对话和协作，完成预定任务。Room MCP 服务器负责管理房间状态和提供必要的上下文信息。
查看会话记录: 如果在配置中设置了 'ROOM_TRANSCRIPTS_FOLDER' 环境变量，房间对话记录将在房间结束后保存到指定路径。

详细使用方法和示例: 请参考仓库的 docs/examples.md 文档，了解更多关于如何使用 Room MCP 以及与其他 Agent 协作的示例。

关键词