Remarq MCP 服务器

使用说明（Markdown 格式）

• 项目简介
  • Remarq MCP 服务器是一个完整的 MCP 服务端实现，允许 MCP 客户端通过标准化的 JSON-RPC 调用访问 Remarq 的注释系统功能。服务器暴露一组 MCP 工具，涵盖对注释的读取、创建、回复与完成状态更新等操作，便于 AI Agent 在上下文中读取、生成并提交处理结果。
• 主要功能点
  • 提供 MCP 工具注册与执行能力（如 check_connection、list_comments、create_comment、reply_to_comment、resolve_comment）。
  • 通过 MCP 的 JSON-RPC 协议处理请求与响应，兼容 MCP 客户端的调用模式。
  • 与 Remarq 的 REST 后端通信，使用 Remarq 的 API 完成注释、文档等资源的实际操作。
  • 适配多种传输方式（MCP 服务器侧的实现可与其他传输层协同工作，当前实现示例中基于标准输入/输出的传输模式运行）。
• 安装步骤
  1. 克隆仓库并安装依赖：
     • 安装 Node.js 环境
     • npm install
  2. 确保 Remarq REST API 已就绪并在可访问地址运行（默认 http://localhost:3333），若使用其他地址，请通过 REMARQ_URL 指定。
  3. 启动 MCP 服务器：
     • 在包含 mcp-server 的目录中执行启动命令（下文提供了可用于 MCP 客户端的配置信息）。
• 服务器配置（MCP 客户端配置信息示例，需以 JSON 形式提供给客户端以启动 MCP 服务器） { "serverName": "remarq", "command": "node", "args": ["mcp-server/src/index.js"], "env": { "REMARQ_URL": "http://localhost:3333" } } 注释：
  • serverName: MCP 服务器的唯一标识，需与客户端对接时保持一致。
  • command & args: 启动服务器所需的命令与参数，客户端据此在子进程中启动 MCP 服务器。
  • env: 运行时需要的环境变量，REMARQ_URL 指向 Remarq REST API 的地址。
  • 该配置适用于需要通过一个独立进程运行 MCP 服务器的场景，实际部署时可按你的运行环境调整。
• 基本使用方法
  • 启动 Remarq REST API 服务
  • 启动 MCP 服务器（如上配置所示）
  • 使用 MCP 客户端（如 Claude/Cursor 等 MCP 客户端）以 JSON-RPC 的方式调用以下工具：
    • check_connection：测试服务器连通性
    • list_comments、create_comment、reply_to_comment、resolve_comment：对 Remarq 注释系统进行读写和状态变更
  • 监控与日志：服务器将输出启动信息及请求处理日志，便于排错与性能评估