日志

Model Context Protocol(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
      }
    }
  }
}

消息流

Server Client Server Client 配置日志 服务器活动 级别变更 仅发送error级别 及以上的消息 logging/setLevel (info)空结果notifications/message (info)notifications/message (warning)notifications/message (error)logging/setLevel (error)空结果

错误处理

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

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

实现注意事项

  1. 服务器应该

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

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

安全性

  1. 日志消息不得包含:

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

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