2ca96f548bCo-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: Tarek Mahmoud Sayed <tarekms@ntdev.microsoft.com>
83 lines
3.4 KiB
C#
83 lines
3.4 KiB
C#
using ModelContextProtocol.Protocol;
|
|
namespace ModelContextProtocol.Extensions.Tasks;
|
|
|
|
/// <summary>
|
|
/// Represents the result of a request that supports task-augmented execution, which may be either
|
|
/// the standard result or a <see cref="CreateTaskResult"/> indicating asynchronous processing.
|
|
/// </summary>
|
|
/// <typeparam name="TResult">The standard result type for the request (e.g., <see cref="CallToolResult"/>).</typeparam>
|
|
/// <remarks>
|
|
/// <para>
|
|
/// When a server supports the <c>io.modelcontextprotocol/tasks</c> extension and the client declares
|
|
/// the extension capability on its request, the server may return a <see cref="CreateTaskResult"/>
|
|
/// instead of the standard result. This type represents that polymorphic response.
|
|
/// </para>
|
|
/// <para>
|
|
/// Use <see cref="IsTask"/> to determine which variant was returned, then access either
|
|
/// <see cref="Result"/> for the immediate result or <see cref="TaskCreated"/> for the task handle.
|
|
/// </para>
|
|
/// <para>
|
|
/// See the <see href="https://github.com/modelcontextprotocol/modelcontextprotocol/blob/main/seps/2663-tasks-extension.md">SEP-2663</see>
|
|
/// specification for details.
|
|
/// </para>
|
|
/// </remarks>
|
|
public class ResultOrCreatedTask<TResult> where TResult : Result
|
|
{
|
|
private readonly TResult? _result;
|
|
private readonly CreateTaskResult? _taskCreated;
|
|
|
|
/// <summary>
|
|
/// Initializes a new instance of <see cref="ResultOrCreatedTask{TResult}"/> with an immediate result.
|
|
/// </summary>
|
|
/// <param name="result">The standard result returned by the server.</param>
|
|
public ResultOrCreatedTask(TResult result)
|
|
{
|
|
if (result is null)
|
|
{
|
|
throw new ArgumentNullException(nameof(result));
|
|
}
|
|
_result = result;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Initializes a new instance of <see cref="ResultOrCreatedTask{TResult}"/> with a task handle.
|
|
/// </summary>
|
|
/// <param name="taskCreated">The task creation result returned by the server.</param>
|
|
public ResultOrCreatedTask(CreateTaskResult taskCreated)
|
|
{
|
|
if (taskCreated is null)
|
|
{
|
|
throw new ArgumentNullException(nameof(taskCreated));
|
|
}
|
|
_taskCreated = taskCreated;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets a value indicating whether the server created a task instead of returning an immediate result.
|
|
/// </summary>
|
|
public bool IsTask => _taskCreated is not null;
|
|
|
|
/// <summary>
|
|
/// Gets the immediate result, or <see langword="null"/> if the server created a task.
|
|
/// </summary>
|
|
public TResult? Result => _result;
|
|
|
|
/// <summary>
|
|
/// Gets the task creation result, or <see langword="null"/> if the server returned an immediate result.
|
|
/// </summary>
|
|
public CreateTaskResult? TaskCreated => _taskCreated;
|
|
|
|
/// <summary>
|
|
/// Implicitly converts a <typeparamref name="TResult"/> to a <see cref="ResultOrCreatedTask{TResult}"/>
|
|
/// wrapping the immediate result.
|
|
/// </summary>
|
|
/// <param name="result">The result to wrap.</param>
|
|
public static implicit operator ResultOrCreatedTask<TResult>(TResult result) => new(result);
|
|
|
|
/// <summary>
|
|
/// Implicitly converts a <see cref="CreateTaskResult"/> to a <see cref="ResultOrCreatedTask{TResult}"/>
|
|
/// wrapping the task handle.
|
|
/// </summary>
|
|
/// <param name="taskCreated">The task creation result to wrap.</param>
|
|
public static implicit operator ResultOrCreatedTask<TResult>(CreateTaskResult taskCreated) => new(taskCreated);
|
|
}
|