Class Resource

Namespace

ModelContextProtocol.Protocol.Types

Assembly

ModelContextProtocol.dll

Represents a known resource that the server is capable of reading. See the schema for details

public record Resource : IEquatable<Resource>

Inheritance

object

Resource

Implements

IEquatable<Resource>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Annotations

Optional annotations for the resource.

[JsonPropertyName("annotations")]
public Annotations? Annotations { get; init; }

Property Value

Annotations

Description

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.

[JsonPropertyName("description")]
public string? Description { get; init; }

Property Value

string

MimeType

The MIME type of this resource, if known.

[JsonPropertyName("mimeType")]
public string? MimeType { get; init; }

Property Value

string

Name

A human-readable name for this resource.

This can be used by clients to populate UI elements.

[JsonPropertyName("name")]
public required string Name { get; init; }

Property Value

string

Size

The size of the raw resource content, in bytes (i.e., before base64 encoding or any tokenization), if known.

This can be used by Hosts to display file sizes and estimate context window usage.

[JsonPropertyName("size")]
public long? Size { get; init; }

Property Value

long?

Uri

The URI of this resource.

[JsonPropertyName("uri")]
public required string Uri { get; init; }

Property Value

string