使用说明

• 项目简介
  • CLIAIMONITOR 是一个 AI 代理协同系统的后端核心组件之一，内置对 MCP 的实现，能够以标准化的 JSON-RPC 方式向 LLM 客户端暴露资源、工具和提示模板，并通过 REST、WebSocket 等方式提供前端和运维所需的能力接口。服务端与前端仪表盘、Captain 编排、以及内存数据库等模块紧密协作，支持多种传输协议以便在不同环境下接入。
• 主要功能点
  • MCP 服务端核心：实现 MCP 的请求/响应处理，提供资源读取、工具调用、提示模板获取等能力的对外入口，并以 JSON-RPC 形式返回响应或通知。
  • 资源、工具与提示模板管理：统一注册、查询与渲染资源、工具及系统提示模板，支持多角色、多场景的上下文服务。
  • 会话与能力声明：对会话状态、能力清单进行管理与暴露，确保 LLM 客户端能够了解可用的资源与工具。
  • 传输协议与实时能力：通过 HTTP REST API、SSE、WebSocket 等通道实现与客户端的实时交互与事件推送。
  • 与前端与 Captain 的联动：Dashboard 提供 UI 与 API，Captain/Captain Supervisor 负责任务编排与执行，内存数据库负责会话与度量等状态管理。
  • 安全与可扩展性：实现对 MCP 与前端的安全边界控制，提供可扩展的模块化结构以便引入新的工具、提示模板和资源类型。
• 安装与运行步骤
  • 构建与启动
    • 在项目根目录执行构建命令，生成 cliaimonitor 可执行文件（Windows 下为 cliaimonitor.exe）。
    • 直接运行可启动 Dashboard、MCP 服务端以及相关协同组件（如 Captain、MemoryDB）。
  • 运行后的位置与端口
    • Dashboard Web 界面默认：http://localhost:3000
    • MCP 服务端端口通过启动参数进行配置，默认端口 3000（若需自定端口，请通过启动参数指定）。
  • 运行前置条件与依赖
    • Go 环境（建议 Go 1.20+，实际项目可能使用与之匹配的版本）。
    • WezTerm 等工具在某些场景下用于显示/管理代理进程（如 Surface 场景中的 pane 操作）。
• MCP 客户端配置说明（给 MCP 客户端使用的连接信息，注意：客户端不需要修改服务器端实现细节）
  • 服务器名称（server_name）示例：CLIAIMONITOR MCP 服务端
  • 启动命令（command）示例：./cliaimonitor
  • 启动参数（args）示例：["-port","3000","-mcp-host","localhost"]
  • 注释说明：该配置用于 MCP 客户端在启动时了解如何与 MCP 服务器建立连接，JSON-RPC 请求将通过 /mcp 路径进行通信，服务端也对 Origin、请求大小等进行校验与管理。
• 基本使用方法
  • 启动后，客户端通过 MCP 入口发起请求（如读取资源、调用工具、获取 Prompts），服务器返回标准的 JSON-RPC 响应或推送通知。
  • 通过仪表盘 REST API 查看状态、指标、模板、以及实时告警等信息；通过 WebSocket 获取实时更新。
  • 结合 Captain 与 supervisor 进行任务编排、代理执行与监控，MemoryDB 提供持久化和会话上下文。