Completion support (#15)
This commit is contained in:
parent
3e35efe79c
commit
107c7acc8f
7 changed files with 270 additions and 1 deletions
|
|
@ -99,6 +99,16 @@ public interface IMcpClient : IAsyncDisposable
|
|||
/// <returns></returns>
|
||||
Task<ReadResourceResult> ReadResourceAsync(string uri, CancellationToken cancellationToken = default);
|
||||
|
||||
/// <summary>
|
||||
/// Gets the completion options for a resource or prompt reference and (named) argument.
|
||||
/// </summary>
|
||||
/// <param name="reference">A resource (uri) or prompt (name) reference</param>
|
||||
/// <param name="argumentName">Name of argument. Must be non-null and non-empty.</param>
|
||||
/// <param name="argumentValue">Value of argument. Must be non-null.</param>
|
||||
/// <param name="cancellationToken">A token to cancel the operation.</param>
|
||||
/// <returns></returns>
|
||||
Task<CompleteResult> GetCompletionAsync(Reference reference, string argumentName, string argumentValue, CancellationToken cancellationToken = default);
|
||||
|
||||
/// <summary>
|
||||
/// Subscribes to a resource on the server.
|
||||
/// </summary>
|
||||
|
|
|
|||
|
|
@ -264,6 +264,39 @@ internal class McpClient : IMcpClient
|
|||
).ConfigureAwait(false);
|
||||
}
|
||||
|
||||
/// <inheritdoc/>
|
||||
public async Task<CompleteResult> GetCompletionAsync(Reference reference, string argumentName, string argumentValue, CancellationToken cancellationToken = default)
|
||||
{
|
||||
if (!reference.Validate(out string validationMessage))
|
||||
{
|
||||
_logger.InvalidCompletionReference(_serverConfig.Id, _serverConfig.Name, reference.ToString(), validationMessage);
|
||||
throw new McpClientException($"Invalid reference: {validationMessage}");
|
||||
}
|
||||
if (string.IsNullOrWhiteSpace(argumentName))
|
||||
{
|
||||
_logger.InvalidCompletionArgumentName(_serverConfig.Id, _serverConfig.Name, argumentName);
|
||||
throw new McpClientException("Argument name cannot be null or empty");
|
||||
}
|
||||
if (argumentValue is null)
|
||||
{
|
||||
_logger.InvalidCompletionArgumentValue(_serverConfig.Id, _serverConfig.Name, argumentValue);
|
||||
throw new McpClientException("Argument value cannot be null");
|
||||
}
|
||||
|
||||
_logger.GettingCompletion(_serverConfig.Id, _serverConfig.Name, reference.ToString(), argumentName, argumentValue);
|
||||
return await SendRequestAsync<CompleteResult>(
|
||||
new JsonRpcRequest
|
||||
{
|
||||
Method = "completion/complete",
|
||||
Params = new Dictionary<string, object?>
|
||||
{
|
||||
["ref"] = reference,
|
||||
["argument"] = new Argument { Name = argumentName, Value = argumentValue }
|
||||
}
|
||||
},
|
||||
cancellationToken
|
||||
).ConfigureAwait(false);
|
||||
}
|
||||
|
||||
/// <inheritdoc/>
|
||||
public async Task SubscribeToResourceAsync(string uri, CancellationToken cancellationToken = default)
|
||||
|
|
|
|||
|
|
@ -322,4 +322,55 @@ internal static partial class Log
|
|||
string serverName,
|
||||
string data,
|
||||
Exception exception);
|
||||
|
||||
// trace _logger.InvalidCompletionReference(_serverConfig.Id, _serverConfig.Name, reference, validationMessage);
|
||||
[LoggerMessage(
|
||||
EventId = 7004,
|
||||
Level = LogLevel.Trace,
|
||||
Message = "Invalid completion reference {reference} for server {serverId} ({serverName}): {validationMessage}"
|
||||
)]
|
||||
public static partial void InvalidCompletionReference(
|
||||
this ILogger logger,
|
||||
string serverId,
|
||||
string serverName,
|
||||
string reference,
|
||||
string validationMessage);
|
||||
|
||||
// trace _logger.InvalidACompletionArgumentName(_serverConfig.Id, _serverConfig.Name, argumentName);
|
||||
[LoggerMessage(
|
||||
EventId = 7005,
|
||||
Level = LogLevel.Trace,
|
||||
Message = "Invalid completion argument name {argumentName} for server {serverId} ({serverName})"
|
||||
)]
|
||||
public static partial void InvalidCompletionArgumentName(
|
||||
this ILogger logger,
|
||||
string serverId,
|
||||
string serverName,
|
||||
string argumentName);
|
||||
|
||||
// trace _logger.InvalidCompletionArgumentValue(_serverConfig.Id, _serverConfig.Name, argumentValue);
|
||||
[LoggerMessage(
|
||||
EventId = 7006,
|
||||
Level = LogLevel.Trace,
|
||||
Message = "Invalid completion argument value {argumentValue} for server {serverId} ({serverName})"
|
||||
)]
|
||||
public static partial void InvalidCompletionArgumentValue(
|
||||
this ILogger logger,
|
||||
string serverId,
|
||||
string serverName,
|
||||
string argumentValue);
|
||||
|
||||
// debug _logger.GettingCompletion(_serverConfig.Id, _serverConfig.Name, reference, argumentName, argumentValue);
|
||||
[LoggerMessage(
|
||||
EventId = 7007,
|
||||
Level = LogLevel.Debug,
|
||||
Message = "Getting completion for server {serverId} ({serverName}) with reference {reference}, argument name {argumentName}, argument value {argumentValue}"
|
||||
)]
|
||||
public static partial void GettingCompletion(
|
||||
this ILogger logger,
|
||||
string serverId,
|
||||
string serverName,
|
||||
string reference,
|
||||
string argumentName,
|
||||
string argumentValue);
|
||||
}
|
||||
15
src/mcpdotnet/Protocol/Types/Argument.cs
Normal file
15
src/mcpdotnet/Protocol/Types/Argument.cs
Normal file
|
|
@ -0,0 +1,15 @@
|
|||
using System.Text.Json.Serialization;
|
||||
|
||||
namespace McpDotNet.Protocol.Types;
|
||||
|
||||
/// <summary>
|
||||
/// Used for completion requests to provide additional context for the completion options.
|
||||
/// </summary>
|
||||
public class Argument
|
||||
{
|
||||
[JsonPropertyName("name")]
|
||||
public string Name { get; set; } = string.Empty;
|
||||
|
||||
[JsonPropertyName("value")]
|
||||
public string Value { get; set; } = string.Empty;
|
||||
}
|
||||
27
src/mcpdotnet/Protocol/Types/Completion.cs
Normal file
27
src/mcpdotnet/Protocol/Types/Completion.cs
Normal file
|
|
@ -0,0 +1,27 @@
|
|||
using System.Text.Json.Serialization;
|
||||
|
||||
namespace McpDotNet.Protocol.Types;
|
||||
|
||||
/// <summary>
|
||||
/// Represents a completion object in the server's response.
|
||||
/// </summary>
|
||||
public class Completion
|
||||
{
|
||||
/// <summary>
|
||||
/// An array of completion values. Must not exceed 100 items.
|
||||
/// </summary>
|
||||
[JsonPropertyName("values")]
|
||||
public string[] Values { get; set; } = new string[0];
|
||||
|
||||
/// <summary>
|
||||
/// The total number of completion options available. This can exceed the number of values actually sent in the response.
|
||||
/// </summary>
|
||||
[JsonPropertyName("total")]
|
||||
public int? Total { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Indicates whether there are additional completion options beyond those provided in the current response, even if the exact total is unknown.
|
||||
/// </summary>
|
||||
[JsonPropertyName("hasMore")]
|
||||
public bool? HasMore { get; set; }
|
||||
}
|
||||
69
src/mcpdotnet/Protocol/Types/Reference.cs
Normal file
69
src/mcpdotnet/Protocol/Types/Reference.cs
Normal file
|
|
@ -0,0 +1,69 @@
|
|||
using System.Text.Json.Serialization;
|
||||
|
||||
namespace McpDotNet.Protocol.Types;
|
||||
|
||||
/// <summary>
|
||||
/// Represents a reference to a resource or prompt. Umbrella type for both ResourceReference and PromptReference from the spec schema.
|
||||
/// </summary>
|
||||
public class Reference
|
||||
{
|
||||
/// <summary>
|
||||
/// The type of content. Can be ref/resource or ref/prompt.
|
||||
/// </summary>
|
||||
[JsonPropertyName("type")]
|
||||
public string Type { get; set; } = string.Empty;
|
||||
|
||||
[JsonPropertyName("uri")]
|
||||
public string? Uri { get; set; }
|
||||
|
||||
[JsonPropertyName("name")]
|
||||
public string? Name { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Returns a string representation of the reference.
|
||||
/// </summary>
|
||||
public override string ToString()
|
||||
{
|
||||
return $"\"{Type}\": \"{Uri ?? Name}\"";
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Validates the reference object.
|
||||
/// </summary>
|
||||
public bool Validate(out string validationMessage)
|
||||
{
|
||||
if (Type == "ref/resource")
|
||||
{
|
||||
if (string.IsNullOrEmpty(Uri))
|
||||
{
|
||||
validationMessage = "Uri is required for ref/resource";
|
||||
return false;
|
||||
}
|
||||
}
|
||||
else if (Type == "ref/prompt")
|
||||
{
|
||||
if (string.IsNullOrEmpty(Name))
|
||||
{
|
||||
validationMessage = "Name is required for ref/prompt";
|
||||
return false;
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
validationMessage = $"Unknown reference type: {Type}";
|
||||
return false;
|
||||
}
|
||||
|
||||
validationMessage = string.Empty;
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// The server's response to a completion/complete request
|
||||
/// </summary>
|
||||
public class CompleteResult
|
||||
{
|
||||
[JsonPropertyName("completion")]
|
||||
public Completion Completion { get; set; } = new Completion();
|
||||
}
|
||||
|
|
@ -9,7 +9,7 @@
|
|||
<PropertyGroup>
|
||||
<!-- license and package properties -->
|
||||
<PackageId>mcpdotnet</PackageId>
|
||||
<Version>0.7.0.1</Version>
|
||||
<Version>0.8.0.1</Version>
|
||||
<Authors>PederHP</Authors>
|
||||
<Description>.NET client library for the Model Context Protocol (MCP)</Description>
|
||||
<PackageProjectUrl>https://github.com/PederHP/mcpdotnet</PackageProjectUrl>
|
||||
|
|
|
|||
Loading…
Reference in a new issue