ModelContextProtocol C SDK 中 TestServerWithHosting 的日志输出问题解析

在 ModelContextProtocol C# SDK 开发过程中，TestServerWithHosting 示例程序展示了一个使用标准输入输出的服务器实现。然而，该示例存在一个重要的日志输出问题，可能影响协议规范的正确实现。

问题现象

当启动 TestServerWithHosting 示例时，程序会向标准输出(stdout)打印多条日志信息，包括：

• 服务器启动信息
• 主机环境信息
• 内容根路径
• 传输层消息循环状态等

这些日志输出违反了 ModelContextProtocol 规范中关于传输通道的严格要求。

协议规范要求

根据 ModelContextProtocol 规范，服务器实现必须遵守以下关于标准输出的规则：

1. 服务器可以向标准错误(stderr)输出 UTF-8 格式的日志字符串
2. 服务器不得向标准输出(stdout)写入任何非 MCP 协议消息的内容

这种严格要求是为了确保标准输出通道的纯净性，使其专门用于协议消息传输，避免与日志信息混淆。

问题根源分析

问题的根源在于 .NET 的 Host.CreateApplicationBuilder 方法会自动创建一个控制台日志记录器。这个默认行为虽然对大多数应用程序很方便，但在需要严格控制标准输出的场景下会产生问题。

在 ModelContextProtocol 的实现中，标准输出被专门用作协议消息传输通道，任何额外的输出都可能干扰客户端对协议消息的解析和处理。

解决方案

针对这个问题，开发者可以采用以下解决方案：

var builder = Host.CreateApplicationBuilder(args);

// 清除默认的日志提供程序
builder.Logging.ClearProviders();

// 可选：添加其他不干扰标准输出的日志提供程序
builder.Logging.AddDebug();
builder.Logging.AddEventSourceLogger();

这种方法通过以下步骤解决问题：

1. 首先清除所有默认的日志提供程序，包括自动添加的控制台日志记录器
2. 然后根据需要添加其他不干扰标准输出的日志记录方式

最佳实践建议

在实现 ModelContextProtocol 服务器时，建议遵循以下最佳实践：

1. 严格控制标准输出：确保 stdout 只用于协议消息传输
2. 合理使用 stderr：可以将日志信息输出到标准错误流
3. 考虑日志级别：生产环境中可以适当减少日志详细程度
4. 提供日志配置选项：允许用户根据需要配置日志输出方式

总结

正确处理日志输出是 ModelContextProtocol 实现中的一个重要细节。通过理解协议规范要求并合理配置 .NET 的日志系统，开发者可以确保服务器实现既满足功能需求，又符合协议规范。这种对细节的关注是构建可靠、符合标准的协议实现的关键所在。