34 lines
1.8 KiB
C#
34 lines
1.8 KiB
C#
using ModelContextProtocol.Protocol.Messages;
|
|
|
|
namespace ModelContextProtocol;
|
|
|
|
/// <summary>Represents a client or server MCP endpoint.</summary>
|
|
public interface IMcpEndpoint : IAsyncDisposable
|
|
{
|
|
/// <summary>Sends a JSON-RPC request to the connected endpoint.</summary>
|
|
/// <param name="request">The JSON-RPC request to send.</param>
|
|
/// <param name="cancellationToken">The <see cref="CancellationToken"/> to monitor for cancellation requests. The default is <see cref="CancellationToken.None"/>.</param>
|
|
/// <returns>A task containing the client's response.</returns>
|
|
Task<JsonRpcResponse> SendRequestAsync(JsonRpcRequest request, CancellationToken cancellationToken = default);
|
|
|
|
/// <summary>Sends a message to the connected endpoint.</summary>
|
|
/// <param name="message">The message.</param>
|
|
/// <param name="cancellationToken">The <see cref="CancellationToken"/> to monitor for cancellation requests. The default is <see cref="CancellationToken.None"/>.</param>
|
|
Task SendMessageAsync(IJsonRpcMessage message, CancellationToken cancellationToken = default);
|
|
|
|
/// <summary>
|
|
/// Adds a handler for server notifications of a specific method.
|
|
/// </summary>
|
|
/// <param name="method">The notification method to handle.</param>
|
|
/// <param name="handler">The async handler function to process notifications.</param>
|
|
/// <remarks>
|
|
/// <para>
|
|
/// Each method may have multiple handlers. Adding a handler for a method that already has one
|
|
/// will not replace the existing handler.
|
|
/// </para>
|
|
/// <para>
|
|
/// <see cref="NotificationMethods"> provides constants for common notification methods.</see>
|
|
/// </para>
|
|
/// </remarks>
|
|
void AddNotificationHandler(string method, Func<JsonRpcNotification, Task> handler);
|
|
}
|