日志记录

协议版本：2025-03-26

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

用户交互模型

实现可以自由地通过适合其需求的任何接口模式公开日志记录——协议本身并不强制要求任何特定的用户交互模型。

功能

发出日志消息通知的服务器必须声明 logging 功能：

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

日志级别

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

协议消息

设置日志级别

要配置最低日志级别，客户端可以发送 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: 仅发送错误级别<br/>及以上

错误处理

服务器应该为常见失败情况返回标准 JSON-RPC 错误：

• 无效的日志级别：-32602（无效参数）
• 配置错误：-32603（内部错误）

实现考虑

1. 服务器应该：

   • 限制日志消息的速率
   • 在数据字段中包含相关上下文
   • 使用一致的记录器名称
   • 删除敏感信息

2. 客户端可以：

   • 在 UI 中显示日志消息
   • 实施日志过滤/搜索
   • 可视化显示严重性
   • 持久化日志消息

安全

1. 日志消息绝不能包含：

   • 凭据或机密
   • 个人身份信息
   • 可能有助于攻击的内部系统详细信息

2. 实现应该：

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