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

用户交互模型

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

功能

发出日志消息通知的服务器**必须**声明 `logging` 能力。
{
  "capabilities": {
    "logging": {}
  }
}

日志级别

该协议遵循 RFC 5424 中指定的标准 syslog 严重性级别。
级别描述用例示例
debug (调试)详细的调试信息函数进入/退出点
info (信息)一般性信息消息操作进度更新
notice (注意)正常但重要的事件配置变更
warning (警告)警告情况使用了已弃用的功能
error (错误)错误条件操作失败
critical (严重)严重情况系统组件故障
alert (警报)必须立即采取行动检测到数据损坏
emergency (紧急)系统不可用系统完全故障

协议消息

设置日志级别

要配置最低日志级别,客户端**可以 (MAY)** 发送一个 `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
      }
    }
  }
}

消息流

错误处理

服务器应该为常见的失败情况返回标准的 JSON-RPC 错误
  • 无效的日志级别:`-32602` (无效参数)
  • 配置错误:`-32603` (内部错误)

实现注意事项

  1. 服务器**应该**
    • 对日志消息进行速率限制
    • 在数据字段中包含相关上下文
    • 使用一致的日志记录器名称
    • 移除敏感信息
  2. 客户端**可以 (MAY)**
    • 在用户界面中呈现日志消息
    • 实现日志过滤/搜索功能
    • 以可视化的方式显示严重性
    • 持久化存储日志消息

安全性

  1. 日志消息**绝不能 (MUST NOT)** 包含
    • 凭证或密钥
    • 个人身份信息
    • 可能有助于攻击的内部系统细节
  2. 实现方**应该 (SHOULD)**
    • 对消息进行速率限制
    • 验证所有数据字段
    • 控制日志访问
    • 监控敏感内容