ModelContextProtocol C SDK 中提示不可见问题的分析与解决

在使用 ModelContextProtocol C# SDK 开发过程中，开发者可能会遇到一个常见问题：在 Claude Desktop 中创建的提示(prompt)无法正常显示。这个问题看似简单，但实际上涉及到了 SDK 的多个核心组件和配置要点。

问题现象

当开发者尝试通过 C# SDK 创建自定义提示时，按照标准方式定义提示类和方法后，在测试 Stdio 服务器与 Desktop Claude 交互时，发现定义的提示无法正常显示。具体表现为：

1. 使用 McpServerPromptType 特性标记的静态类
2. 类中包含使用 McpServerPrompt 和 Description 特性标注的方法
3. 方法返回格式正确的 ChatMessage 对象
4. 通过 WithPromptsFromAssembly 方法加载提示

尽管代码逻辑看似正确，但提示在客户端仍然不可见。

根本原因分析

经过深入分析，这个问题主要源于日志输出与 Stdio 传输协议之间的冲突。ModelContextProtocol 使用标准输入输出(stdin/stdout)作为默认的通信通道，而 .NET 的默认日志记录器会将日志输出到标准输出(stdout)。这导致了：

1. 日志信息与协议消息混合在同一个输出流中
2. Claude Desktop 无法正确解析混杂的协议消息
3. 提示信息虽然生成但无法被客户端正确接收

解决方案

解决这个问题的关键在于正确配置日志输出通道。以下是推荐的解决方案：

var builder = Host.CreateApplicationBuilder();

// 关键配置：将所有日志重定向到标准错误输出(stderr)
builder.Logging.AddConsole(consoleLogOptions =>
{
    consoleLogOptions.LogToStandardErrorThreshold = LogLevel.Trace;
});

builder.Services
    .AddMcpServer()
    .WithStdioServerTransport()
    .WithPromptsFromAssembly()
    .WithToolsFromAssembly();

var app = builder.Build();
await app.RunAsync();

这个配置确保了：

1. 协议通信使用标准输出(stdout)保持纯净
2. 所有日志信息被重定向到标准错误输出(stderr)
3. 客户端和服务器之间的通信不受日志干扰

最佳实践建议

为了避免类似问题，建议开发者在 ModelContextProtocol C# SDK 项目中遵循以下实践：

1. 日志分离：始终将日志输出与协议通信通道分离
2. 环境检查：在开发阶段验证日志输出是否会影响协议通信
3. 配置验证：使用简单的测试提示验证基本功能是否正常
4. 版本兼容性：确保使用的 SDK 版本与客户端版本兼容

深入理解

这个问题实际上反映了分布式系统中一个常见的设计模式：关注点分离。在进程间通信(IPC)场景中，特别是使用标准输入输出作为通信通道时，必须确保：

1. 通信通道专用于协议消息传输
2. 调试和日志信息使用独立通道
3. 错误处理不会干扰正常通信流程

ModelContextProtocol C# SDK 通过灵活的配置选项支持这种分离，但需要开发者正确理解和应用这些配置。

总结

在 ModelContextProtocol 生态系统中，C# SDK 提供了强大的功能来创建和管理 AI 提示。理解其底层通信机制和正确配置相关组件是确保功能正常工作的关键。通过将日志输出重定向到标准错误输出，开发者可以避免通信通道污染问题，确保提示能够正确显示在 Claude Desktop 客户端中。