日志记录

ℹ️
协议版本: 2024-11-05

模型上下文协议(MCP)为服务器提供了一种标准化方式,用于向客户端发送结构化日志消息。客户端可以通过设置最低日志级别来控制日志详细程度,服务器则发送包含严重性级别、可选的记录器名称和任意JSON可序列化数据的通知。

用户交互模型

实现可以通过任何适合其需求的界面模式来展示日志记录功能——协议本身不强制要求任何特定的用户交互模型。

能力

发送日志消息通知的服务器必须声明logging能力:

{
  "capabilities": {
    "logging": {}
  }
}

日志级别

协议遵循RFC 5424中指定的标准syslog严重性级别:

级别描述使用场景示例
debug详细的调试信息函数进入/退出点
info一般信息性消息操作进度更新
notice正常但重要的事件配置更改
warning警告条件已弃用功能的使用
error错误条件操作失败
critical严重条件系统组件故障
alert必须立即采取行动检测到数据损坏
emergency系统不可用完全系统故障

协议消息

设置日志级别

要配置最低日志级别,客户端可以发送logging/setLevel请求:

请求:

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "logging/setLevel",
  "params": {
    "level": "info"
  }
}

日志消息通知

服务器使用notifications/message通知发送日志消息:

{
  "jsonrpc": "2.0",
  "method": "notifications/message",
  "params": {
    "level": "error",
    "logger": "database",
    "data": {
      "error": "Connection failed",
      "details": {
        "host": "localhost",
        "port": 5432
      }
    }
  }
}

消息流

sequenceDiagram
    participant Client
    participant Server

    Note over Client,Server: 配置日志记录
    Client->>Server: logging/setLevel (info)
    Server-->>Client: 空结果

    Note over Client,Server: 服务器活动
    Server--)Client: notifications/message (info)
    Server--)Client: notifications/message (warning)
    Server--)Client: notifications/message (error)

    Note over Client,Server: 级别变更
    Client->>Server: logging/setLevel (error)
    Server-->>Client: 空结果
    Note over Server: 仅发送error级别
及以上

错误处理

服务器应该为常见故障情况返回标准JSON-RPC错误:

  • 无效的日志级别:-32602(无效参数)
  • 配置错误:-32603(内部错误)

实现考虑因素

  1. 服务器应该

    • 对日志消息进行速率限制
    • 在数据字段中包含相关上下文
    • 使用一致的记录器名称
    • 移除敏感信息
  2. 客户端可以

    • 在UI中呈现日志消息
    • 实现日志过滤/搜索
    • 以视觉方式显示严重性
    • 持久化日志消息

安全性

  1. 日志消息不得包含:

    • 凭证或密钥
    • 个人身份信息
    • 可能帮助攻击的内部系统详细信息
  2. 实现应该

    • 对消息进行速率限制
    • 验证所有数据字段
    • 控制日志访问
    • 监控敏感内容