Skip to content

日志记录

协议版本: 2025-06-18

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

1. 用户交互模型

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

2. 功能特性

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

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

3. 日志级别

该协议遵循 <RFC 5424> 中指定的标准系统日志严重性级别:

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

4. 协议消息

4.1 设置日志级别

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

请求:

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

4.2 日志消息通知

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

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

5. 消息流程

6. 错误处理

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

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

7. 实现注意事项

7.1 服务器应该做的事情

服务器应该

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

7.2 客户端可以做的事情

客户端可以

  • 在用户界面中呈现日志消息
  • 实现日志过滤/搜索功能
  • 视觉化显示严重性级别
  • 持久化保存日志消息

8. 安全性

8.1 必须避免的内容

日志消息不得包含:

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

8.2 实现建议

实现应该

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