How to implement Progress Reporting in C# SDK

[YashasAnand]

Pre-submission Checklist

• I have checked that this question would not be more appropriate as an issue in a specific repository
• I have searched existing discussions and documentation for answers

Question Category

• Protocol Specification
• SDK Usage
• Server Implementation
• General Implementation
• Documentation
• Other

Your Question

I am trying to implement a C# Server SDK with a long running task. How do I implement progress reporting with C# sdk.

[McpServerTool, Description("Retrieves the status counts of all jobs for a specific device.")]
public async Task<JobStatusCountsData?> GetJobStatusCountsAsync(
[Description("ID to fetch the job status counts.")] string Id,
CancellationToken cancellationToken = default)
{
try
{
//Add progress report to say that task has started
await Task.Delay(TimeSpan.FromMinutes(5));
//Add progress report to say this has ended
}
}

[stephentoub]

Augment your tool to accept a parameter of type IProgress<ProgressNotificationValue>. If the client provided a progress token, any progress notifications you report on that instance will propagate to the client.

e.g. modifying your example:

[McpServerTool, Description("Retrieves the status counts of all jobs for a specific device.")] public async Task<JobStatusCountsData?> GetJobStatusCountsAsync( [Description("ID to fetch the job status counts.")] string Id, + IProgress<ProgressNotificationValue> progress, CancellationToken cancellationToken = default) { + progress.Report(new() { Progress = 0.0, Message = "Starting..." }; ... }