using ModelContextProtocol.Client;
using System.ComponentModel;
using System.Diagnostics;
using System.Diagnostics.CodeAnalysis;
using System.Text.Json;
using System.Text.Json.Serialization;
namespace ModelContextProtocol.Protocol;
///
/// Represents a reference to a resource or prompt in the Model Context Protocol.
///
///
///
/// References are commonly used with
/// to request completion suggestions for arguments, and with other methods that need to reference resources or prompts.
///
///
/// See the schema for details.
///
///
[JsonConverter(typeof(Converter))]
public abstract class Reference
{
/// Prevent external derivations.
private protected Reference()
{
}
///
/// When overridden in a derived class, gets the type of content.
///
///
/// "ref/resource" or "ref/prompt".
///
[JsonPropertyName("type")]
public abstract string Type { get; }
///
/// Provides a for .
///
///
/// Provides a polymorphic converter for the class that doesn't require
/// setting explicitly.
///
[EditorBrowsable(EditorBrowsableState.Never)]
public sealed class Converter : JsonConverter
{
///
public override Reference? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
{
if (reader.TokenType == JsonTokenType.Null)
{
return null;
}
if (reader.TokenType != JsonTokenType.StartObject)
{
throw new JsonException();
}
string? type = null;
string? name = null;
string? title = null;
string? uri = null;
while (reader.Read() && reader.TokenType != JsonTokenType.EndObject)
{
if (reader.TokenType != JsonTokenType.PropertyName)
{
continue;
}
string? propertyName = reader.GetString();
bool success = reader.Read();
Debug.Assert(success, "STJ must have buffered the entire object for us.");
switch (propertyName)
{
case "type":
type = reader.GetString();
break;
case "name":
name = reader.GetString();
break;
case "title":
title = reader.GetString();
break;
case "uri":
uri = reader.GetString();
break;
default:
reader.Skip();
break;
}
}
switch (type)
{
case "ref/prompt":
if (name is null)
{
throw new JsonException("Prompt references must have a 'name' property.");
}
return new PromptReference { Name = name, Title = title };
case "ref/resource":
if (uri is null)
{
throw new JsonException("Resource references must have a 'uri' property.");
}
return new ResourceTemplateReference { Uri = uri };
default:
throw new JsonException($"Unknown content type: '{type}'");
}
}
///
public override void Write(Utf8JsonWriter writer, Reference value, JsonSerializerOptions options)
{
if (value is null)
{
writer.WriteNullValue();
return;
}
writer.WriteStartObject();
writer.WriteString("type", value.Type);
switch (value)
{
case PromptReference pr:
writer.WriteString("name", pr.Name);
if (pr.Title is not null)
{
writer.WriteString("title", pr.Title);
}
break;
case ResourceTemplateReference rtr:
writer.WriteString("uri", rtr.Uri);
break;
}
writer.WriteEndObject();
}
}
}
///
/// Represents a reference to a prompt, identified by its name.
///
public sealed class PromptReference : Reference, IBaseMetadata
{
///
public override string Type => "ref/prompt";
///
[JsonPropertyName("name")]
public required string Name { get; set; }
///
[JsonPropertyName("title")]
public string? Title { get; set; }
///
public override string ToString() => $"\"{Type}\": \"{Name}\"";
}
///
/// Represents a reference to a resource or resource template definition.
///
public sealed class ResourceTemplateReference : Reference
{
///
public override string Type => "ref/resource";
///
/// Gets or sets the URI or URI template of the resource.
///
[JsonPropertyName("uri")]
[StringSyntax(StringSyntaxAttribute.Uri)]
public required string? Uri { get; set; }
///
public override string ToString() => $"\"{Type}\": \"{Uri}\"";
}