diff --git a/schema/schema.json b/schema/schema.json index 3d4b69030..a8f6a2834 100644 --- a/schema/schema.json +++ b/schema/schema.json @@ -1106,12 +1106,16 @@ "Resource": { "description": "A known resource that the server is capable of reading.", "properties": { + "description": { + "description": "A description of what this resource represents.\n\nThis 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.", + "type": "string" + }, "mimeType": { "description": "The MIME type of this resource, if known.", "type": "string" }, "name": { - "description": "An optional human-readable name for this resource.\n\nThis can be used by clients to populate UI elements.", + "description": "A human-readable name for this resource.\n\nThis can be used by clients to populate UI elements.", "type": "string" }, "uri": { @@ -1191,7 +1195,7 @@ "description": "A template description for resources available on the server.", "properties": { "description": { - "description": "A human-readable description of what this template is for.", + "description": "A description of what this template is for.\n\nThis 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.", "type": "string" }, "mimeType": { @@ -1199,7 +1203,7 @@ "type": "string" }, "name": { - "description": "A human-readable name for the type of resource this template refers to.", + "description": "A human-readable name for the type of resource this template refers to.\n\nThis can be used by clients to populate UI elements.", "type": "string" }, "uriTemplate": { diff --git a/schema/schema.ts b/schema/schema.ts index dd30d821f..bc85a3b76 100644 --- a/schema/schema.ts +++ b/schema/schema.ts @@ -333,12 +333,19 @@ export interface Resource { uri: string; /** - * An optional human-readable name for this resource. + * A human-readable name for this resource. * * This can be used by clients to populate UI elements. */ name: string; + /** + * 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. + */ + description?: string; + /** * The MIME type of this resource, if known. */ @@ -355,14 +362,21 @@ export interface ResourceTemplate { * @format uri-template */ uriTemplate: string; + /** * A human-readable name for the type of resource this template refers to. + * + * This can be used by clients to populate UI elements. */ name: string; + /** - * A human-readable description of what this template is for. + * A description of what this template is for. + * + * 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. */ description?: string; + /** * The MIME type for all resources that match this template. This should only be included if all resources matching this template have the same type. */