using Microsoft.Extensions.AI; using System.ComponentModel; using System.Diagnostics; using System.Diagnostics.CodeAnalysis; using System.Text.Json; using System.Text.Json.Nodes; using System.Text.Json.Serialization; namespace ModelContextProtocol.Protocol; /// /// Represents content within the Model Context Protocol (MCP). /// /// /// /// The class is a fundamental type in the MCP that can represent different forms of content /// based on the property. Derived types like , , /// and provide the type-specific content. /// /// /// This class is used throughout the MCP for representing content in messages, tool responses, /// and other communication between clients and servers. /// /// /// See the schema for more details. /// /// [JsonConverter(typeof(Converter))] public abstract class ContentBlock { /// Prevent external derivations. private protected ContentBlock() { } /// /// When overridden in a derived class, gets the type of content. /// /// /// This determines the structure of the content object. Valid values include "image", "audio", "text", "resource", and "resource_link". /// [JsonPropertyName("type")] public abstract string Type { get; } /// /// Gets or sets optional annotations for the content. /// /// /// These annotations can be used to specify the intended audience (, , or both) /// and the priority level of the content. Clients can use this information to filter or prioritize content for different roles. /// [JsonPropertyName("annotations")] public Annotations? Annotations { get; set; } /// /// Provides a for . /// /// Provides a polymorphic converter for the class that doesn't require /// setting explicitly. [EditorBrowsable(EditorBrowsableState.Never)] public class Converter : JsonConverter { /// public override ContentBlock? 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? text = null; string? name = null; string? data = null; string? mimeType = null; string? uri = null; string? description = null; long? size = null; ResourceContents? resource = null; Annotations? annotations = null; JsonObject? meta = 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 "text": text = reader.GetString(); break; case "name": name = reader.GetString(); break; case "data": data = reader.GetString(); break; case "mimeType": mimeType = reader.GetString(); break; case "uri": uri = reader.GetString(); break; case "description": description = reader.GetString(); break; case "size": size = reader.GetInt64(); break; case "resource": resource = JsonSerializer.Deserialize(ref reader, McpJsonUtilities.JsonContext.Default.ResourceContents); break; case "annotations": annotations = JsonSerializer.Deserialize(ref reader, McpJsonUtilities.JsonContext.Default.Annotations); break; case "_meta": meta = JsonSerializer.Deserialize(ref reader, McpJsonUtilities.JsonContext.Default.JsonObject); break; default: reader.Skip(); break; } } return type switch { "text" => new TextContentBlock { Text = text ?? throw new JsonException("Text contents must be provided for 'text' type."), Annotations = annotations, Meta = meta, }, "image" => new ImageContentBlock { Data = data ?? throw new JsonException("Image data must be provided for 'image' type."), MimeType = mimeType ?? throw new JsonException("MIME type must be provided for 'image' type."), Annotations = annotations, Meta = meta, }, "audio" => new AudioContentBlock { Data = data ?? throw new JsonException("Audio data must be provided for 'audio' type."), MimeType = mimeType ?? throw new JsonException("MIME type must be provided for 'audio' type."), Annotations = annotations, Meta = meta, }, "resource" => new EmbeddedResourceBlock { Resource = resource ?? throw new JsonException("Resource contents must be provided for 'resource' type."), Annotations = annotations, Meta = meta, }, "resource_link" => new ResourceLinkBlock { Uri = uri ?? throw new JsonException("URI must be provided for 'resource_link' type."), Name = name ?? throw new JsonException("Name must be provided for 'resource_link' type."), Description = description, MimeType = mimeType, Size = size, Annotations = annotations, }, _ => throw new JsonException($"Unknown content type: '{type}'"), }; } /// public override void Write(Utf8JsonWriter writer, ContentBlock value, JsonSerializerOptions options) { if (value is null) { writer.WriteNullValue(); return; } writer.WriteStartObject(); writer.WriteString("type", value.Type); switch (value) { case TextContentBlock textContent: writer.WriteString("text", textContent.Text); if (textContent.Meta is not null) { writer.WritePropertyName("_meta"); JsonSerializer.Serialize(writer, textContent.Meta, McpJsonUtilities.JsonContext.Default.JsonObject); } break; case ImageContentBlock imageContent: writer.WriteString("data", imageContent.Data); writer.WriteString("mimeType", imageContent.MimeType); if (imageContent.Meta is not null) { writer.WritePropertyName("_meta"); JsonSerializer.Serialize(writer, imageContent.Meta, McpJsonUtilities.JsonContext.Default.JsonObject); } break; case AudioContentBlock audioContent: writer.WriteString("data", audioContent.Data); writer.WriteString("mimeType", audioContent.MimeType); if (audioContent.Meta is not null) { writer.WritePropertyName("_meta"); JsonSerializer.Serialize(writer, audioContent.Meta, McpJsonUtilities.JsonContext.Default.JsonObject); } break; case EmbeddedResourceBlock embeddedResource: writer.WritePropertyName("resource"); JsonSerializer.Serialize(writer, embeddedResource.Resource, McpJsonUtilities.JsonContext.Default.ResourceContents); if (embeddedResource.Meta is not null) { writer.WritePropertyName("_meta"); JsonSerializer.Serialize(writer, embeddedResource.Meta, McpJsonUtilities.JsonContext.Default.JsonObject); } break; case ResourceLinkBlock resourceLink: writer.WriteString("uri", resourceLink.Uri); writer.WriteString("name", resourceLink.Name); if (resourceLink.Description is not null) { writer.WriteString("description", resourceLink.Description); } if (resourceLink.MimeType is not null) { writer.WriteString("mimeType", resourceLink.MimeType); } if (resourceLink.Size.HasValue) { writer.WriteNumber("size", resourceLink.Size.Value); } break; } if (value.Annotations is { } annotations) { writer.WritePropertyName("annotations"); JsonSerializer.Serialize(writer, annotations, McpJsonUtilities.JsonContext.Default.Annotations); } writer.WriteEndObject(); } } } /// Represents text provided to or from an LLM. public sealed class TextContentBlock : ContentBlock { /// public override string Type => "text"; /// /// Gets or sets the text content of the message. /// [JsonPropertyName("text")] public required string Text { get; set; } /// /// Gets or sets metadata reserved by MCP for protocol-level metadata. /// /// /// Implementations must not make assumptions about its contents. /// [JsonPropertyName("_meta")] public JsonObject? Meta { get; set; } } /// Represents an image provided to or from an LLM. public sealed class ImageContentBlock : ContentBlock { /// public override string Type => "image"; /// /// Gets or sets the base64-encoded image data. /// [JsonPropertyName("data")] public required string Data { get; set; } /// /// Gets or sets the MIME type (or "media type") of the content, specifying the format of the data. /// /// /// /// Common values include "image/png" and "image/jpeg". /// /// [JsonPropertyName("mimeType")] public required string MimeType { get; set; } /// /// Gets or sets metadata reserved by MCP for protocol-level metadata. /// /// /// Implementations must not make assumptions about its contents. /// [JsonPropertyName("_meta")] public JsonObject? Meta { get; set; } } /// Represents audio provided to or from an LLM. public sealed class AudioContentBlock : ContentBlock { /// public override string Type => "audio"; /// /// Gets or sets the base64-encoded audio data. /// [JsonPropertyName("data")] public required string Data { get; set; } /// /// Gets or sets the MIME type (or "media type") of the content, specifying the format of the data. /// /// /// /// Common values include "audio/wav" and "audio/mp3". /// /// [JsonPropertyName("mimeType")] public required string MimeType { get; set; } /// /// Gets or sets metadata reserved by MCP for protocol-level metadata. /// /// /// Implementations must not make assumptions about its contents. /// [JsonPropertyName("_meta")] public JsonObject? Meta { get; set; } } /// Represents the contents of a resource, embedded into a prompt or tool call result. /// /// It is up to the client how best to render embedded resources for the benefit of the LLM and/or the user. /// public sealed class EmbeddedResourceBlock : ContentBlock { /// public override string Type => "resource"; /// /// Gets or sets the resource content of the message when is "resource". /// /// /// /// Resources can be either text-based () or /// binary (), allowing for flexible data representation. /// Each resource has a URI that can be used for identification and retrieval. /// /// [JsonPropertyName("resource")] public required ResourceContents Resource { get; set; } /// /// Gets or sets metadata reserved by MCP for protocol-level metadata. /// /// /// Implementations must not make assumptions about its contents. /// [JsonPropertyName("_meta")] public JsonObject? Meta { get; set; } } /// Represents a resource that the server is capable of reading, included in a prompt or tool call result. /// /// Resource links returned by tools are not guaranteed to appear in the results of `resources/list` requests. /// public sealed class ResourceLinkBlock : ContentBlock { /// public override string Type => "resource_link"; /// /// Gets or sets the URI of this resource. /// [JsonPropertyName("uri")] [StringSyntax(StringSyntaxAttribute.Uri)] public required string Uri { get; set; } /// /// Gets or sets a human-readable name for this resource. /// [JsonPropertyName("name")] public required string Name { get; set; } /// /// Gets or sets a description of what this resource represents. /// /// /// /// This can be used by clients to improve the LLM's understanding of available resources. It can be thought of like a \"hint\" to the model. /// /// /// The description should provide clear context about the resource's content, format, and purpose. /// This helps AI models make better decisions about when to access or reference the resource. /// /// /// Client applications can also use this description for display purposes in user interfaces /// or to help users understand the available resources. /// /// [JsonPropertyName("description")] public string? Description { get; set; } /// /// Gets or sets the MIME type of this resource. /// /// /// /// specifies the format of the resource content, helping clients to properly interpret and display the data. /// Common MIME types include "text/plain" for plain text, "application/pdf" for PDF documents, /// "image/png" for PNG images, and "application/json" for JSON data. /// /// /// This property may be if the MIME type is unknown or not applicable for the resource. /// /// [JsonPropertyName("mimeType")] public string? MimeType { get; set; } /// /// Gets or sets the size of the raw resource content (before base64 encoding), in bytes, if known. /// /// /// This can be used by applications to display file sizes and estimate context window usage. /// [JsonPropertyName("size")] public long? Size { get; set; } }