38b4a26998* Remove `McpEndpoint` & `IMcpClient` * Revise naming, add abstract classes * Fix missing renames * Move extension methods to instance methods * Add back old API, but obsoleted * Add back obsoleted factory classes * Move deprecation attributes * `SseClientTransport` -> `HttpClientTransport` * Update src/ModelContextProtocol.Core/Server/AugmentedServiceProvider.cs Co-authored-by: Stephen Halter <halter73@gmail.com> * PR feedback * PR feedback * Add back dispose lock * Fix docs projects * PR feedback * Undo `docs/*.md` changes --------- Co-authored-by: Stephen Halter <halter73@gmail.com>
71 lines
3.5 KiB
C#
71 lines
3.5 KiB
C#
using ModelContextProtocol.Client;
|
|
using ModelContextProtocol.Server;
|
|
using System.Threading.Channels;
|
|
|
|
namespace ModelContextProtocol.Protocol;
|
|
|
|
/// <summary>
|
|
/// Represents a transport mechanism for MCP (Model Context Protocol) communication between clients and servers.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// <para>
|
|
/// The <see cref="ITransport"/> interface is the core abstraction for bidirectional communication.
|
|
/// It provides methods for sending and receiving messages, abstracting away the underlying transport mechanism
|
|
/// and allowing protocol implementations to be decoupled from communication details.
|
|
/// </para>
|
|
/// <para>
|
|
/// Implementations of <see cref="ITransport"/> handle the serialization, transmission, and reception of
|
|
/// messages over various channels like standard input/output streams and HTTP (Server-Sent Events).
|
|
/// </para>
|
|
/// <para>
|
|
/// While <see cref="IClientTransport"/> is responsible for establishing a client's connection,
|
|
/// <see cref="ITransport"/> represents an established session. Client implementations typically obtain an
|
|
/// <see cref="ITransport"/> instance by calling <see cref="IClientTransport.ConnectAsync"/>.
|
|
/// </para>
|
|
/// </remarks>
|
|
public interface ITransport : IAsyncDisposable
|
|
{
|
|
/// <summary>Gets an identifier associated with the current MCP session.</summary>
|
|
/// <remarks>
|
|
/// Typically populated in transports supporting multiple sessions such as Streamable HTTP or SSE.
|
|
/// Can return <see langword="null"/> if the session hasn't initialized or if the transport doesn't
|
|
/// support multiple sessions (as is the case with STDIO).
|
|
/// </remarks>
|
|
string? SessionId { get; }
|
|
|
|
/// <summary>
|
|
/// Gets a channel reader for receiving messages from the transport.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// <para>
|
|
/// The <see cref="MessageReader"/> provides access to incoming JSON-RPC messages received by the transport.
|
|
/// It returns a <see cref="ChannelReader{T}"/> which allows consuming messages in a thread-safe manner.
|
|
/// </para>
|
|
/// <para>
|
|
/// The reader will continue to provide messages as long as the transport is connected. When the transport
|
|
/// is disconnected or disposed, the channel will be completed and no more messages will be available after
|
|
/// any already transmitted messages are consumed.
|
|
/// </para>
|
|
/// </remarks>
|
|
ChannelReader<JsonRpcMessage> MessageReader { get; }
|
|
|
|
/// <summary>
|
|
/// Sends a JSON-RPC message through the transport.
|
|
/// </summary>
|
|
/// <param name="message">The JSON-RPC message 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 that represents the asynchronous send operation.</returns>
|
|
/// <exception cref="InvalidOperationException">The transport is not connected.</exception>
|
|
/// <remarks>
|
|
/// <para>
|
|
/// This method serializes and sends the provided JSON-RPC message through the transport connection.
|
|
/// </para>
|
|
/// <para>
|
|
/// This is a core method used by higher-level abstractions in the MCP protocol implementation.
|
|
/// Most client code should use the higher-level methods provided by <see cref="McpSession"/>,
|
|
/// <see cref="McpClient"/>, or <see cref="McpServer"/>,
|
|
/// rather than accessing this method directly.
|
|
/// </para>
|
|
/// </remarks>
|
|
Task SendMessageAsync(JsonRpcMessage message, CancellationToken cancellationToken = default);
|
|
}
|