ModelContextProtocol C SDK 中实现长运行操作进度通知的技术解析

在开发基于 ModelContextProtocol (MCP) 规范的服务器端应用时，长运行操作(Long Running Operation)是一个常见需求。本文将深入探讨如何在 C# SDK 中实现这一功能，特别是如何通过进度令牌(progress token)向客户端发送进度通知。

背景与需求

MCP 规范定义了一种标准化的远程过程调用机制，其中长运行操作需要特殊的处理方式。当服务器端执行耗时操作时，客户端需要能够实时了解操作进度，而不是被动等待最终结果。

在 C# SDK 的实现中，开发者发现当前版本无法直接访问请求中的进度令牌(_meta.progressToken)，这阻碍了长运行操作通知功能的实现。

技术实现方案

请求元数据解析

MCP 规范在 JSON-RPC 请求中定义了 _meta 字段，其中包含 progressToken 等重要元信息。正确的实现需要：

1. 在请求反序列化时保留 _meta 字段
2. 通过适当的方式向工具方法暴露这些元数据

C# SDK 的改进

通过分析请求处理流程，我们发现需要在 CallToolRequestParams 类中添加对 _meta 字段的支持。具体实现包括：

public class CallToolRequestParams
{
    [JsonProperty("_meta")]
    public RequestMeta? Meta { get; set; }
    
    // 其他现有属性...
}

public class RequestMeta
{
    [JsonProperty("progressToken")]
    public string? ProgressToken { get; set; }
    
    // 其他可能的元数据字段...
}

长运行操作实现示例

基于上述改进，我们可以实现一个完整的长运行操作工具：

[McpServerToolType]
public static class LongRunningTool
{
    [McpServerTool]
    public static async Task<string> ExecuteLongOperation(
        IMcpServer server,
        RequestContext<CallToolRequestParams> requestParams,
        int totalDuration = 10,
        int progressSteps = 5)
    {
        var stepDuration = totalDuration / progressSteps;
        var progressToken = requestParams?.Params?.Meta?.ProgressToken;

        for (int currentStep = 1; currentStep <= progressSteps; currentStep++)
        {
            await Task.Delay(stepDuration * 1000);

            if (!string.IsNullOrEmpty(progressToken))
            {
                await server.SendMessageAsync(new JsonRpcNotification
                {
                    Method = "notifications/progress",
                    Params = new
                    {
                        progressToken,
                        total = progressSteps,
                        progress = currentStep
                    }
                });
            }
        }

        return $"操作完成，总耗时{totalDuration}秒，分为{progressSteps}个步骤";
    }
}

关键点解析

1. 进度通知机制：通过 progressToken 唯一标识每个长运行操作，服务器可以定向发送进度更新

2. 通知格式：遵循 MCP 规范，使用 notifications/progress 方法发送结构化进度信息

3. 线程安全：异步方法确保不会阻塞服务器主线程

4. 错误处理：在实际应用中应添加适当的异常处理和超时机制

最佳实践建议

1. 合理设置进度更新频率，避免过于频繁的通知影响性能

2. 对于极短时间的操作(秒级以下)，可以考虑不实现进度通知

3. 在进度通知中包含有意义的描述信息，而不仅仅是百分比

4. 考虑实现取消机制，允许客户端中止长运行操作

总结

通过对 C# SDK 的适当扩展，我们能够完整支持 MCP 规范中的长运行操作模式。这种实现既保持了与规范的一致性，又提供了良好的开发者体验。进度通知机制的加入使得构建响应式、用户友好的 MCP 服务成为可能。