Spaces:
Sleeping
Sleeping
| # Schema Reference | |
| Source: https://modelcontextprotocol.io/specification/2025-11-25/schema | |
| <div /> | |
| ## JSON-RPC | |
| <div> | |
| ### `JSONRPCErrorResponse` | |
| <div><span>interface</span> <span>JSONRPCErrorResponse</span> <span>\{</span><br /> <a href="#jsonrpcerrorresponse-jsonrpc">jsonrpc</a><span>:</span> <span>"2.0"</span><span>;</span><br /> <a href="#jsonrpcerrorresponse-id">id</a><span>?:</span> <a href="#requestid">RequestId</a><span>;</span><br /> <a href="#jsonrpcerrorresponse-error">error</a><span>:</span> <a href="#error">Error</a><span>;</span><br /><span>}</span></div><div><p>A response to a request that indicates an error occurred.</p> </div><section><div><span>jsonrpc: "2.0"</span><a href="#jsonrpcerrorresponse-jsonrpc" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section><div><span>id?: RequestId</span><a href="#jsonrpcerrorresponse-id" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section><div><span>error: Error</span><a href="#jsonrpcerrorresponse-error" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section> | |
| </div> | |
| <div> | |
| ### `JSONRPCMessage` | |
| <div><span>JSONRPCMessage</span><span>:</span> <a href="#jsonrpcrequest">JSONRPCRequest</a> <span>|</span> <a href="#jsonrpcnotification">JSONRPCNotification</a> <span>|</span> <a href="#jsonrpcresponse">JSONRPCResponse</a></div><div><p>Refers to any valid JSON-RPC object that can be decoded off the wire, or encoded to be sent.</p> </div> | |
| </div> | |
| <div> | |
| ### `JSONRPCNotification` | |
| <div><span>interface</span> <span>JSONRPCNotification</span> <span>\{</span><br /> <a href="#jsonrpcnotification-method">method</a><span>:</span> <span>string</span><span>;</span><br /> <a href="#jsonrpcnotification-params">params</a><span>?:</span> <span>\{</span> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>any</span> <span>}</span><span>;</span><br /> <a href="#jsonrpcnotification-jsonrpc">jsonrpc</a><span>:</span> <span>"2.0"</span><span>;</span><br /><span>}</span></div><div><p>A notification which does not expect a response.</p> </div><section><div><span>method: string</span><a href="#jsonrpcnotification-method" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Inherited from Notification.method</p></aside></section><section><div><span>params?: \{ \[key: string]: any }</span><a href="#jsonrpcnotification-params" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Inherited from Notification.params</p></aside></section><section><div><span>jsonrpc: "2.0"</span><a href="#jsonrpcnotification-jsonrpc" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section> | |
| </div> | |
| <div> | |
| ### `JSONRPCRequest` | |
| <div><span>interface</span> <span>JSONRPCRequest</span> <span>\{</span><br /> <a href="#jsonrpcrequest-method">method</a><span>:</span> <span>string</span><span>;</span><br /> <a href="#jsonrpcrequest-params">params</a><span>?:</span> <span>\{</span> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>any</span> <span>}</span><span>;</span><br /> <a href="#jsonrpcrequest-jsonrpc">jsonrpc</a><span>:</span> <span>"2.0"</span><span>;</span><br /> <a href="#jsonrpcrequest-id">id</a><span>:</span> <a href="#requestid">RequestId</a><span>;</span><br /><span>}</span></div><div><p>A request that expects a response.</p> </div><section><div><span>method: string</span><a href="#jsonrpcrequest-method" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Inherited from Request.method</p></aside></section><section><div><span>params?: \{ \[key: string]: any }</span><a href="#jsonrpcrequest-params" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Inherited from Request.params</p></aside></section><section><div><span>jsonrpc: "2.0"</span><a href="#jsonrpcrequest-jsonrpc" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section><div><span>id: RequestId</span><a href="#jsonrpcrequest-id" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section> | |
| </div> | |
| <div> | |
| ### `JSONRPCResultResponse` | |
| <div><span>interface</span> <span>JSONRPCResultResponse</span> <span>\{</span><br /> <a href="#jsonrpcresultresponse-jsonrpc">jsonrpc</a><span>:</span> <span>"2.0"</span><span>;</span><br /> <a href="#jsonrpcresultresponse-id">id</a><span>:</span> <a href="#requestid">RequestId</a><span>;</span><br /> <a href="#jsonrpcresultresponse-result">result</a><span>:</span> <a href="#result">Result</a><span>;</span><br /><span>}</span></div><div><p>A successful (non-error) response to a request.</p> </div><section><div><span>jsonrpc: "2.0"</span><a href="#jsonrpcresultresponse-jsonrpc" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section><div><span>id: RequestId</span><a href="#jsonrpcresultresponse-id" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section><div><span>result: Result</span><a href="#jsonrpcresultresponse-result" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section> | |
| </div> | |
| ## Common Types | |
| <div> | |
| ### `Annotations` | |
| <div><span>interface</span> <span>Annotations</span> <span>\{</span><br /> <a href="#annotations-audience">audience</a><span>?:</span> <a href="#role">Role</a><span>\[]</span><span>;</span><br /> <a href="#annotations-priority">priority</a><span>?:</span> <span>number</span><span>;</span><br /> <a href="#annotations-lastmodified">lastModified</a><span>?:</span> <span>string</span><span>;</span><br /><span>}</span></div><div><p>Optional annotations for the client. The client can use annotations to inform how objects are used or displayed</p> </div><section><div><span>audience?: Role\[]</span><a href="#annotations-audience" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Describes who the intended audience of this object or data is.</p> <p>It can include multiple entries to indicate content useful for multiple audiences (e.g., <code>\["user", "assistant"]</code>).</p> </div></section><section><div><span>priority?: number</span><a href="#annotations-priority" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Describes how important this data is for operating the server.</p> <p>A value of 1 means "most important," and indicates that the data is | |
| effectively required, while 0 means "least important," and indicates that | |
| the data is entirely optional.</p> </div></section><section><div><span>lastModified?: string</span><a href="#annotations-lastmodified" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>The moment the resource was last modified, as an ISO 8601 formatted string.</p> <p>Should be an ISO 8601 formatted string (e.g., "2025-01-12T15:00:58Z").</p> <p>Examples: last activity timestamp in an open file, timestamp when the resource | |
| was attached, etc.</p> </div></section> | |
| </div> | |
| <div> | |
| ### `Cursor` | |
| <div><span>Cursor</span><span>:</span> <span>string</span></div><div><p>An opaque token used to represent a cursor for pagination.</p> </div> | |
| </div> | |
| <div> | |
| ### `EmptyResult` | |
| <div><span>EmptyResult</span><span>:</span> <a href="#result">Result</a></div><div><p>A response that indicates success but carries no data.</p> </div> | |
| </div> | |
| <div> | |
| ### `Error` | |
| <div><span>interface</span> <span>Error</span> <span>\{</span><br /> <a href="#error-code">code</a><span>:</span> <span>number</span><span>;</span><br /> <a href="#error-message">message</a><span>:</span> <span>string</span><span>;</span><br /> <a href="#error-data">data</a><span>?:</span> <span>unknown</span><span>;</span><br /><span>}</span></div><section><div><span>code: number</span><a href="#error-code" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>The error type that occurred.</p> </div></section><section><div><span>message: string</span><a href="#error-message" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>A short description of the error. The message SHOULD be limited to a concise single sentence.</p> </div></section><section><div><span>data?: unknown</span><a href="#error-data" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Additional information about the error. The value of this member is defined by the sender (e.g. detailed error information, nested errors etc.).</p> </div></section> | |
| </div> | |
| <div> | |
| ### `Icon` | |
| <div><span>interface</span> <span>Icon</span> <span>\{</span><br /> <a href="#icon-src">src</a><span>:</span> <span>string</span><span>;</span><br /> <a href="#icon-mimetype">mimeType</a><span>?:</span> <span>string</span><span>;</span><br /> <a href="#icon-sizes">sizes</a><span>?:</span> <span>string</span><span>\[]</span><span>;</span><br /> <a href="#icon-theme">theme</a><span>?:</span> <span>"light"</span> <span>|</span> <span>"dark"</span><span>;</span><br /><span>}</span></div><div><p>An optionally-sized icon that can be displayed in a user interface.</p> </div><section><div><span>src: string</span><a href="#icon-src" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>A standard URI pointing to an icon resource. May be an HTTP/HTTPS URL or a <code>data:</code> URI with Base64-encoded image data.</p> <p>Consumers SHOULD takes steps to ensure URLs serving icons are from the | |
| same domain as the client/server or a trusted domain.</p> <p>Consumers SHOULD take appropriate precautions when consuming SVGs as they can contain | |
| executable JavaScript.</p> </div></section><section><div><span>mimeType?: string</span><a href="#icon-mimetype" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Optional MIME type override if the source MIME type is missing or generic. | |
| For example: <code>"image/png"</code>, <code>"image/jpeg"</code>, or <code>"image/svg+xml"</code>.</p> </div></section><section><div><span>sizes?: string\[]</span><a href="#icon-sizes" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Optional array of strings that specify sizes at which the icon can be used. | |
| Each string should be in WxH format (e.g., <code>"48x48"</code>, <code>"96x96"</code>) or <code>"any"</code> for scalable formats like SVG.</p> <p>If not provided, the client should assume that the icon can be used at any size.</p> </div></section><section><div><span>theme?: "light" | "dark"</span><a href="#icon-theme" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Optional specifier for the theme this icon is designed for. <code>light</code> indicates | |
| the icon is designed to be used with a light background, and <code>dark</code> indicates | |
| the icon is designed to be used with a dark background.</p> <p>If not provided, the client should assume the icon can be used with any theme.</p> </div></section> | |
| </div> | |
| <div> | |
| ### `LoggingLevel` | |
| <div><span>LoggingLevel</span><span>:</span><br /> <span>|</span> <span>"debug"</span><br /> <span>|</span> <span>"info"</span><br /> <span>|</span> <span>"notice"</span><br /> <span>|</span> <span>"warning"</span><br /> <span>|</span> <span>"error"</span><br /> <span>|</span> <span>"critical"</span><br /> <span>|</span> <span>"alert"</span><br /> <span>|</span> <span>"emergency"</span></div><div><p>The severity of a log message.</p> <p>These map to syslog message severities, as specified in RFC-5424: <a href="https://datatracker.ietf.org/doc/html/rfc5424#section-6.2.1">[https://datatracker.ietf.org/doc/html/rfc5424#section-6.2.1](https://datatracker.ietf.org/doc/html/rfc5424#section-6.2.1)</a></p> </div> | |
| </div> | |
| <div> | |
| ### `ProgressToken` | |
| <div><span>ProgressToken</span><span>:</span> <span>string</span> <span>|</span> <span>number</span></div><div><p>A progress token, used to associate progress notifications with the original request.</p> </div> | |
| </div> | |
| <div> | |
| ### `RequestId` | |
| <div><span>RequestId</span><span>:</span> <span>string</span> <span>|</span> <span>number</span></div><div><p>A uniquely identifying ID for a request in JSON-RPC.</p> </div> | |
| </div> | |
| <div> | |
| ### `Result` | |
| <div><span>interface</span> <span>Result</span> <span>\{</span><br /> <a href="#result-_meta">\_meta</a><span>?:</span> <span>\{</span> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>unknown</span> <span>}</span><span>;</span><br /> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>unknown</span><span>;</span><br /><span>}</span></div><section><div><span>\_meta?: \{ \[key: string]: unknown }</span><a href="#result-_meta" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>See <a href="/specification/2025-11-25/basic/index#meta">General fields: <code>\_meta</code></a> for notes on <code>\_meta</code> usage.</p> </div></section> | |
| </div> | |
| <div> | |
| ### `Role` | |
| <div><span>Role</span><span>:</span> <span>"user"</span> <span>|</span> <span>"assistant"</span></div><div><p>The sender or recipient of messages and data in a conversation.</p> </div> | |
| </div> | |
| ## Content | |
| <div> | |
| ### `AudioContent` | |
| <div><span>interface</span> <span>AudioContent</span> <span>\{</span><br /> <a href="#audiocontent-type">type</a><span>:</span> <span>"audio"</span><span>;</span><br /> <a href="#audiocontent-data">data</a><span>:</span> <span>string</span><span>;</span><br /> <a href="#audiocontent-mimetype">mimeType</a><span>:</span> <span>string</span><span>;</span><br /> <a href="#audiocontent-annotations">annotations</a><span>?:</span> <a href="#annotations">Annotations</a><span>;</span><br /> <a href="#audiocontent-_meta">\_meta</a><span>?:</span> <span>\{</span> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>unknown</span> <span>}</span><span>;</span><br /><span>}</span></div><div><p>Audio provided to or from an LLM.</p> </div><section><div><span>type: "audio"</span><a href="#audiocontent-type" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section><div><span>data: string</span><a href="#audiocontent-data" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>The base64-encoded audio data.</p> </div></section><section><div><span>mimeType: string</span><a href="#audiocontent-mimetype" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>The MIME type of the audio. Different providers may support different audio types.</p> </div></section><section><div><span>annotations?: Annotations</span><a href="#audiocontent-annotations" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Optional annotations for the client.</p> </div></section><section><div><span>\_meta?: \{ \[key: string]: unknown }</span><a href="#audiocontent-_meta" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>See <a href="/specification/2025-11-25/basic/index#meta">General fields: <code>\_meta</code></a> for notes on <code>\_meta</code> usage.</p> </div></section> | |
| </div> | |
| <div> | |
| ### `BlobResourceContents` | |
| <div><span>interface</span> <span>BlobResourceContents</span> <span>\{</span><br /> <a href="#blobresourcecontents-uri">uri</a><span>:</span> <span>string</span><span>;</span><br /> <a href="#blobresourcecontents-mimetype">mimeType</a><span>?:</span> <span>string</span><span>;</span><br /> <a href="#blobresourcecontents-_meta">\_meta</a><span>?:</span> <span>\{</span> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>unknown</span> <span>}</span><span>;</span><br /> <a href="#blobresourcecontents-blob">blob</a><span>:</span> <span>string</span><span>;</span><br /><span>}</span></div><section><div><span>uri: string</span><a href="#blobresourcecontents-uri" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>The URI of this resource.</p> </div><aside><p>Inherited from ResourceContents.uri</p></aside></section><section><div><span>mimeType?: string</span><a href="#blobresourcecontents-mimetype" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>The MIME type of this resource, if known.</p> </div><aside><p>Inherited from ResourceContents.mimeType</p></aside></section><section><div><span>\_meta?: \{ \[key: string]: unknown }</span><a href="#blobresourcecontents-_meta" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>See <a href="/specification/2025-11-25/basic/index#meta">General fields: <code>\_meta</code></a> for notes on <code>\_meta</code> usage.</p> </div><aside><p>Inherited from ResourceContents.\_meta</p></aside></section><section><div><span>blob: string</span><a href="#blobresourcecontents-blob" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>A base64-encoded string representing the binary data of the item.</p> </div></section> | |
| </div> | |
| <div> | |
| ### `ContentBlock` | |
| <div><span>ContentBlock</span><span>:</span><br /> <span>|</span> <a href="#textcontent">TextContent</a><br /> <span>|</span> <a href="#imagecontent">ImageContent</a><br /> <span>|</span> <a href="#audiocontent">AudioContent</a><br /> <span>|</span> <a href="#resourcelink">ResourceLink</a><br /> <span>|</span> <a href="#embeddedresource">EmbeddedResource</a></div> | |
| </div> | |
| <div> | |
| ### `EmbeddedResource` | |
| <div><span>interface</span> <span>EmbeddedResource</span> <span>\{</span><br /> <a href="#embeddedresource-type">type</a><span>:</span> <span>"resource"</span><span>;</span><br /> <a href="#embeddedresource-resource">resource</a><span>:</span> <a href="#textresourcecontents">TextResourceContents</a> <span>|</span> <a href="#blobresourcecontents">BlobResourceContents</a><span>;</span><br /> <a href="#embeddedresource-annotations">annotations</a><span>?:</span> <a href="#annotations">Annotations</a><span>;</span><br /> <a href="#embeddedresource-_meta">\_meta</a><span>?:</span> <span>\{</span> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>unknown</span> <span>}</span><span>;</span><br /><span>}</span></div><div><p>The contents of a resource, embedded into a prompt or tool call result.</p> <p>It is up to the client how best to render embedded resources for the benefit | |
| of the LLM and/or the user.</p> </div><section><div><span>type: "resource"</span><a href="#embeddedresource-type" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section><div><span>resource: TextResourceContents | BlobResourceContents</span><a href="#embeddedresource-resource" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section><div><span>annotations?: Annotations</span><a href="#embeddedresource-annotations" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Optional annotations for the client.</p> </div></section><section><div><span>\_meta?: \{ \[key: string]: unknown }</span><a href="#embeddedresource-_meta" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>See <a href="/specification/2025-11-25/basic/index#meta">General fields: <code>\_meta</code></a> for notes on <code>\_meta</code> usage.</p> </div></section> | |
| </div> | |
| <div> | |
| ### `ImageContent` | |
| <div><span>interface</span> <span>ImageContent</span> <span>\{</span><br /> <a href="#imagecontent-type">type</a><span>:</span> <span>"image"</span><span>;</span><br /> <a href="#imagecontent-data">data</a><span>:</span> <span>string</span><span>;</span><br /> <a href="#imagecontent-mimetype">mimeType</a><span>:</span> <span>string</span><span>;</span><br /> <a href="#imagecontent-annotations">annotations</a><span>?:</span> <a href="#annotations">Annotations</a><span>;</span><br /> <a href="#imagecontent-_meta">\_meta</a><span>?:</span> <span>\{</span> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>unknown</span> <span>}</span><span>;</span><br /><span>}</span></div><div><p>An image provided to or from an LLM.</p> </div><section><div><span>type: "image"</span><a href="#imagecontent-type" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section><div><span>data: string</span><a href="#imagecontent-data" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>The base64-encoded image data.</p> </div></section><section><div><span>mimeType: string</span><a href="#imagecontent-mimetype" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>The MIME type of the image. Different providers may support different image types.</p> </div></section><section><div><span>annotations?: Annotations</span><a href="#imagecontent-annotations" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Optional annotations for the client.</p> </div></section><section><div><span>\_meta?: \{ \[key: string]: unknown }</span><a href="#imagecontent-_meta" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>See <a href="/specification/2025-11-25/basic/index#meta">General fields: <code>\_meta</code></a> for notes on <code>\_meta</code> usage.</p> </div></section> | |
| </div> | |
| <div> | |
| ### `ResourceLink` | |
| <div><span>interface</span> <span>ResourceLink</span> <span>\{</span><br /> <a href="#resourcelink-icons">icons</a><span>?:</span> <a href="#icon">Icon</a><span>\[]</span><span>;</span><br /> <a href="#resourcelink-name">name</a><span>:</span> <span>string</span><span>;</span><br /> <a href="#resourcelink-title">title</a><span>?:</span> <span>string</span><span>;</span><br /> <a href="#resourcelink-uri">uri</a><span>:</span> <span>string</span><span>;</span><br /> <a href="#resourcelink-description">description</a><span>?:</span> <span>string</span><span>;</span><br /> <a href="#resourcelink-mimetype">mimeType</a><span>?:</span> <span>string</span><span>;</span><br /> <a href="#resourcelink-annotations">annotations</a><span>?:</span> <a href="#annotations">Annotations</a><span>;</span><br /> <a href="#resourcelink-size">size</a><span>?:</span> <span>number</span><span>;</span><br /> <a href="#resourcelink-_meta">\_meta</a><span>?:</span> <span>\{</span> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>unknown</span> <span>}</span><span>;</span><br /> <a href="#resourcelink-type">type</a><span>:</span> <span>"resource\_link"</span><span>;</span><br /><span>}</span></div><div><p>A resource that the server is capable of reading, included in a prompt or tool call result.</p> <p>Note: resource links returned by tools are not guaranteed to appear in the results of <code>resources/list</code> requests.</p> </div><section><div><span>icons?: Icon\[]</span><a href="#resourcelink-icons" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Optional set of sized icons that the client can display in a user interface.</p> <p>Clients that support rendering icons MUST support at least the following MIME types:</p> <ul> <li><code>image/png</code> - PNG images (safe, universal compatibility)</li> <li><code>image/jpeg</code> (and <code>image/jpg</code>) - JPEG images (safe, universal compatibility)</li> </ul> <p>Clients that support rendering icons SHOULD also support:</p> <ul> <li><code>image/svg+xml</code> - SVG images (scalable but requires security precautions)</li> <li><code>image/webp</code> - WebP images (modern, efficient format)</li> </ul> </div><aside><p>Inherited from <a href="#resource">Resource</a>.<a href="#resource-icons">icons</a></p></aside></section><section><div><span>name: string</span><a href="#resourcelink-name" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Intended for programmatic or logical use, but used as a display name in past specs or fallback (if title isn't present).</p> </div><aside><p>Inherited from <a href="#resource">Resource</a>.<a href="#resource-name">name</a></p></aside></section><section><div><span>title?: string</span><a href="#resourcelink-title" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Intended for UI and end-user contexts — optimized to be human-readable and easily understood, | |
| even by those unfamiliar with domain-specific terminology.</p> <p>If not provided, the name should be used for display (except for Tool, | |
| where <code>annotations.title</code> should be given precedence over using <code>name</code>, | |
| if present).</p> </div><aside><p>Inherited from <a href="#resource">Resource</a>.<a href="#resource-title">title</a></p></aside></section><section><div><span>uri: string</span><a href="#resourcelink-uri" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>The URI of this resource.</p> </div><aside><p>Inherited from <a href="#resource">Resource</a>.<a href="#resource-uri">uri</a></p></aside></section><section><div><span>description?: string</span><a href="#resourcelink-description" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>A description of what this resource represents.</p> <p>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.</p> </div><aside><p>Inherited from <a href="#resource">Resource</a>.<a href="#resource-description">description</a></p></aside></section><section><div><span>mimeType?: string</span><a href="#resourcelink-mimetype" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>The MIME type of this resource, if known.</p> </div><aside><p>Inherited from <a href="#resource">Resource</a>.<a href="#resource-mimetype">mimeType</a></p></aside></section><section><div><span>annotations?: Annotations</span><a href="#resourcelink-annotations" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Optional annotations for the client.</p> </div><aside><p>Inherited from <a href="#resource">Resource</a>.<a href="#resource-annotations">annotations</a></p></aside></section><section><div><span>size?: number</span><a href="#resourcelink-size" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>The size of the raw resource content, in bytes (i.e., before base64 encoding or any tokenization), if known.</p> <p>This can be used by Hosts to display file sizes and estimate context window usage.</p> </div><aside><p>Inherited from <a href="#resource">Resource</a>.<a href="#resource-size">size</a></p></aside></section><section><div><span>\_meta?: \{ \[key: string]: unknown }</span><a href="#resourcelink-_meta" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>See <a href="/specification/2025-11-25/basic/index#meta">General fields: <code>\_meta</code></a> for notes on <code>\_meta</code> usage.</p> </div><aside><p>Inherited from <a href="#resource">Resource</a>.<a href="#resource-_meta">\_meta</a></p></aside></section><section><div><span>type: "resource\_link"</span><a href="#resourcelink-type" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section> | |
| </div> | |
| <div> | |
| ### `TextContent` | |
| <div><span>interface</span> <span>TextContent</span> <span>\{</span><br /> <a href="#textcontent-type">type</a><span>:</span> <span>"text"</span><span>;</span><br /> <a href="#textcontent-text">text</a><span>:</span> <span>string</span><span>;</span><br /> <a href="#textcontent-annotations">annotations</a><span>?:</span> <a href="#annotations">Annotations</a><span>;</span><br /> <a href="#textcontent-_meta">\_meta</a><span>?:</span> <span>\{</span> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>unknown</span> <span>}</span><span>;</span><br /><span>}</span></div><div><p>Text provided to or from an LLM.</p> </div><section><div><span>type: "text"</span><a href="#textcontent-type" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section><div><span>text: string</span><a href="#textcontent-text" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>The text content of the message.</p> </div></section><section><div><span>annotations?: Annotations</span><a href="#textcontent-annotations" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Optional annotations for the client.</p> </div></section><section><div><span>\_meta?: \{ \[key: string]: unknown }</span><a href="#textcontent-_meta" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>See <a href="/specification/2025-11-25/basic/index#meta">General fields: <code>\_meta</code></a> for notes on <code>\_meta</code> usage.</p> </div></section> | |
| </div> | |
| <div> | |
| ### `TextResourceContents` | |
| <div><span>interface</span> <span>TextResourceContents</span> <span>\{</span><br /> <a href="#textresourcecontents-uri">uri</a><span>:</span> <span>string</span><span>;</span><br /> <a href="#textresourcecontents-mimetype">mimeType</a><span>?:</span> <span>string</span><span>;</span><br /> <a href="#textresourcecontents-_meta">\_meta</a><span>?:</span> <span>\{</span> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>unknown</span> <span>}</span><span>;</span><br /> <a href="#textresourcecontents-text">text</a><span>:</span> <span>string</span><span>;</span><br /><span>}</span></div><section><div><span>uri: string</span><a href="#textresourcecontents-uri" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>The URI of this resource.</p> </div><aside><p>Inherited from ResourceContents.uri</p></aside></section><section><div><span>mimeType?: string</span><a href="#textresourcecontents-mimetype" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>The MIME type of this resource, if known.</p> </div><aside><p>Inherited from ResourceContents.mimeType</p></aside></section><section><div><span>\_meta?: \{ \[key: string]: unknown }</span><a href="#textresourcecontents-_meta" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>See <a href="/specification/2025-11-25/basic/index#meta">General fields: <code>\_meta</code></a> for notes on <code>\_meta</code> usage.</p> </div><aside><p>Inherited from ResourceContents.\_meta</p></aside></section><section><div><span>text: string</span><a href="#textresourcecontents-text" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>The text of the item. This must only be set if the item can actually be represented as text (not binary data).</p> </div></section> | |
| </div> | |
| ## `completion/complete` | |
| <div> | |
| ### `CompleteRequest` | |
| <div><span>interface</span> <span>CompleteRequest</span> <span>\{</span><br /> <a href="#completerequest-jsonrpc">jsonrpc</a><span>:</span> <span>"2.0"</span><span>;</span><br /> <a href="#completerequest-id">id</a><span>:</span> <a href="#requestid">RequestId</a><span>;</span><br /> <a href="#completerequest-method">method</a><span>:</span> <span>"completion/complete"</span><span>;</span><br /> <a href="#completerequest-params">params</a><span>:</span> <a href="#completerequestparams">CompleteRequestParams</a><span>;</span><br /><span>}</span></div><div><p>A request from the client to the server, to ask for completion options.</p> </div><section><div><span>jsonrpc: "2.0"</span><a href="#completerequest-jsonrpc" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Inherited from <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-jsonrpc">jsonrpc</a></p></aside></section><section><div><span>id: RequestId</span><a href="#completerequest-id" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Inherited from <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-id">id</a></p></aside></section><section><div><span>method: "completion/complete"</span><a href="#completerequest-method" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Overrides <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-method">method</a></p></aside></section><section><div><span>params: CompleteRequestParams</span><a href="#completerequest-params" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Overrides <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-params">params</a></p></aside></section> | |
| </div> | |
| <div> | |
| ### `CompleteRequestParams` | |
| <div><span>interface</span> <span>CompleteRequestParams</span> <span>\{</span><br /> <a href="#completerequestparams-_meta">\_meta</a><span>?:</span> <span>\{</span> <span>progressToken</span><span>?:</span> <a href="#progresstoken">ProgressToken</a><span>;</span> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>unknown</span> <span>}</span><span>;</span><br /> <a href="#completerequestparams-ref">ref</a><span>:</span> <a href="#promptreference">PromptReference</a> <span>|</span> <a href="#resourcetemplatereference">ResourceTemplateReference</a><span>;</span><br /> <a href="#completerequestparams-argument">argument</a><span>:</span> <span>\{</span> <span>name</span><span>:</span> <span>string</span><span>;</span> <span>value</span><span>:</span> <span>string</span> <span>}</span><span>;</span><br /> <a href="#completerequestparams-context">context</a><span>?:</span> <span>\{</span> <span>arguments</span><span>?:</span> <span>\{</span> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>string</span> <span>}</span> <span>}</span><span>;</span><br /><span>}</span></div><div><p>Parameters for a <code>completion/complete</code> request.</p> </div><section><div><span>\_meta?: \{ progressToken?: ProgressToken; \[key: string]: unknown }</span><a href="#completerequestparams-_meta" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>See <a href="/specification/2025-11-25/basic/index#meta">General fields: <code>\_meta</code></a> for notes on <code>\_meta</code> usage.</p> </div><div><div>Type Declaration</div><ul><li><div><span>\[</span><span>key</span>: <span>string</span><span>]:</span> <span>unknown</span></div></li><li><div><code>Optional</code><span>progressToken</span><span>?: </span><a href="#progresstoken">ProgressToken</a></div><div><p>If specified, the caller is requesting out-of-band progress notifications for this request (as represented by notifications/progress). The value of this parameter is an opaque token that will be attached to any subsequent notifications. The receiver is not obligated to provide these notifications.</p> </div></li></ul></div><aside><p>Inherited from RequestParams.\_meta</p></aside></section><section><div><span>ref: PromptReference | ResourceTemplateReference</span><a href="#completerequestparams-ref" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section><div><span>argument: \{ name: string; value: string }</span><a href="#completerequestparams-argument" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>The argument's information</p> </div><div><div>Type Declaration</div><ul><li><div><span>name</span><span>: </span><span>string</span></div><div><p>The name of the argument</p> </div></li><li><div><span>value</span><span>: </span><span>string</span></div><div><p>The value of the argument to use for completion matching.</p> </div></li></ul></div></section><section><div><span>context?: \{ arguments?: \{ \[key: string]: string } }</span><a href="#completerequestparams-context" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Additional, optional context for completions</p> </div><div><div>Type Declaration</div><ul><li><div><code>Optional</code><span>arguments</span><span>?: </span><span>\{</span> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>string</span> <span>}</span></div><div><p>Previously-resolved variables in a URI template or prompt.</p> </div></li></ul></div></section> | |
| </div> | |
| <div> | |
| ### `CompleteResult` | |
| <div><span>interface</span> <span>CompleteResult</span> <span>\{</span><br /> <a href="#completeresult-_meta">\_meta</a><span>?:</span> <span>\{</span> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>unknown</span> <span>}</span><span>;</span><br /> <a href="#completeresult-completion">completion</a><span>:</span> <span>\{</span> <span>values</span><span>:</span> <span>string</span><span>\[]</span><span>;</span> <span>total</span><span>?:</span> <span>number</span><span>;</span> <span>hasMore</span><span>?:</span> <span>boolean</span> <span>}</span><span>;</span><br /> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>unknown</span><span>;</span><br /><span>}</span></div><div><p>The server's response to a completion/complete request</p> </div><section><div><span>\_meta?: \{ \[key: string]: unknown }</span><a href="#completeresult-_meta" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>See <a href="/specification/2025-11-25/basic/index#meta">General fields: <code>\_meta</code></a> for notes on <code>\_meta</code> usage.</p> </div><aside><p>Inherited from <a href="#result">Result</a>.<a href="#result-_meta">\_meta</a></p></aside></section><section><div><span>completion: \{ values: string\[]; total?: number; hasMore?: boolean }</span><a href="#completeresult-completion" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><div>Type Declaration</div><ul><li><div><span>values</span><span>: </span><span>string</span><span>\[]</span></div><div><p>An array of completion values. Must not exceed 100 items.</p> </div></li><li><div><code>Optional</code><span>total</span><span>?: </span><span>number</span></div><div><p>The total number of completion options available. This can exceed the number of values actually sent in the response.</p> </div></li><li><div><code>Optional</code><span>hasMore</span><span>?: </span><span>boolean</span></div><div><p>Indicates whether there are additional completion options beyond those provided in the current response, even if the exact total is unknown.</p> </div></li></ul></div></section> | |
| </div> | |
| <div> | |
| ### `PromptReference` | |
| <div><span>interface</span> <span>PromptReference</span> <span>\{</span><br /> <a href="#promptreference-name">name</a><span>:</span> <span>string</span><span>;</span><br /> <a href="#promptreference-title">title</a><span>?:</span> <span>string</span><span>;</span><br /> <a href="#promptreference-type">type</a><span>:</span> <span>"ref/prompt"</span><span>;</span><br /><span>}</span></div><div><p>Identifies a prompt.</p> </div><section><div><span>name: string</span><a href="#promptreference-name" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Intended for programmatic or logical use, but used as a display name in past specs or fallback (if title isn't present).</p> </div><aside><p>Inherited from BaseMetadata.name</p></aside></section><section><div><span>title?: string</span><a href="#promptreference-title" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Intended for UI and end-user contexts — optimized to be human-readable and easily understood, | |
| even by those unfamiliar with domain-specific terminology.</p> <p>If not provided, the name should be used for display (except for Tool, | |
| where <code>annotations.title</code> should be given precedence over using <code>name</code>, | |
| if present).</p> </div><aside><p>Inherited from BaseMetadata.title</p></aside></section><section><div><span>type: "ref/prompt"</span><a href="#promptreference-type" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section> | |
| </div> | |
| <div> | |
| ### `ResourceTemplateReference` | |
| <div><span>interface</span> <span>ResourceTemplateReference</span> <span>\{</span><br /> <a href="#resourcetemplatereference-type">type</a><span>:</span> <span>"ref/resource"</span><span>;</span><br /> <a href="#resourcetemplatereference-uri">uri</a><span>:</span> <span>string</span><span>;</span><br /><span>}</span></div><div><p>A reference to a resource or resource template definition.</p> </div><section><div><span>type: "ref/resource"</span><a href="#resourcetemplatereference-type" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section><div><span>uri: string</span><a href="#resourcetemplatereference-uri" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>The URI or URI template of the resource.</p> </div></section> | |
| </div> | |
| ## `elicitation/create` | |
| <div> | |
| ### `ElicitRequest` | |
| <div><span>interface</span> <span>ElicitRequest</span> <span>\{</span><br /> <a href="#elicitrequest-jsonrpc">jsonrpc</a><span>:</span> <span>"2.0"</span><span>;</span><br /> <a href="#elicitrequest-id">id</a><span>:</span> <a href="#requestid">RequestId</a><span>;</span><br /> <a href="#elicitrequest-method">method</a><span>:</span> <span>"elicitation/create"</span><span>;</span><br /> <a href="#elicitrequest-params">params</a><span>:</span> <a href="#elicitrequestparams">ElicitRequestParams</a><span>;</span><br /><span>}</span></div><div><p>A request from the server to elicit additional information from the user via the client.</p> </div><section><div><span>jsonrpc: "2.0"</span><a href="#elicitrequest-jsonrpc" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Inherited from <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-jsonrpc">jsonrpc</a></p></aside></section><section><div><span>id: RequestId</span><a href="#elicitrequest-id" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Inherited from <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-id">id</a></p></aside></section><section><div><span>method: "elicitation/create"</span><a href="#elicitrequest-method" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Overrides <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-method">method</a></p></aside></section><section><div><span>params: ElicitRequestParams</span><a href="#elicitrequest-params" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Overrides <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-params">params</a></p></aside></section> | |
| </div> | |
| <div> | |
| ### `ElicitRequestParams` | |
| <div><span>ElicitRequestParams</span><span>:</span> <a href="#elicitrequestformparams">ElicitRequestFormParams</a> <span>|</span> <a href="#elicitrequesturlparams">ElicitRequestURLParams</a></div><div><p>The parameters for a request to elicit additional information from the user via the client.</p> </div> | |
| </div> | |
| <div> | |
| ### `ElicitResult` | |
| <div><span>interface</span> <span>ElicitResult</span> <span>\{</span><br /> <a href="#elicitresult-_meta">\_meta</a><span>?:</span> <span>\{</span> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>unknown</span> <span>}</span><span>;</span><br /> <a href="#elicitresult-action">action</a><span>:</span> <span>"accept"</span> <span>|</span> <span>"decline"</span> <span>|</span> <span>"cancel"</span><span>;</span><br /> <a href="#elicitresult-content">content</a><span>?:</span> <span>\{</span> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>string</span> <span>|</span> <span>number</span> <span>|</span> <span>boolean</span> <span>|</span> <span>string</span><span>\[]</span> <span>}</span><span>;</span><br /> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>unknown</span><span>;</span><br /><span>}</span></div><div><p>The client's response to an elicitation request.</p> </div><section><div><span>\_meta?: \{ \[key: string]: unknown }</span><a href="#elicitresult-_meta" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>See <a href="/specification/2025-11-25/basic/index#meta">General fields: <code>\_meta</code></a> for notes on <code>\_meta</code> usage.</p> </div><aside><p>Inherited from <a href="#result">Result</a>.<a href="#result-_meta">\_meta</a></p></aside></section><section><div><span>action: "accept" | "decline" | "cancel"</span><a href="#elicitresult-action" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>The user action in response to the elicitation.</p> <ul> <li>"accept": User submitted the form/confirmed the action</li> <li>"decline": User explicitly decline the action</li> <li>"cancel": User dismissed without making an explicit choice</li> </ul> </div></section><section><div><span>content?: \{ \[key: string]: string | number | boolean | string\[] }</span><a href="#elicitresult-content" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>The submitted form data, only present when action is "accept" and mode was "form". | |
| Contains values matching the requested schema. | |
| Omitted for out-of-band mode responses.</p> </div></section> | |
| </div> | |
| <div> | |
| ### `BooleanSchema` | |
| <div><span>interface</span> <span>BooleanSchema</span> <span>\{</span><br /> <a href="#booleanschema-type">type</a><span>:</span> <span>"boolean"</span><span>;</span><br /> <a href="#booleanschema-title">title</a><span>?:</span> <span>string</span><span>;</span><br /> <a href="#booleanschema-description">description</a><span>?:</span> <span>string</span><span>;</span><br /> <a href="#booleanschema-default">default</a><span>?:</span> <span>boolean</span><span>;</span><br /><span>}</span></div><section><div><span>type: "boolean"</span><a href="#booleanschema-type" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section><div><span>title?: string</span><a href="#booleanschema-title" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section><div><span>description?: string</span><a href="#booleanschema-description" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section><div><span>default?: boolean</span><a href="#booleanschema-default" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section> | |
| </div> | |
| <div> | |
| ### `ElicitRequestFormParams` | |
| <div><span>interface</span> <span>ElicitRequestFormParams</span> <span>\{</span><br /> <a href="#elicitrequestformparams-task">task</a><span>?:</span> <a href="#taskmetadata">TaskMetadata</a><span>;</span><br /> <a href="#elicitrequestformparams-_meta">\_meta</a><span>?:</span> <span>\{</span> <span>progressToken</span><span>?:</span> <a href="#progresstoken">ProgressToken</a><span>;</span> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>unknown</span> <span>}</span><span>;</span><br /> <a href="#elicitrequestformparams-mode">mode</a><span>?:</span> <span>"form"</span><span>;</span><br /> <a href="#elicitrequestformparams-message">message</a><span>:</span> <span>string</span><span>;</span><br /> <a href="#elicitrequestformparams-requestedschema">requestedSchema</a><span>:</span> <span>\{</span><br /> <span>\$schema</span><span>?:</span> <span>string</span><span>;</span><br /> <span>type</span><span>:</span> <span>"object"</span><span>;</span><br /> <span>properties</span><span>:</span> <span>\{</span> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <a href="#primitiveschemadefinition">PrimitiveSchemaDefinition</a> <span>}</span><span>;</span><br /> <span>required</span><span>?:</span> <span>string</span><span>\[]</span><span>;</span><br /> <span>}</span><span>;</span><br /><span>}</span></div><div><p>The parameters for a request to elicit non-sensitive information from the user via a form in the client.</p> </div><section><div><span>task?: TaskMetadata</span><a href="#elicitrequestformparams-task" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>If specified, the caller is requesting task-augmented execution for this request. | |
| The request will return a CreateTaskResult immediately, and the actual result can be | |
| retrieved later via tasks/result.</p> <p>Task augmentation is subject to capability negotiation - receivers MUST declare support | |
| for task augmentation of specific request types in their capabilities.</p> </div><aside><p>Inherited from TaskAugmentedRequestParams.task</p></aside></section><section><div><span>\_meta?: \{ progressToken?: ProgressToken; \[key: string]: unknown }</span><a href="#elicitrequestformparams-_meta" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>See <a href="/specification/2025-11-25/basic/index#meta">General fields: <code>\_meta</code></a> for notes on <code>\_meta</code> usage.</p> </div><div><div>Type Declaration</div><ul><li><div><span>\[</span><span>key</span>: <span>string</span><span>]:</span> <span>unknown</span></div></li><li><div><code>Optional</code><span>progressToken</span><span>?: </span><a href="#progresstoken">ProgressToken</a></div><div><p>If specified, the caller is requesting out-of-band progress notifications for this request (as represented by notifications/progress). The value of this parameter is an opaque token that will be attached to any subsequent notifications. The receiver is not obligated to provide these notifications.</p> </div></li></ul></div><aside><p>Inherited from TaskAugmentedRequestParams.\_meta</p></aside></section><section><div><span>mode?: "form"</span><a href="#elicitrequestformparams-mode" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>The elicitation mode.</p> </div></section><section><div><span>message: string</span><a href="#elicitrequestformparams-message" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>The message to present to the user describing what information is being requested.</p> </div></section><section><div><span>requestedSchema: \{ \$schema?: string; type: "object"; properties: \{ \[key: string]: PrimitiveSchemaDefinition }; required?: string\[]; }</span><a href="#elicitrequestformparams-requestedschema" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>A restricted subset of JSON Schema. | |
| Only top-level properties are allowed, without nesting.</p> </div></section> | |
| </div> | |
| <div> | |
| ### `ElicitRequestURLParams` | |
| <div><span>interface</span> <span>ElicitRequestURLParams</span> <span>\{</span><br /> <a href="#elicitrequesturlparams-task">task</a><span>?:</span> <a href="#taskmetadata">TaskMetadata</a><span>;</span><br /> <a href="#elicitrequesturlparams-_meta">\_meta</a><span>?:</span> <span>\{</span> <span>progressToken</span><span>?:</span> <a href="#progresstoken">ProgressToken</a><span>;</span> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>unknown</span> <span>}</span><span>;</span><br /> <a href="#elicitrequesturlparams-mode">mode</a><span>:</span> <span>"url"</span><span>;</span><br /> <a href="#elicitrequesturlparams-message">message</a><span>:</span> <span>string</span><span>;</span><br /> <a href="#elicitrequesturlparams-elicitationid">elicitationId</a><span>:</span> <span>string</span><span>;</span><br /> <a href="#elicitrequesturlparams-url">url</a><span>:</span> <span>string</span><span>;</span><br /><span>}</span></div><div><p>The parameters for a request to elicit information from the user via a URL in the client.</p> </div><section><div><span>task?: TaskMetadata</span><a href="#elicitrequesturlparams-task" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>If specified, the caller is requesting task-augmented execution for this request. | |
| The request will return a CreateTaskResult immediately, and the actual result can be | |
| retrieved later via tasks/result.</p> <p>Task augmentation is subject to capability negotiation - receivers MUST declare support | |
| for task augmentation of specific request types in their capabilities.</p> </div><aside><p>Inherited from TaskAugmentedRequestParams.task</p></aside></section><section><div><span>\_meta?: \{ progressToken?: ProgressToken; \[key: string]: unknown }</span><a href="#elicitrequesturlparams-_meta" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>See <a href="/specification/2025-11-25/basic/index#meta">General fields: <code>\_meta</code></a> for notes on <code>\_meta</code> usage.</p> </div><div><div>Type Declaration</div><ul><li><div><span>\[</span><span>key</span>: <span>string</span><span>]:</span> <span>unknown</span></div></li><li><div><code>Optional</code><span>progressToken</span><span>?: </span><a href="#progresstoken">ProgressToken</a></div><div><p>If specified, the caller is requesting out-of-band progress notifications for this request (as represented by notifications/progress). The value of this parameter is an opaque token that will be attached to any subsequent notifications. The receiver is not obligated to provide these notifications.</p> </div></li></ul></div><aside><p>Inherited from TaskAugmentedRequestParams.\_meta</p></aside></section><section><div><span>mode: "url"</span><a href="#elicitrequesturlparams-mode" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>The elicitation mode.</p> </div></section><section><div><span>message: string</span><a href="#elicitrequesturlparams-message" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>The message to present to the user explaining why the interaction is needed.</p> </div></section><section><div><span>elicitationId: string</span><a href="#elicitrequesturlparams-elicitationid" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>The ID of the elicitation, which must be unique within the context of the server. | |
| The client MUST treat this ID as an opaque value.</p> </div></section><section><div><span>url: string</span><a href="#elicitrequesturlparams-url" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>The URL that the user should navigate to.</p> </div></section> | |
| </div> | |
| <div> | |
| ### `EnumSchema` | |
| <div><span>EnumSchema</span><span>:</span><br /> <span>|</span> <a href="#singleselectenumschema">SingleSelectEnumSchema</a><br /> <span>|</span> <a href="#multiselectenumschema">MultiSelectEnumSchema</a><br /> <span>|</span> <a href="#legacytitledenumschema">LegacyTitledEnumSchema</a></div> | |
| </div> | |
| <div> | |
| ### `LegacyTitledEnumSchema` | |
| <div><span>interface</span> <span>LegacyTitledEnumSchema</span> <span>\{</span><br /> <a href="#legacytitledenumschema-type">type</a><span>:</span> <span>"string"</span><span>;</span><br /> <a href="#legacytitledenumschema-title">title</a><span>?:</span> <span>string</span><span>;</span><br /> <a href="#legacytitledenumschema-description">description</a><span>?:</span> <span>string</span><span>;</span><br /> <a href="#legacytitledenumschema-enum">enum</a><span>:</span> <span>string</span><span>\[]</span><span>;</span><br /> <a href="#legacytitledenumschema-enumnames">enumNames</a><span>?:</span> <span>string</span><span>\[]</span><span>;</span><br /> <a href="#legacytitledenumschema-default">default</a><span>?:</span> <span>string</span><span>;</span><br /><span>}</span></div><div><p>Use TitledSingleSelectEnumSchema instead. | |
| This interface will be removed in a future version.</p> </div><section><div><span>type: "string"</span><a href="#legacytitledenumschema-type" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section><div><span>title?: string</span><a href="#legacytitledenumschema-title" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section><div><span>description?: string</span><a href="#legacytitledenumschema-description" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section><div><span>enum: string\[]</span><a href="#legacytitledenumschema-enum" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section><div><span>enumNames?: string\[]</span><a href="#legacytitledenumschema-enumnames" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>(Legacy) Display names for enum values. | |
| Non-standard according to JSON schema 2020-12.</p> </div></section><section><div><span>default?: string</span><a href="#legacytitledenumschema-default" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section> | |
| </div> | |
| <div> | |
| ### `MultiSelectEnumSchema` | |
| <div><span>MultiSelectEnumSchema</span><span>:</span><br /> <span>|</span> <a href="#untitledmultiselectenumschema">UntitledMultiSelectEnumSchema</a><br /> <span>|</span> <a href="#titledmultiselectenumschema">TitledMultiSelectEnumSchema</a></div> | |
| </div> | |
| <div> | |
| ### `NumberSchema` | |
| <div><span>interface</span> <span>NumberSchema</span> <span>\{</span><br /> <a href="#numberschema-type">type</a><span>:</span> <span>"number"</span> <span>|</span> <span>"integer"</span><span>;</span><br /> <a href="#numberschema-title">title</a><span>?:</span> <span>string</span><span>;</span><br /> <a href="#numberschema-description">description</a><span>?:</span> <span>string</span><span>;</span><br /> <a href="#numberschema-minimum">minimum</a><span>?:</span> <span>number</span><span>;</span><br /> <a href="#numberschema-maximum">maximum</a><span>?:</span> <span>number</span><span>;</span><br /> <a href="#numberschema-default">default</a><span>?:</span> <span>number</span><span>;</span><br /><span>}</span></div><section><div><span>type: "number" | "integer"</span><a href="#numberschema-type" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section><div><span>title?: string</span><a href="#numberschema-title" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section><div><span>description?: string</span><a href="#numberschema-description" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section><div><span>minimum?: number</span><a href="#numberschema-minimum" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section><div><span>maximum?: number</span><a href="#numberschema-maximum" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section><div><span>default?: number</span><a href="#numberschema-default" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section> | |
| </div> | |
| <div> | |
| ### `PrimitiveSchemaDefinition` | |
| <div><span>PrimitiveSchemaDefinition</span><span>:</span><br /> <span>|</span> <a href="#stringschema">StringSchema</a><br /> <span>|</span> <a href="#numberschema">NumberSchema</a><br /> <span>|</span> <a href="#booleanschema">BooleanSchema</a><br /> <span>|</span> <a href="#enumschema">EnumSchema</a></div><div><p>Restricted schema definitions that only allow primitive types | |
| without nested objects or arrays.</p> </div> | |
| </div> | |
| <div> | |
| ### `SingleSelectEnumSchema` | |
| <div><span>SingleSelectEnumSchema</span><span>:</span><br /> <span>|</span> <a href="#untitledsingleselectenumschema">UntitledSingleSelectEnumSchema</a><br /> <span>|</span> <a href="#titledsingleselectenumschema">TitledSingleSelectEnumSchema</a></div> | |
| </div> | |
| <div> | |
| ### `StringSchema` | |
| <div><span>interface</span> <span>StringSchema</span> <span>\{</span><br /> <a href="#stringschema-type">type</a><span>:</span> <span>"string"</span><span>;</span><br /> <a href="#stringschema-title">title</a><span>?:</span> <span>string</span><span>;</span><br /> <a href="#stringschema-description">description</a><span>?:</span> <span>string</span><span>;</span><br /> <a href="#stringschema-minlength">minLength</a><span>?:</span> <span>number</span><span>;</span><br /> <a href="#stringschema-maxlength">maxLength</a><span>?:</span> <span>number</span><span>;</span><br /> <a href="#stringschema-format">format</a><span>?:</span> <span>"uri"</span> <span>|</span> <span>"email"</span> <span>|</span> <span>"date"</span> <span>|</span> <span>"date-time"</span><span>;</span><br /> <a href="#stringschema-default">default</a><span>?:</span> <span>string</span><span>;</span><br /><span>}</span></div><section><div><span>type: "string"</span><a href="#stringschema-type" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section><div><span>title?: string</span><a href="#stringschema-title" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section><div><span>description?: string</span><a href="#stringschema-description" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section><div><span>minLength?: number</span><a href="#stringschema-minlength" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section><div><span>maxLength?: number</span><a href="#stringschema-maxlength" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section><div><span>format?: "uri" | "email" | "date" | "date-time"</span><a href="#stringschema-format" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section><div><span>default?: string</span><a href="#stringschema-default" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section> | |
| </div> | |
| <div> | |
| ### `TitledMultiSelectEnumSchema` | |
| <div><span>interface</span> <span>TitledMultiSelectEnumSchema</span> <span>\{</span><br /> <a href="#titledmultiselectenumschema-type">type</a><span>:</span> <span>"array"</span><span>;</span><br /> <a href="#titledmultiselectenumschema-title">title</a><span>?:</span> <span>string</span><span>;</span><br /> <a href="#titledmultiselectenumschema-description">description</a><span>?:</span> <span>string</span><span>;</span><br /> <a href="#titledmultiselectenumschema-minitems">minItems</a><span>?:</span> <span>number</span><span>;</span><br /> <a href="#titledmultiselectenumschema-maxitems">maxItems</a><span>?:</span> <span>number</span><span>;</span><br /> <a href="#titledmultiselectenumschema-items">items</a><span>:</span> <span>\{</span> <span>anyOf</span><span>:</span> <span>\{</span> <span>const</span><span>:</span> <span>string</span><span>;</span> <span>title</span><span>:</span> <span>string</span> <span>}</span><span>\[]</span> <span>}</span><span>;</span><br /> <a href="#titledmultiselectenumschema-default">default</a><span>?:</span> <span>string</span><span>\[]</span><span>;</span><br /><span>}</span></div><div><p>Schema for multiple-selection enumeration with display titles for each option.</p> </div><section><div><span>type: "array"</span><a href="#titledmultiselectenumschema-type" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section><div><span>title?: string</span><a href="#titledmultiselectenumschema-title" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Optional title for the enum field.</p> </div></section><section><div><span>description?: string</span><a href="#titledmultiselectenumschema-description" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Optional description for the enum field.</p> </div></section><section><div><span>minItems?: number</span><a href="#titledmultiselectenumschema-minitems" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Minimum number of items to select.</p> </div></section><section><div><span>maxItems?: number</span><a href="#titledmultiselectenumschema-maxitems" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Maximum number of items to select.</p> </div></section><section><div><span>items: \{ anyOf: \{ const: string; title: string }\[] }</span><a href="#titledmultiselectenumschema-items" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Schema for array items with enum options and display labels.</p> </div><div><div>Type Declaration</div><ul><li><div><span>anyOf</span><span>: </span><span>\{</span> <span>const</span><span>:</span> <span>string</span><span>;</span> <span>title</span><span>:</span> <span>string</span> <span>}</span><span>\[]</span></div><div><p>Array of enum options with values and display labels.</p> </div></li></ul></div></section><section><div><span>default?: string\[]</span><a href="#titledmultiselectenumschema-default" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Optional default value.</p> </div></section> | |
| </div> | |
| <div> | |
| ### `TitledSingleSelectEnumSchema` | |
| <div><span>interface</span> <span>TitledSingleSelectEnumSchema</span> <span>\{</span><br /> <a href="#titledsingleselectenumschema-type">type</a><span>:</span> <span>"string"</span><span>;</span><br /> <a href="#titledsingleselectenumschema-title">title</a><span>?:</span> <span>string</span><span>;</span><br /> <a href="#titledsingleselectenumschema-description">description</a><span>?:</span> <span>string</span><span>;</span><br /> <a href="#titledsingleselectenumschema-oneof">oneOf</a><span>:</span> <span>\{</span> <span>const</span><span>:</span> <span>string</span><span>;</span> <span>title</span><span>:</span> <span>string</span> <span>}</span><span>\[]</span><span>;</span><br /> <a href="#titledsingleselectenumschema-default">default</a><span>?:</span> <span>string</span><span>;</span><br /><span>}</span></div><div><p>Schema for single-selection enumeration with display titles for each option.</p> </div><section><div><span>type: "string"</span><a href="#titledsingleselectenumschema-type" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section><div><span>title?: string</span><a href="#titledsingleselectenumschema-title" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Optional title for the enum field.</p> </div></section><section><div><span>description?: string</span><a href="#titledsingleselectenumschema-description" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Optional description for the enum field.</p> </div></section><section><div><span>oneOf: \{ const: string; title: string }\[]</span><a href="#titledsingleselectenumschema-oneof" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Array of enum options with values and display labels.</p> </div><div><div>Type Declaration</div><ul><li><div><span>const</span><span>: </span><span>string</span></div><div><p>The enum value.</p> </div></li><li><div><span>title</span><span>: </span><span>string</span></div><div><p>Display label for this option.</p> </div></li></ul></div></section><section><div><span>default?: string</span><a href="#titledsingleselectenumschema-default" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Optional default value.</p> </div></section> | |
| </div> | |
| <div> | |
| ### `UntitledMultiSelectEnumSchema` | |
| <div><span>interface</span> <span>UntitledMultiSelectEnumSchema</span> <span>\{</span><br /> <a href="#untitledmultiselectenumschema-type">type</a><span>:</span> <span>"array"</span><span>;</span><br /> <a href="#untitledmultiselectenumschema-title">title</a><span>?:</span> <span>string</span><span>;</span><br /> <a href="#untitledmultiselectenumschema-description">description</a><span>?:</span> <span>string</span><span>;</span><br /> <a href="#untitledmultiselectenumschema-minitems">minItems</a><span>?:</span> <span>number</span><span>;</span><br /> <a href="#untitledmultiselectenumschema-maxitems">maxItems</a><span>?:</span> <span>number</span><span>;</span><br /> <a href="#untitledmultiselectenumschema-items">items</a><span>:</span> <span>\{</span> <span>type</span><span>:</span> <span>"string"</span><span>;</span> <span>enum</span><span>:</span> <span>string</span><span>\[]</span> <span>}</span><span>;</span><br /> <a href="#untitledmultiselectenumschema-default">default</a><span>?:</span> <span>string</span><span>\[]</span><span>;</span><br /><span>}</span></div><div><p>Schema for multiple-selection enumeration without display titles for options.</p> </div><section><div><span>type: "array"</span><a href="#untitledmultiselectenumschema-type" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section><div><span>title?: string</span><a href="#untitledmultiselectenumschema-title" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Optional title for the enum field.</p> </div></section><section><div><span>description?: string</span><a href="#untitledmultiselectenumschema-description" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Optional description for the enum field.</p> </div></section><section><div><span>minItems?: number</span><a href="#untitledmultiselectenumschema-minitems" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Minimum number of items to select.</p> </div></section><section><div><span>maxItems?: number</span><a href="#untitledmultiselectenumschema-maxitems" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Maximum number of items to select.</p> </div></section><section><div><span>items: \{ type: "string"; enum: string\[] }</span><a href="#untitledmultiselectenumschema-items" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Schema for the array items.</p> </div><div><div>Type Declaration</div><ul><li><div><span>type</span><span>: </span><span>"string"</span></div></li><li><div><span>enum</span><span>: </span><span>string</span><span>\[]</span></div><div><p>Array of enum values to choose from.</p> </div></li></ul></div></section><section><div><span>default?: string\[]</span><a href="#untitledmultiselectenumschema-default" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Optional default value.</p> </div></section> | |
| </div> | |
| <div> | |
| ### `UntitledSingleSelectEnumSchema` | |
| <div><span>interface</span> <span>UntitledSingleSelectEnumSchema</span> <span>\{</span><br /> <a href="#untitledsingleselectenumschema-type">type</a><span>:</span> <span>"string"</span><span>;</span><br /> <a href="#untitledsingleselectenumschema-title">title</a><span>?:</span> <span>string</span><span>;</span><br /> <a href="#untitledsingleselectenumschema-description">description</a><span>?:</span> <span>string</span><span>;</span><br /> <a href="#untitledsingleselectenumschema-enum">enum</a><span>:</span> <span>string</span><span>\[]</span><span>;</span><br /> <a href="#untitledsingleselectenumschema-default">default</a><span>?:</span> <span>string</span><span>;</span><br /><span>}</span></div><div><p>Schema for single-selection enumeration without display titles for options.</p> </div><section><div><span>type: "string"</span><a href="#untitledsingleselectenumschema-type" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section><div><span>title?: string</span><a href="#untitledsingleselectenumschema-title" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Optional title for the enum field.</p> </div></section><section><div><span>description?: string</span><a href="#untitledsingleselectenumschema-description" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Optional description for the enum field.</p> </div></section><section><div><span>enum: string\[]</span><a href="#untitledsingleselectenumschema-enum" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Array of enum values to choose from.</p> </div></section><section><div><span>default?: string</span><a href="#untitledsingleselectenumschema-default" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Optional default value.</p> </div></section> | |
| </div> | |
| ## `initialize` | |
| <div> | |
| ### `InitializeRequest` | |
| <div><span>interface</span> <span>InitializeRequest</span> <span>\{</span><br /> <a href="#initializerequest-jsonrpc">jsonrpc</a><span>:</span> <span>"2.0"</span><span>;</span><br /> <a href="#initializerequest-id">id</a><span>:</span> <a href="#requestid">RequestId</a><span>;</span><br /> <a href="#initializerequest-method">method</a><span>:</span> <span>"initialize"</span><span>;</span><br /> <a href="#initializerequest-params">params</a><span>:</span> <a href="#initializerequestparams">InitializeRequestParams</a><span>;</span><br /><span>}</span></div><div><p>This request is sent from the client to the server when it first connects, asking it to begin initialization.</p> </div><section><div><span>jsonrpc: "2.0"</span><a href="#initializerequest-jsonrpc" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Inherited from <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-jsonrpc">jsonrpc</a></p></aside></section><section><div><span>id: RequestId</span><a href="#initializerequest-id" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Inherited from <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-id">id</a></p></aside></section><section><div><span>method: "initialize"</span><a href="#initializerequest-method" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Overrides <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-method">method</a></p></aside></section><section><div><span>params: InitializeRequestParams</span><a href="#initializerequest-params" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Overrides <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-params">params</a></p></aside></section> | |
| </div> | |
| <div> | |
| ### `InitializeRequestParams` | |
| <div><span>interface</span> <span>InitializeRequestParams</span> <span>\{</span><br /> <a href="#initializerequestparams-_meta">\_meta</a><span>?:</span> <span>\{</span> <span>progressToken</span><span>?:</span> <a href="#progresstoken">ProgressToken</a><span>;</span> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>unknown</span> <span>}</span><span>;</span><br /> <a href="#initializerequestparams-protocolversion">protocolVersion</a><span>:</span> <span>string</span><span>;</span><br /> <a href="#initializerequestparams-capabilities">capabilities</a><span>:</span> <a href="#clientcapabilities">ClientCapabilities</a><span>;</span><br /> <a href="#initializerequestparams-clientinfo">clientInfo</a><span>:</span> <a href="#implementation">Implementation</a><span>;</span><br /><span>}</span></div><div><p>Parameters for an <code>initialize</code> request.</p> </div><section><div><span>\_meta?: \{ progressToken?: ProgressToken; \[key: string]: unknown }</span><a href="#initializerequestparams-_meta" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>See <a href="/specification/2025-11-25/basic/index#meta">General fields: <code>\_meta</code></a> for notes on <code>\_meta</code> usage.</p> </div><div><div>Type Declaration</div><ul><li><div><span>\[</span><span>key</span>: <span>string</span><span>]:</span> <span>unknown</span></div></li><li><div><code>Optional</code><span>progressToken</span><span>?: </span><a href="#progresstoken">ProgressToken</a></div><div><p>If specified, the caller is requesting out-of-band progress notifications for this request (as represented by notifications/progress). The value of this parameter is an opaque token that will be attached to any subsequent notifications. The receiver is not obligated to provide these notifications.</p> </div></li></ul></div><aside><p>Inherited from RequestParams.\_meta</p></aside></section><section><div><span>protocolVersion: string</span><a href="#initializerequestparams-protocolversion" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>The latest version of the Model Context Protocol that the client supports. The client MAY decide to support older versions as well.</p> </div></section><section><div><span>capabilities: ClientCapabilities</span><a href="#initializerequestparams-capabilities" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section><div><span>clientInfo: Implementation</span><a href="#initializerequestparams-clientinfo" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section> | |
| </div> | |
| <div> | |
| ### `InitializeResult` | |
| <div><span>interface</span> <span>InitializeResult</span> <span>\{</span><br /> <a href="#initializeresult-_meta">\_meta</a><span>?:</span> <span>\{</span> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>unknown</span> <span>}</span><span>;</span><br /> <a href="#initializeresult-protocolversion">protocolVersion</a><span>:</span> <span>string</span><span>;</span><br /> <a href="#initializeresult-capabilities">capabilities</a><span>:</span> <a href="#servercapabilities">ServerCapabilities</a><span>;</span><br /> <a href="#initializeresult-serverinfo">serverInfo</a><span>:</span> <a href="#implementation">Implementation</a><span>;</span><br /> <a href="#initializeresult-instructions">instructions</a><span>?:</span> <span>string</span><span>;</span><br /> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>unknown</span><span>;</span><br /><span>}</span></div><div><p>After receiving an initialize request from the client, the server sends this response.</p> </div><section><div><span>\_meta?: \{ \[key: string]: unknown }</span><a href="#initializeresult-_meta" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>See <a href="/specification/2025-11-25/basic/index#meta">General fields: <code>\_meta</code></a> for notes on <code>\_meta</code> usage.</p> </div><aside><p>Inherited from <a href="#result">Result</a>.<a href="#result-_meta">\_meta</a></p></aside></section><section><div><span>protocolVersion: string</span><a href="#initializeresult-protocolversion" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>The version of the Model Context Protocol that the server wants to use. This may not match the version that the client requested. If the client cannot support this version, it MUST disconnect.</p> </div></section><section><div><span>capabilities: ServerCapabilities</span><a href="#initializeresult-capabilities" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section><div><span>serverInfo: Implementation</span><a href="#initializeresult-serverinfo" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section><div><span>instructions?: string</span><a href="#initializeresult-instructions" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Instructions describing how to use the server and its features.</p> <p>This can be used by clients to improve the LLM's understanding of available tools, resources, etc. It can be thought of like a "hint" to the model. For example, this information MAY be added to the system prompt.</p> </div></section> | |
| </div> | |
| <div> | |
| ### `ClientCapabilities` | |
| <div><span>interface</span> <span>ClientCapabilities</span> <span>\{</span><br /> <a href="#clientcapabilities-experimental">experimental</a><span>?:</span> <span>\{</span> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>object</span> <span>}</span><span>;</span><br /> <a href="#clientcapabilities-roots">roots</a><span>?:</span> <span>\{</span> <span>listChanged</span><span>?:</span> <span>boolean</span> <span>}</span><span>;</span><br /> <a href="#clientcapabilities-sampling">sampling</a><span>?:</span> <span>\{</span> <span>context</span><span>?:</span> <span>object</span><span>;</span> <span>tools</span><span>?:</span> <span>object</span> <span>}</span><span>;</span><br /> <a href="#clientcapabilities-elicitation">elicitation</a><span>?:</span> <span>\{</span> <span>form</span><span>?:</span> <span>object</span><span>;</span> <span>url</span><span>?:</span> <span>object</span> <span>}</span><span>;</span><br /> <a href="#clientcapabilities-tasks">tasks</a><span>?:</span> <span>\{</span><br /> <span>list</span><span>?:</span> <span>object</span><span>;</span><br /> <span>cancel</span><span>?:</span> <span>object</span><span>;</span><br /> <span>requests</span><span>?:</span> <span>\{</span><br /> <span>sampling</span><span>?:</span> <span>\{</span> <span>createMessage</span><span>?:</span> <span>object</span> <span>}</span><span>;</span><br /> <span>elicitation</span><span>?:</span> <span>\{</span> <span>create</span><span>?:</span> <span>object</span> <span>}</span><span>;</span><br /> <span>}</span><span>;</span><br /> <span>}</span><span>;</span><br /><span>}</span></div><div><p>Capabilities a client may support. Known capabilities are defined here, in this schema, but this is not a closed set: any client can define its own, additional capabilities.</p> </div><section><div><span>experimental?: \{ \[key: string]: object }</span><a href="#clientcapabilities-experimental" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Experimental, non-standard capabilities that the client supports.</p> </div></section><section><div><span>roots?: \{ listChanged?: boolean }</span><a href="#clientcapabilities-roots" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Present if the client supports listing roots.</p> </div><div><div>Type Declaration</div><ul><li><div><code>Optional</code><span>listChanged</span><span>?: </span><span>boolean</span></div><div><p>Whether the client supports notifications for changes to the roots list.</p> </div></li></ul></div></section><section><div><span>sampling?: \{ context?: object; tools?: object }</span><a href="#clientcapabilities-sampling" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Present if the client supports sampling from an LLM.</p> </div><div><div>Type Declaration</div><ul><li><div><code>Optional</code><span>context</span><span>?: </span><span>object</span></div><div><p>Whether the client supports context inclusion via includeContext parameter. | |
| If not declared, servers SHOULD only use <code>includeContext: "none"</code> (or omit it).</p> </div></li><li><div><code>Optional</code><span>tools</span><span>?: </span><span>object</span></div><div><p>Whether the client supports tool use via tools and toolChoice parameters.</p> </div></li></ul></div></section><section><div><span>elicitation?: \{ form?: object; url?: object }</span><a href="#clientcapabilities-elicitation" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Present if the client supports elicitation from the server.</p> </div></section><section><div><span>tasks?: \{ list?: object; cancel?: object; requests?: \{ sampling?: \{ createMessage?: object }; elicitation?: \{ create?: object }; }; }</span><a href="#clientcapabilities-tasks" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Present if the client supports task-augmented requests.</p> </div><div><div>Type Declaration</div><ul><li><div><code>Optional</code><span>list</span><span>?: </span><span>object</span></div><div><p>Whether this client supports tasks/list.</p> </div></li><li><div><code>Optional</code><span>cancel</span><span>?: </span><span>object</span></div><div><p>Whether this client supports tasks/cancel.</p> </div></li><li><div><code>Optional</code><span>requests</span><span>?: </span><span>\{</span> <span>sampling</span><span>?:</span> <span>\{</span> <span>createMessage</span><span>?:</span> <span>object</span> <span>}</span><span>;</span> <span>elicitation</span><span>?:</span> <span>\{</span> <span>create</span><span>?:</span> <span>object</span> <span>}</span> <span>}</span></div><div><p>Specifies which request types can be augmented with tasks.</p> </div><ul><li><div><code>Optional</code><span>sampling</span><span>?: </span><span>\{</span> <span>createMessage</span><span>?:</span> <span>object</span> <span>}</span></div><div><p>Task support for sampling-related requests.</p> </div><ul><li><div><code>Optional</code><span>createMessage</span><span>?: </span><span>object</span></div><div><p>Whether the client supports task-augmented sampling/createMessage requests.</p> </div></li></ul></li><li><div><code>Optional</code><span>elicitation</span><span>?: </span><span>\{</span> <span>create</span><span>?:</span> <span>object</span> <span>}</span></div><div><p>Task support for elicitation-related requests.</p> </div><ul><li><div><code>Optional</code><span>create</span><span>?: </span><span>object</span></div><div><p>Whether the client supports task-augmented elicitation/create requests.</p> </div></li></ul></li></ul></li></ul></div></section> | |
| </div> | |
| <div> | |
| ### `Implementation` | |
| <div><span>interface</span> <span>Implementation</span> <span>\{</span><br /> <a href="#implementation-icons">icons</a><span>?:</span> <a href="#icon">Icon</a><span>\[]</span><span>;</span><br /> <a href="#implementation-name">name</a><span>:</span> <span>string</span><span>;</span><br /> <a href="#implementation-title">title</a><span>?:</span> <span>string</span><span>;</span><br /> <a href="#implementation-version">version</a><span>:</span> <span>string</span><span>;</span><br /> <a href="#implementation-description">description</a><span>?:</span> <span>string</span><span>;</span><br /> <a href="#implementation-websiteurl">websiteUrl</a><span>?:</span> <span>string</span><span>;</span><br /><span>}</span></div><div><p>Describes the MCP implementation.</p> </div><section><div><span>icons?: Icon\[]</span><a href="#implementation-icons" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Optional set of sized icons that the client can display in a user interface.</p> <p>Clients that support rendering icons MUST support at least the following MIME types:</p> <ul> <li><code>image/png</code> - PNG images (safe, universal compatibility)</li> <li><code>image/jpeg</code> (and <code>image/jpg</code>) - JPEG images (safe, universal compatibility)</li> </ul> <p>Clients that support rendering icons SHOULD also support:</p> <ul> <li><code>image/svg+xml</code> - SVG images (scalable but requires security precautions)</li> <li><code>image/webp</code> - WebP images (modern, efficient format)</li> </ul> </div><aside><p>Inherited from Icons.icons</p></aside></section><section><div><span>name: string</span><a href="#implementation-name" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Intended for programmatic or logical use, but used as a display name in past specs or fallback (if title isn't present).</p> </div><aside><p>Inherited from BaseMetadata.name</p></aside></section><section><div><span>title?: string</span><a href="#implementation-title" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Intended for UI and end-user contexts — optimized to be human-readable and easily understood, | |
| even by those unfamiliar with domain-specific terminology.</p> <p>If not provided, the name should be used for display (except for Tool, | |
| where <code>annotations.title</code> should be given precedence over using <code>name</code>, | |
| if present).</p> </div><aside><p>Inherited from BaseMetadata.title</p></aside></section><section><div><span>version: string</span><a href="#implementation-version" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section><div><span>description?: string</span><a href="#implementation-description" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>An optional human-readable description of what this implementation does.</p> <p>This can be used by clients or servers to provide context about their purpose | |
| and capabilities. For example, a server might describe the types of resources | |
| or tools it provides, while a client might describe its intended use case.</p> </div></section><section><div><span>websiteUrl?: string</span><a href="#implementation-websiteurl" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>An optional URL of the website for this implementation.</p> </div></section> | |
| </div> | |
| <div> | |
| ### `ServerCapabilities` | |
| <div><span>interface</span> <span>ServerCapabilities</span> <span>\{</span><br /> <a href="#servercapabilities-experimental">experimental</a><span>?:</span> <span>\{</span> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>object</span> <span>}</span><span>;</span><br /> <a href="#servercapabilities-logging">logging</a><span>?:</span> <span>object</span><span>;</span><br /> <a href="#servercapabilities-completions">completions</a><span>?:</span> <span>object</span><span>;</span><br /> <a href="#servercapabilities-prompts">prompts</a><span>?:</span> <span>\{</span> <span>listChanged</span><span>?:</span> <span>boolean</span> <span>}</span><span>;</span><br /> <a href="#servercapabilities-resources">resources</a><span>?:</span> <span>\{</span> <span>subscribe</span><span>?:</span> <span>boolean</span><span>;</span> <span>listChanged</span><span>?:</span> <span>boolean</span> <span>}</span><span>;</span><br /> <a href="#servercapabilities-tools">tools</a><span>?:</span> <span>\{</span> <span>listChanged</span><span>?:</span> <span>boolean</span> <span>}</span><span>;</span><br /> <a href="#servercapabilities-tasks">tasks</a><span>?:</span> <span>\{</span><br /> <span>list</span><span>?:</span> <span>object</span><span>;</span><br /> <span>cancel</span><span>?:</span> <span>object</span><span>;</span><br /> <span>requests</span><span>?:</span> <span>\{</span> <span>tools</span><span>?:</span> <span>\{</span> <span>call</span><span>?:</span> <span>object</span> <span>}</span> <span>}</span><span>;</span><br /> <span>}</span><span>;</span><br /><span>}</span></div><div><p>Capabilities that a server may support. Known capabilities are defined here, in this schema, but this is not a closed set: any server can define its own, additional capabilities.</p> </div><section><div><span>experimental?: \{ \[key: string]: object }</span><a href="#servercapabilities-experimental" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Experimental, non-standard capabilities that the server supports.</p> </div></section><section><div><span>logging?: object</span><a href="#servercapabilities-logging" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Present if the server supports sending log messages to the client.</p> </div></section><section><div><span>completions?: object</span><a href="#servercapabilities-completions" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Present if the server supports argument autocompletion suggestions.</p> </div></section><section><div><span>prompts?: \{ listChanged?: boolean }</span><a href="#servercapabilities-prompts" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Present if the server offers any prompt templates.</p> </div><div><div>Type Declaration</div><ul><li><div><code>Optional</code><span>listChanged</span><span>?: </span><span>boolean</span></div><div><p>Whether this server supports notifications for changes to the prompt list.</p> </div></li></ul></div></section><section><div><span>resources?: \{ subscribe?: boolean; listChanged?: boolean }</span><a href="#servercapabilities-resources" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Present if the server offers any resources to read.</p> </div><div><div>Type Declaration</div><ul><li><div><code>Optional</code><span>subscribe</span><span>?: </span><span>boolean</span></div><div><p>Whether this server supports subscribing to resource updates.</p> </div></li><li><div><code>Optional</code><span>listChanged</span><span>?: </span><span>boolean</span></div><div><p>Whether this server supports notifications for changes to the resource list.</p> </div></li></ul></div></section><section><div><span>tools?: \{ listChanged?: boolean }</span><a href="#servercapabilities-tools" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Present if the server offers any tools to call.</p> </div><div><div>Type Declaration</div><ul><li><div><code>Optional</code><span>listChanged</span><span>?: </span><span>boolean</span></div><div><p>Whether this server supports notifications for changes to the tool list.</p> </div></li></ul></div></section><section><div><span>tasks?: \{ list?: object; cancel?: object; requests?: \{ tools?: \{ call?: object } }; }</span><a href="#servercapabilities-tasks" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Present if the server supports task-augmented requests.</p> </div><div><div>Type Declaration</div><ul><li><div><code>Optional</code><span>list</span><span>?: </span><span>object</span></div><div><p>Whether this server supports tasks/list.</p> </div></li><li><div><code>Optional</code><span>cancel</span><span>?: </span><span>object</span></div><div><p>Whether this server supports tasks/cancel.</p> </div></li><li><div><code>Optional</code><span>requests</span><span>?: </span><span>\{</span> <span>tools</span><span>?:</span> <span>\{</span> <span>call</span><span>?:</span> <span>object</span> <span>}</span> <span>}</span></div><div><p>Specifies which request types can be augmented with tasks.</p> </div><ul><li><div><code>Optional</code><span>tools</span><span>?: </span><span>\{</span> <span>call</span><span>?:</span> <span>object</span> <span>}</span></div><div><p>Task support for tool-related requests.</p> </div><ul><li><div><code>Optional</code><span>call</span><span>?: </span><span>object</span></div><div><p>Whether the server supports task-augmented tools/call requests.</p> </div></li></ul></li></ul></li></ul></div></section> | |
| </div> | |
| ## `logging/setLevel` | |
| <div> | |
| ### `SetLevelRequest` | |
| <div><span>interface</span> <span>SetLevelRequest</span> <span>\{</span><br /> <a href="#setlevelrequest-jsonrpc">jsonrpc</a><span>:</span> <span>"2.0"</span><span>;</span><br /> <a href="#setlevelrequest-id">id</a><span>:</span> <a href="#requestid">RequestId</a><span>;</span><br /> <a href="#setlevelrequest-method">method</a><span>:</span> <span>"logging/setLevel"</span><span>;</span><br /> <a href="#setlevelrequest-params">params</a><span>:</span> <a href="#setlevelrequestparams">SetLevelRequestParams</a><span>;</span><br /><span>}</span></div><div><p>A request from the client to the server, to enable or adjust logging.</p> </div><section><div><span>jsonrpc: "2.0"</span><a href="#setlevelrequest-jsonrpc" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Inherited from <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-jsonrpc">jsonrpc</a></p></aside></section><section><div><span>id: RequestId</span><a href="#setlevelrequest-id" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Inherited from <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-id">id</a></p></aside></section><section><div><span>method: "logging/setLevel"</span><a href="#setlevelrequest-method" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Overrides <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-method">method</a></p></aside></section><section><div><span>params: SetLevelRequestParams</span><a href="#setlevelrequest-params" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Overrides <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-params">params</a></p></aside></section> | |
| </div> | |
| <div> | |
| ### `SetLevelRequestParams` | |
| <div><span>interface</span> <span>SetLevelRequestParams</span> <span>\{</span><br /> <a href="#setlevelrequestparams-_meta">\_meta</a><span>?:</span> <span>\{</span> <span>progressToken</span><span>?:</span> <a href="#progresstoken">ProgressToken</a><span>;</span> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>unknown</span> <span>}</span><span>;</span><br /> <a href="#setlevelrequestparams-level">level</a><span>:</span> <a href="#logginglevel">LoggingLevel</a><span>;</span><br /><span>}</span></div><div><p>Parameters for a <code>logging/setLevel</code> request.</p> </div><section><div><span>\_meta?: \{ progressToken?: ProgressToken; \[key: string]: unknown }</span><a href="#setlevelrequestparams-_meta" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>See <a href="/specification/2025-11-25/basic/index#meta">General fields: <code>\_meta</code></a> for notes on <code>\_meta</code> usage.</p> </div><div><div>Type Declaration</div><ul><li><div><span>\[</span><span>key</span>: <span>string</span><span>]:</span> <span>unknown</span></div></li><li><div><code>Optional</code><span>progressToken</span><span>?: </span><a href="#progresstoken">ProgressToken</a></div><div><p>If specified, the caller is requesting out-of-band progress notifications for this request (as represented by notifications/progress). The value of this parameter is an opaque token that will be attached to any subsequent notifications. The receiver is not obligated to provide these notifications.</p> </div></li></ul></div><aside><p>Inherited from RequestParams.\_meta</p></aside></section><section><div><span>level: LoggingLevel</span><a href="#setlevelrequestparams-level" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>The level of logging that the client wants to receive from the server. The server should send all logs at this level and higher (i.e., more severe) to the client as notifications/message.</p> </div></section> | |
| </div> | |
| ## `notifications/cancelled` | |
| <div> | |
| ### `CancelledNotification` | |
| <div><span>interface</span> <span>CancelledNotification</span> <span>\{</span><br /> <a href="#cancellednotification-jsonrpc">jsonrpc</a><span>:</span> <span>"2.0"</span><span>;</span><br /> <a href="#cancellednotification-method">method</a><span>:</span> <span>"notifications/cancelled"</span><span>;</span><br /> <a href="#cancellednotification-params">params</a><span>:</span> <a href="#cancellednotificationparams">CancelledNotificationParams</a><span>;</span><br /><span>}</span></div><div><p>This notification can be sent by either side to indicate that it is cancelling a previously-issued request.</p> <p>The request SHOULD still be in-flight, but due to communication latency, it is always possible that this notification MAY arrive after the request has already finished.</p> <p>This notification indicates that the result will be unused, so any associated processing SHOULD cease.</p> <p>A client MUST NOT attempt to cancel its <code>initialize</code> request.</p> <p>For task cancellation, use the <code>tasks/cancel</code> request instead of this notification.</p> </div><section><div><span>jsonrpc: "2.0"</span><a href="#cancellednotification-jsonrpc" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Inherited from <a href="#jsonrpcnotification">JSONRPCNotification</a>.<a href="#jsonrpcnotification-jsonrpc">jsonrpc</a></p></aside></section><section><div><span>method: "notifications/cancelled"</span><a href="#cancellednotification-method" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Overrides <a href="#jsonrpcnotification">JSONRPCNotification</a>.<a href="#jsonrpcnotification-method">method</a></p></aside></section><section><div><span>params: CancelledNotificationParams</span><a href="#cancellednotification-params" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Overrides <a href="#jsonrpcnotification">JSONRPCNotification</a>.<a href="#jsonrpcnotification-params">params</a></p></aside></section> | |
| </div> | |
| <div> | |
| ### `CancelledNotificationParams` | |
| <div><span>interface</span> <span>CancelledNotificationParams</span> <span>\{</span><br /> <a href="#cancellednotificationparams-_meta">\_meta</a><span>?:</span> <span>\{</span> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>unknown</span> <span>}</span><span>;</span><br /> <a href="#cancellednotificationparams-requestid">requestId</a><span>?:</span> <a href="#requestid">RequestId</a><span>;</span><br /> <a href="#cancellednotificationparams-reason">reason</a><span>?:</span> <span>string</span><span>;</span><br /><span>}</span></div><div><p>Parameters for a <code>notifications/cancelled</code> notification.</p> </div><section><div><span>\_meta?: \{ \[key: string]: unknown }</span><a href="#cancellednotificationparams-_meta" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>See <a href="/specification/2025-11-25/basic/index#meta">General fields: <code>\_meta</code></a> for notes on <code>\_meta</code> usage.</p> </div><aside><p>Inherited from NotificationParams.\_meta</p></aside></section><section><div><span>requestId?: RequestId</span><a href="#cancellednotificationparams-requestid" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>The ID of the request to cancel.</p> <p>This MUST correspond to the ID of a request previously issued in the same direction. | |
| This MUST be provided for cancelling non-task requests. | |
| This MUST NOT be used for cancelling tasks (use the <code>tasks/cancel</code> request instead).</p> </div></section><section><div><span>reason?: string</span><a href="#cancellednotificationparams-reason" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>An optional string describing the reason for the cancellation. This MAY be logged or presented to the user.</p> </div></section> | |
| </div> | |
| ## `notifications/initialized` | |
| <div> | |
| ### `InitializedNotification` | |
| <div><span>interface</span> <span>InitializedNotification</span> <span>\{</span><br /> <a href="#initializednotification-jsonrpc">jsonrpc</a><span>:</span> <span>"2.0"</span><span>;</span><br /> <a href="#initializednotification-method">method</a><span>:</span> <span>"notifications/initialized"</span><span>;</span><br /> <a href="#initializednotification-params">params</a><span>?:</span> <span>NotificationParams</span><span>;</span><br /><span>}</span></div><div><p>This notification is sent from the client to the server after initialization has finished.</p> </div><section><div><span>jsonrpc: "2.0"</span><a href="#initializednotification-jsonrpc" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Inherited from <a href="#jsonrpcnotification">JSONRPCNotification</a>.<a href="#jsonrpcnotification-jsonrpc">jsonrpc</a></p></aside></section><section><div><span>method: "notifications/initialized"</span><a href="#initializednotification-method" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Overrides <a href="#jsonrpcnotification">JSONRPCNotification</a>.<a href="#jsonrpcnotification-method">method</a></p></aside></section><section><div><span>params?: NotificationParams</span><a href="#initializednotification-params" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Overrides <a href="#jsonrpcnotification">JSONRPCNotification</a>.<a href="#jsonrpcnotification-params">params</a></p></aside></section> | |
| </div> | |
| ## `notifications/tasks/status` | |
| <div> | |
| ### `TaskStatusNotification` | |
| <div><span>interface</span> <span>TaskStatusNotification</span> <span>\{</span><br /> <a href="#taskstatusnotification-jsonrpc">jsonrpc</a><span>:</span> <span>"2.0"</span><span>;</span><br /> <a href="#taskstatusnotification-method">method</a><span>:</span> <span>"notifications/tasks/status"</span><span>;</span><br /> <a href="#taskstatusnotification-params">params</a><span>:</span> <a href="#taskstatusnotificationparams">TaskStatusNotificationParams</a><span>;</span><br /><span>}</span></div><div><p>An optional notification from the receiver to the requestor, informing them that a task's status has changed. Receivers are not required to send these notifications.</p> </div><section><div><span>jsonrpc: "2.0"</span><a href="#taskstatusnotification-jsonrpc" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Inherited from <a href="#jsonrpcnotification">JSONRPCNotification</a>.<a href="#jsonrpcnotification-jsonrpc">jsonrpc</a></p></aside></section><section><div><span>method: "notifications/tasks/status"</span><a href="#taskstatusnotification-method" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Overrides <a href="#jsonrpcnotification">JSONRPCNotification</a>.<a href="#jsonrpcnotification-method">method</a></p></aside></section><section><div><span>params: TaskStatusNotificationParams</span><a href="#taskstatusnotification-params" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Overrides <a href="#jsonrpcnotification">JSONRPCNotification</a>.<a href="#jsonrpcnotification-params">params</a></p></aside></section> | |
| </div> | |
| <div> | |
| ### `TaskStatusNotificationParams` | |
| <div><span>TaskStatusNotificationParams</span><span>:</span> <span>NotificationParams</span> <span>&</span> <a href="#task">Task</a></div><div><p>Parameters for a <code>notifications/tasks/status</code> notification.</p> </div> | |
| </div> | |
| ## `notifications/message` | |
| <div> | |
| ### `LoggingMessageNotification` | |
| <div><span>interface</span> <span>LoggingMessageNotification</span> <span>\{</span><br /> <a href="#loggingmessagenotification-jsonrpc">jsonrpc</a><span>:</span> <span>"2.0"</span><span>;</span><br /> <a href="#loggingmessagenotification-method">method</a><span>:</span> <span>"notifications/message"</span><span>;</span><br /> <a href="#loggingmessagenotification-params">params</a><span>:</span> <a href="#loggingmessagenotificationparams">LoggingMessageNotificationParams</a><span>;</span><br /><span>}</span></div><div><p>JSONRPCNotification of a log message passed from server to client. If no logging/setLevel request has been sent from the client, the server MAY decide which messages to send automatically.</p> </div><section><div><span>jsonrpc: "2.0"</span><a href="#loggingmessagenotification-jsonrpc" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Inherited from <a href="#jsonrpcnotification">JSONRPCNotification</a>.<a href="#jsonrpcnotification-jsonrpc">jsonrpc</a></p></aside></section><section><div><span>method: "notifications/message"</span><a href="#loggingmessagenotification-method" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Overrides <a href="#jsonrpcnotification">JSONRPCNotification</a>.<a href="#jsonrpcnotification-method">method</a></p></aside></section><section><div><span>params: LoggingMessageNotificationParams</span><a href="#loggingmessagenotification-params" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Overrides <a href="#jsonrpcnotification">JSONRPCNotification</a>.<a href="#jsonrpcnotification-params">params</a></p></aside></section> | |
| </div> | |
| <div> | |
| ### `LoggingMessageNotificationParams` | |
| <div><span>interface</span> <span>LoggingMessageNotificationParams</span> <span>\{</span><br /> <a href="#loggingmessagenotificationparams-_meta">\_meta</a><span>?:</span> <span>\{</span> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>unknown</span> <span>}</span><span>;</span><br /> <a href="#loggingmessagenotificationparams-level">level</a><span>:</span> <a href="#logginglevel">LoggingLevel</a><span>;</span><br /> <a href="#loggingmessagenotificationparams-logger">logger</a><span>?:</span> <span>string</span><span>;</span><br /> <a href="#loggingmessagenotificationparams-data">data</a><span>:</span> <span>unknown</span><span>;</span><br /><span>}</span></div><div><p>Parameters for a <code>notifications/message</code> notification.</p> </div><section><div><span>\_meta?: \{ \[key: string]: unknown }</span><a href="#loggingmessagenotificationparams-_meta" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>See <a href="/specification/2025-11-25/basic/index#meta">General fields: <code>\_meta</code></a> for notes on <code>\_meta</code> usage.</p> </div><aside><p>Inherited from NotificationParams.\_meta</p></aside></section><section><div><span>level: LoggingLevel</span><a href="#loggingmessagenotificationparams-level" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>The severity of this log message.</p> </div></section><section><div><span>logger?: string</span><a href="#loggingmessagenotificationparams-logger" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>An optional name of the logger issuing this message.</p> </div></section><section><div><span>data: unknown</span><a href="#loggingmessagenotificationparams-data" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>The data to be logged, such as a string message or an object. Any JSON serializable type is allowed here.</p> </div></section> | |
| </div> | |
| ## `notifications/progress` | |
| <div> | |
| ### `ProgressNotification` | |
| <div><span>interface</span> <span>ProgressNotification</span> <span>\{</span><br /> <a href="#progressnotification-jsonrpc">jsonrpc</a><span>:</span> <span>"2.0"</span><span>;</span><br /> <a href="#progressnotification-method">method</a><span>:</span> <span>"notifications/progress"</span><span>;</span><br /> <a href="#progressnotification-params">params</a><span>:</span> <a href="#progressnotificationparams">ProgressNotificationParams</a><span>;</span><br /><span>}</span></div><div><p>An out-of-band notification used to inform the receiver of a progress update for a long-running request.</p> </div><section><div><span>jsonrpc: "2.0"</span><a href="#progressnotification-jsonrpc" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Inherited from <a href="#jsonrpcnotification">JSONRPCNotification</a>.<a href="#jsonrpcnotification-jsonrpc">jsonrpc</a></p></aside></section><section><div><span>method: "notifications/progress"</span><a href="#progressnotification-method" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Overrides <a href="#jsonrpcnotification">JSONRPCNotification</a>.<a href="#jsonrpcnotification-method">method</a></p></aside></section><section><div><span>params: ProgressNotificationParams</span><a href="#progressnotification-params" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Overrides <a href="#jsonrpcnotification">JSONRPCNotification</a>.<a href="#jsonrpcnotification-params">params</a></p></aside></section> | |
| </div> | |
| <div> | |
| ### `ProgressNotificationParams` | |
| <div><span>interface</span> <span>ProgressNotificationParams</span> <span>\{</span><br /> <a href="#progressnotificationparams-_meta">\_meta</a><span>?:</span> <span>\{</span> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>unknown</span> <span>}</span><span>;</span><br /> <a href="#progressnotificationparams-progresstoken">progressToken</a><span>:</span> <a href="#progresstoken">ProgressToken</a><span>;</span><br /> <a href="#progressnotificationparams-progress">progress</a><span>:</span> <span>number</span><span>;</span><br /> <a href="#progressnotificationparams-total">total</a><span>?:</span> <span>number</span><span>;</span><br /> <a href="#progressnotificationparams-message">message</a><span>?:</span> <span>string</span><span>;</span><br /><span>}</span></div><div><p>Parameters for a <code>notifications/progress</code> notification.</p> </div><section><div><span>\_meta?: \{ \[key: string]: unknown }</span><a href="#progressnotificationparams-_meta" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>See <a href="/specification/2025-11-25/basic/index#meta">General fields: <code>\_meta</code></a> for notes on <code>\_meta</code> usage.</p> </div><aside><p>Inherited from NotificationParams.\_meta</p></aside></section><section><div><span>progressToken: ProgressToken</span><a href="#progressnotificationparams-progresstoken" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>The progress token which was given in the initial request, used to associate this notification with the request that is proceeding.</p> </div></section><section><div><span>progress: number</span><a href="#progressnotificationparams-progress" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>The progress thus far. This should increase every time progress is made, even if the total is unknown.</p> </div></section><section><div><span>total?: number</span><a href="#progressnotificationparams-total" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Total number of items to process (or total progress required), if known.</p> </div></section><section><div><span>message?: string</span><a href="#progressnotificationparams-message" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>An optional message describing the current progress.</p> </div></section> | |
| </div> | |
| ## `notifications/prompts/list_changed` | |
| <div> | |
| ### `PromptListChangedNotification` | |
| <div><span>interface</span> <span>PromptListChangedNotification</span> <span>\{</span><br /> <a href="#promptlistchangednotification-jsonrpc">jsonrpc</a><span>:</span> <span>"2.0"</span><span>;</span><br /> <a href="#promptlistchangednotification-method">method</a><span>:</span> <span>"notifications/prompts/list\_changed"</span><span>;</span><br /> <a href="#promptlistchangednotification-params">params</a><span>?:</span> <span>NotificationParams</span><span>;</span><br /><span>}</span></div><div><p>An optional notification from the server to the client, informing it that the list of prompts it offers has changed. This may be issued by servers without any previous subscription from the client.</p> </div><section><div><span>jsonrpc: "2.0"</span><a href="#promptlistchangednotification-jsonrpc" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Inherited from <a href="#jsonrpcnotification">JSONRPCNotification</a>.<a href="#jsonrpcnotification-jsonrpc">jsonrpc</a></p></aside></section><section><div><span>method: "notifications/prompts/list\_changed"</span><a href="#promptlistchangednotification-method" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Overrides <a href="#jsonrpcnotification">JSONRPCNotification</a>.<a href="#jsonrpcnotification-method">method</a></p></aside></section><section><div><span>params?: NotificationParams</span><a href="#promptlistchangednotification-params" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Overrides <a href="#jsonrpcnotification">JSONRPCNotification</a>.<a href="#jsonrpcnotification-params">params</a></p></aside></section> | |
| </div> | |
| ## `notifications/resources/list_changed` | |
| <div> | |
| ### `ResourceListChangedNotification` | |
| <div><span>interface</span> <span>ResourceListChangedNotification</span> <span>\{</span><br /> <a href="#resourcelistchangednotification-jsonrpc">jsonrpc</a><span>:</span> <span>"2.0"</span><span>;</span><br /> <a href="#resourcelistchangednotification-method">method</a><span>:</span> <span>"notifications/resources/list\_changed"</span><span>;</span><br /> <a href="#resourcelistchangednotification-params">params</a><span>?:</span> <span>NotificationParams</span><span>;</span><br /><span>}</span></div><div><p>An optional notification from the server to the client, informing it that the list of resources it can read from has changed. This may be issued by servers without any previous subscription from the client.</p> </div><section><div><span>jsonrpc: "2.0"</span><a href="#resourcelistchangednotification-jsonrpc" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Inherited from <a href="#jsonrpcnotification">JSONRPCNotification</a>.<a href="#jsonrpcnotification-jsonrpc">jsonrpc</a></p></aside></section><section><div><span>method: "notifications/resources/list\_changed"</span><a href="#resourcelistchangednotification-method" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Overrides <a href="#jsonrpcnotification">JSONRPCNotification</a>.<a href="#jsonrpcnotification-method">method</a></p></aside></section><section><div><span>params?: NotificationParams</span><a href="#resourcelistchangednotification-params" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Overrides <a href="#jsonrpcnotification">JSONRPCNotification</a>.<a href="#jsonrpcnotification-params">params</a></p></aside></section> | |
| </div> | |
| ## `notifications/resources/updated` | |
| <div> | |
| ### `ResourceUpdatedNotification` | |
| <div><span>interface</span> <span>ResourceUpdatedNotification</span> <span>\{</span><br /> <a href="#resourceupdatednotification-jsonrpc">jsonrpc</a><span>:</span> <span>"2.0"</span><span>;</span><br /> <a href="#resourceupdatednotification-method">method</a><span>:</span> <span>"notifications/resources/updated"</span><span>;</span><br /> <a href="#resourceupdatednotification-params">params</a><span>:</span> <a href="#resourceupdatednotificationparams">ResourceUpdatedNotificationParams</a><span>;</span><br /><span>}</span></div><div><p>A notification from the server to the client, informing it that a resource has changed and may need to be read again. This should only be sent if the client previously sent a resources/subscribe request.</p> </div><section><div><span>jsonrpc: "2.0"</span><a href="#resourceupdatednotification-jsonrpc" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Inherited from <a href="#jsonrpcnotification">JSONRPCNotification</a>.<a href="#jsonrpcnotification-jsonrpc">jsonrpc</a></p></aside></section><section><div><span>method: "notifications/resources/updated"</span><a href="#resourceupdatednotification-method" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Overrides <a href="#jsonrpcnotification">JSONRPCNotification</a>.<a href="#jsonrpcnotification-method">method</a></p></aside></section><section><div><span>params: ResourceUpdatedNotificationParams</span><a href="#resourceupdatednotification-params" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Overrides <a href="#jsonrpcnotification">JSONRPCNotification</a>.<a href="#jsonrpcnotification-params">params</a></p></aside></section> | |
| </div> | |
| <div> | |
| ### `ResourceUpdatedNotificationParams` | |
| <div><span>interface</span> <span>ResourceUpdatedNotificationParams</span> <span>\{</span><br /> <a href="#resourceupdatednotificationparams-_meta">\_meta</a><span>?:</span> <span>\{</span> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>unknown</span> <span>}</span><span>;</span><br /> <a href="#resourceupdatednotificationparams-uri">uri</a><span>:</span> <span>string</span><span>;</span><br /><span>}</span></div><div><p>Parameters for a <code>notifications/resources/updated</code> notification.</p> </div><section><div><span>\_meta?: \{ \[key: string]: unknown }</span><a href="#resourceupdatednotificationparams-_meta" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>See <a href="/specification/2025-11-25/basic/index#meta">General fields: <code>\_meta</code></a> for notes on <code>\_meta</code> usage.</p> </div><aside><p>Inherited from NotificationParams.\_meta</p></aside></section><section><div><span>uri: string</span><a href="#resourceupdatednotificationparams-uri" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>The URI of the resource that has been updated. This might be a sub-resource of the one that the client actually subscribed to.</p> </div></section> | |
| </div> | |
| ## `notifications/roots/list_changed` | |
| <div> | |
| ### `RootsListChangedNotification` | |
| <div><span>interface</span> <span>RootsListChangedNotification</span> <span>\{</span><br /> <a href="#rootslistchangednotification-jsonrpc">jsonrpc</a><span>:</span> <span>"2.0"</span><span>;</span><br /> <a href="#rootslistchangednotification-method">method</a><span>:</span> <span>"notifications/roots/list\_changed"</span><span>;</span><br /> <a href="#rootslistchangednotification-params">params</a><span>?:</span> <span>NotificationParams</span><span>;</span><br /><span>}</span></div><div><p>A notification from the client to the server, informing it that the list of roots has changed. | |
| This notification should be sent whenever the client adds, removes, or modifies any root. | |
| The server should then request an updated list of roots using the ListRootsRequest.</p> </div><section><div><span>jsonrpc: "2.0"</span><a href="#rootslistchangednotification-jsonrpc" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Inherited from <a href="#jsonrpcnotification">JSONRPCNotification</a>.<a href="#jsonrpcnotification-jsonrpc">jsonrpc</a></p></aside></section><section><div><span>method: "notifications/roots/list\_changed"</span><a href="#rootslistchangednotification-method" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Overrides <a href="#jsonrpcnotification">JSONRPCNotification</a>.<a href="#jsonrpcnotification-method">method</a></p></aside></section><section><div><span>params?: NotificationParams</span><a href="#rootslistchangednotification-params" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Overrides <a href="#jsonrpcnotification">JSONRPCNotification</a>.<a href="#jsonrpcnotification-params">params</a></p></aside></section> | |
| </div> | |
| ## `notifications/tools/list_changed` | |
| <div> | |
| ### `ToolListChangedNotification` | |
| <div><span>interface</span> <span>ToolListChangedNotification</span> <span>\{</span><br /> <a href="#toollistchangednotification-jsonrpc">jsonrpc</a><span>:</span> <span>"2.0"</span><span>;</span><br /> <a href="#toollistchangednotification-method">method</a><span>:</span> <span>"notifications/tools/list\_changed"</span><span>;</span><br /> <a href="#toollistchangednotification-params">params</a><span>?:</span> <span>NotificationParams</span><span>;</span><br /><span>}</span></div><div><p>An optional notification from the server to the client, informing it that the list of tools it offers has changed. This may be issued by servers without any previous subscription from the client.</p> </div><section><div><span>jsonrpc: "2.0"</span><a href="#toollistchangednotification-jsonrpc" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Inherited from <a href="#jsonrpcnotification">JSONRPCNotification</a>.<a href="#jsonrpcnotification-jsonrpc">jsonrpc</a></p></aside></section><section><div><span>method: "notifications/tools/list\_changed"</span><a href="#toollistchangednotification-method" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Overrides <a href="#jsonrpcnotification">JSONRPCNotification</a>.<a href="#jsonrpcnotification-method">method</a></p></aside></section><section><div><span>params?: NotificationParams</span><a href="#toollistchangednotification-params" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Overrides <a href="#jsonrpcnotification">JSONRPCNotification</a>.<a href="#jsonrpcnotification-params">params</a></p></aside></section> | |
| </div> | |
| ## `notifications/elicitation/complete` | |
| <div> | |
| ### `ElicitationCompleteNotification` | |
| <div><span>interface</span> <span>ElicitationCompleteNotification</span> <span>\{</span><br /> <a href="#elicitationcompletenotification-jsonrpc">jsonrpc</a><span>:</span> <span>"2.0"</span><span>;</span><br /> <a href="#elicitationcompletenotification-method">method</a><span>:</span> <span>"notifications/elicitation/complete"</span><span>;</span><br /> <a href="#elicitationcompletenotification-params">params</a><span>:</span> <span>\{</span> <span>elicitationId</span><span>:</span> <span>string</span> <span>}</span><span>;</span><br /><span>}</span></div><div><p>An optional notification from the server to the client, informing it of a completion of a out-of-band elicitation request.</p> </div><section><div><span>jsonrpc: "2.0"</span><a href="#elicitationcompletenotification-jsonrpc" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Inherited from <a href="#jsonrpcnotification">JSONRPCNotification</a>.<a href="#jsonrpcnotification-jsonrpc">jsonrpc</a></p></aside></section><section><div><span>method: "notifications/elicitation/complete"</span><a href="#elicitationcompletenotification-method" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Overrides <a href="#jsonrpcnotification">JSONRPCNotification</a>.<a href="#jsonrpcnotification-method">method</a></p></aside></section><section><div><span>params: \{ elicitationId: string }</span><a href="#elicitationcompletenotification-params" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><div>Type Declaration</div><ul><li><div><span>elicitationId</span><span>: </span><span>string</span></div><div><p>The ID of the elicitation that completed.</p> </div></li></ul></div><aside><p>Overrides <a href="#jsonrpcnotification">JSONRPCNotification</a>.<a href="#jsonrpcnotification-params">params</a></p></aside></section> | |
| </div> | |
| ## `ping` | |
| <div> | |
| ### `PingRequest` | |
| <div><span>interface</span> <span>PingRequest</span> <span>\{</span><br /> <a href="#pingrequest-jsonrpc">jsonrpc</a><span>:</span> <span>"2.0"</span><span>;</span><br /> <a href="#pingrequest-id">id</a><span>:</span> <a href="#requestid">RequestId</a><span>;</span><br /> <a href="#pingrequest-method">method</a><span>:</span> <span>"ping"</span><span>;</span><br /> <a href="#pingrequest-params">params</a><span>?:</span> <span>RequestParams</span><span>;</span><br /><span>}</span></div><div><p>A ping, issued by either the server or the client, to check that the other party is still alive. The receiver must promptly respond, or else may be disconnected.</p> </div><section><div><span>jsonrpc: "2.0"</span><a href="#pingrequest-jsonrpc" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Inherited from <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-jsonrpc">jsonrpc</a></p></aside></section><section><div><span>id: RequestId</span><a href="#pingrequest-id" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Inherited from <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-id">id</a></p></aside></section><section><div><span>method: "ping"</span><a href="#pingrequest-method" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Overrides <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-method">method</a></p></aside></section><section><div><span>params?: RequestParams</span><a href="#pingrequest-params" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Overrides <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-params">params</a></p></aside></section> | |
| </div> | |
| ## `tasks` | |
| <div> | |
| ### `CreateTaskResult` | |
| <div><span>interface</span> <span>CreateTaskResult</span> <span>\{</span><br /> <a href="#createtaskresult-_meta">\_meta</a><span>?:</span> <span>\{</span> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>unknown</span> <span>}</span><span>;</span><br /> <a href="#createtaskresult-task">task</a><span>:</span> <a href="#task">Task</a><span>;</span><br /> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>unknown</span><span>;</span><br /><span>}</span></div><div><p>A response to a task-augmented request.</p> </div><section><div><span>\_meta?: \{ \[key: string]: unknown }</span><a href="#createtaskresult-_meta" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>See <a href="/specification/2025-11-25/basic/index#meta">General fields: <code>\_meta</code></a> for notes on <code>\_meta</code> usage.</p> </div><aside><p>Inherited from <a href="#result">Result</a>.<a href="#result-_meta">\_meta</a></p></aside></section><section><div><span>task: Task</span><a href="#createtaskresult-task" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section> | |
| </div> | |
| <div> | |
| ### `RelatedTaskMetadata` | |
| <div><span>interface</span> <span>RelatedTaskMetadata</span> <span>\{</span><br /> <a href="#relatedtaskmetadata-taskid">taskId</a><span>:</span> <span>string</span><span>;</span><br /><span>}</span></div><div><p>Metadata for associating messages with a task. | |
| Include this in the <code>\_meta</code> field under the key <code>io.modelcontextprotocol/related-task</code>.</p> </div><section><div><span>taskId: string</span><a href="#relatedtaskmetadata-taskid" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>The task identifier this message is associated with.</p> </div></section> | |
| </div> | |
| <div> | |
| ### `Task` | |
| <div><span>interface</span> <span>Task</span> <span>\{</span><br /> <a href="#task-taskid">taskId</a><span>:</span> <span>string</span><span>;</span><br /> <a href="#task-status">status</a><span>:</span> <a href="#taskstatus">TaskStatus</a><span>;</span><br /> <a href="#task-statusmessage">statusMessage</a><span>?:</span> <span>string</span><span>;</span><br /> <a href="#task-createdat">createdAt</a><span>:</span> <span>string</span><span>;</span><br /> <a href="#task-lastupdatedat">lastUpdatedAt</a><span>:</span> <span>string</span><span>;</span><br /> <a href="#task-ttl">ttl</a><span>:</span> <span>number</span> <span>|</span> <span>null</span><span>;</span><br /> <a href="#task-pollinterval">pollInterval</a><span>?:</span> <span>number</span><span>;</span><br /><span>}</span></div><div><p>Data associated with a task.</p> </div><section><div><span>taskId: string</span><a href="#task-taskid" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>The task identifier.</p> </div></section><section><div><span>status: TaskStatus</span><a href="#task-status" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Current task state.</p> </div></section><section><div><span>statusMessage?: string</span><a href="#task-statusmessage" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Optional human-readable message describing the current task state. | |
| This can provide context for any status, including:</p> <ul> <li>Reasons for "cancelled" status</li> <li>Summaries for "completed" status</li> <li>Diagnostic information for "failed" status (e.g., error details, what went wrong)</li> </ul> </div></section><section><div><span>createdAt: string</span><a href="#task-createdat" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>ISO 8601 timestamp when the task was created.</p> </div></section><section><div><span>lastUpdatedAt: string</span><a href="#task-lastupdatedat" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>ISO 8601 timestamp when the task was last updated.</p> </div></section><section><div><span>ttl: number | null</span><a href="#task-ttl" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Actual retention duration from creation in milliseconds, null for unlimited.</p> </div></section><section><div><span>pollInterval?: number</span><a href="#task-pollinterval" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Suggested polling interval in milliseconds.</p> </div></section> | |
| </div> | |
| <div> | |
| ### `TaskMetadata` | |
| <div><span>interface</span> <span>TaskMetadata</span> <span>\{</span><br /> <a href="#taskmetadata-ttl">ttl</a><span>?:</span> <span>number</span><span>;</span><br /><span>}</span></div><div><p>Metadata for augmenting a request with task execution. | |
| Include this in the <code>task</code> field of the request parameters.</p> </div><section><div><span>ttl?: number</span><a href="#taskmetadata-ttl" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Requested duration in milliseconds to retain task from creation.</p> </div></section> | |
| </div> | |
| <div> | |
| ### `TaskStatus` | |
| <div><span>TaskStatus</span><span>:</span> <span>"working"</span> <span>|</span> <span>"input\_required"</span> <span>|</span> <span>"completed"</span> <span>|</span> <span>"failed"</span> <span>|</span> <span>"cancelled"</span></div><div><p>The status of a task.</p> </div> | |
| </div> | |
| ## `tasks/get` | |
| <div> | |
| ### `GetTaskRequest` | |
| <div><span>interface</span> <span>GetTaskRequest</span> <span>\{</span><br /> <a href="#gettaskrequest-jsonrpc">jsonrpc</a><span>:</span> <span>"2.0"</span><span>;</span><br /> <a href="#gettaskrequest-id">id</a><span>:</span> <a href="#requestid">RequestId</a><span>;</span><br /> <a href="#gettaskrequest-method">method</a><span>:</span> <span>"tasks/get"</span><span>;</span><br /> <a href="#gettaskrequest-params">params</a><span>:</span> <span>\{</span> <span>taskId</span><span>:</span> <span>string</span> <span>}</span><span>;</span><br /><span>}</span></div><div><p>A request to retrieve the state of a task.</p> </div><section><div><span>jsonrpc: "2.0"</span><a href="#gettaskrequest-jsonrpc" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Inherited from <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-jsonrpc">jsonrpc</a></p></aside></section><section><div><span>id: RequestId</span><a href="#gettaskrequest-id" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Inherited from <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-id">id</a></p></aside></section><section><div><span>method: "tasks/get"</span><a href="#gettaskrequest-method" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Overrides <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-method">method</a></p></aside></section><section><div><span>params: \{ taskId: string }</span><a href="#gettaskrequest-params" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><div>Type Declaration</div><ul><li><div><span>taskId</span><span>: </span><span>string</span></div><div><p>The task identifier to query.</p> </div></li></ul></div><aside><p>Overrides <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-params">params</a></p></aside></section> | |
| </div> | |
| <div> | |
| ### `GetTaskResult` | |
| <div><span>GetTaskResult</span><span>:</span> <a href="#result">Result</a> <span>&</span> <a href="#task">Task</a></div><div><p>The response to a tasks/get request.</p> </div> | |
| </div> | |
| ## `tasks/result` | |
| <div> | |
| ### `GetTaskPayloadRequest` | |
| <div><span>interface</span> <span>GetTaskPayloadRequest</span> <span>\{</span><br /> <a href="#gettaskpayloadrequest-jsonrpc">jsonrpc</a><span>:</span> <span>"2.0"</span><span>;</span><br /> <a href="#gettaskpayloadrequest-id">id</a><span>:</span> <a href="#requestid">RequestId</a><span>;</span><br /> <a href="#gettaskpayloadrequest-method">method</a><span>:</span> <span>"tasks/result"</span><span>;</span><br /> <a href="#gettaskpayloadrequest-params">params</a><span>:</span> <span>\{</span> <span>taskId</span><span>:</span> <span>string</span> <span>}</span><span>;</span><br /><span>}</span></div><div><p>A request to retrieve the result of a completed task.</p> </div><section><div><span>jsonrpc: "2.0"</span><a href="#gettaskpayloadrequest-jsonrpc" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Inherited from <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-jsonrpc">jsonrpc</a></p></aside></section><section><div><span>id: RequestId</span><a href="#gettaskpayloadrequest-id" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Inherited from <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-id">id</a></p></aside></section><section><div><span>method: "tasks/result"</span><a href="#gettaskpayloadrequest-method" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Overrides <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-method">method</a></p></aside></section><section><div><span>params: \{ taskId: string }</span><a href="#gettaskpayloadrequest-params" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><div>Type Declaration</div><ul><li><div><span>taskId</span><span>: </span><span>string</span></div><div><p>The task identifier to retrieve results for.</p> </div></li></ul></div><aside><p>Overrides <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-params">params</a></p></aside></section> | |
| </div> | |
| <div> | |
| ### `GetTaskPayloadResult` | |
| <div><span>interface</span> <span>GetTaskPayloadResult</span> <span>\{</span><br /> <a href="#gettaskpayloadresult-_meta">\_meta</a><span>?:</span> <span>\{</span> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>unknown</span> <span>}</span><span>;</span><br /> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>unknown</span><span>;</span><br /><span>}</span></div><div><p>The response to a tasks/result request. | |
| The structure matches the result type of the original request. | |
| For example, a tools/call task would return the CallToolResult structure.</p> </div><section><div><span>\_meta?: \{ \[key: string]: unknown }</span><a href="#gettaskpayloadresult-_meta" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>See <a href="/specification/2025-11-25/basic/index#meta">General fields: <code>\_meta</code></a> for notes on <code>\_meta</code> usage.</p> </div><aside><p>Inherited from <a href="#result">Result</a>.<a href="#result-_meta">\_meta</a></p></aside></section> | |
| </div> | |
| ## `tasks/list` | |
| <div> | |
| ### `ListTasksRequest` | |
| <div><span>interface</span> <span>ListTasksRequest</span> <span>\{</span><br /> <a href="#listtasksrequest-jsonrpc">jsonrpc</a><span>:</span> <span>"2.0"</span><span>;</span><br /> <a href="#listtasksrequest-id">id</a><span>:</span> <a href="#requestid">RequestId</a><span>;</span><br /> <a href="#listtasksrequest-params">params</a><span>?:</span> <span>PaginatedRequestParams</span><span>;</span><br /> <a href="#listtasksrequest-method">method</a><span>:</span> <span>"tasks/list"</span><span>;</span><br /><span>}</span></div><div><p>A request to retrieve a list of tasks.</p> </div><section><div><span>jsonrpc: "2.0"</span><a href="#listtasksrequest-jsonrpc" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Inherited from PaginatedRequest.jsonrpc</p></aside></section><section><div><span>id: RequestId</span><a href="#listtasksrequest-id" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Inherited from PaginatedRequest.id</p></aside></section><section><div><span>params?: PaginatedRequestParams</span><a href="#listtasksrequest-params" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Inherited from PaginatedRequest.params</p></aside></section><section><div><span>method: "tasks/list"</span><a href="#listtasksrequest-method" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Overrides PaginatedRequest.method</p></aside></section> | |
| </div> | |
| <div> | |
| ### `ListTasksResult` | |
| <div><span>interface</span> <span>ListTasksResult</span> <span>\{</span><br /> <a href="#listtasksresult-_meta">\_meta</a><span>?:</span> <span>\{</span> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>unknown</span> <span>}</span><span>;</span><br /> <a href="#listtasksresult-nextcursor">nextCursor</a><span>?:</span> <span>string</span><span>;</span><br /> <a href="#listtasksresult-tasks">tasks</a><span>:</span> <a href="#task">Task</a><span>\[]</span><span>;</span><br /> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>unknown</span><span>;</span><br /><span>}</span></div><div><p>The response to a tasks/list request.</p> </div><section><div><span>\_meta?: \{ \[key: string]: unknown }</span><a href="#listtasksresult-_meta" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>See <a href="/specification/2025-11-25/basic/index#meta">General fields: <code>\_meta</code></a> for notes on <code>\_meta</code> usage.</p> </div><aside><p>Inherited from PaginatedResult.\_meta</p></aside></section><section><div><span>nextCursor?: string</span><a href="#listtasksresult-nextcursor" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>An opaque token representing the pagination position after the last returned result. | |
| If present, there may be more results available.</p> </div><aside><p>Inherited from PaginatedResult.nextCursor</p></aside></section><section><div><span>tasks: Task\[]</span><a href="#listtasksresult-tasks" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section> | |
| </div> | |
| ## `tasks/cancel` | |
| <div> | |
| ### `CancelTaskRequest` | |
| <div><span>interface</span> <span>CancelTaskRequest</span> <span>\{</span><br /> <a href="#canceltaskrequest-jsonrpc">jsonrpc</a><span>:</span> <span>"2.0"</span><span>;</span><br /> <a href="#canceltaskrequest-id">id</a><span>:</span> <a href="#requestid">RequestId</a><span>;</span><br /> <a href="#canceltaskrequest-method">method</a><span>:</span> <span>"tasks/cancel"</span><span>;</span><br /> <a href="#canceltaskrequest-params">params</a><span>:</span> <span>\{</span> <span>taskId</span><span>:</span> <span>string</span> <span>}</span><span>;</span><br /><span>}</span></div><div><p>A request to cancel a task.</p> </div><section><div><span>jsonrpc: "2.0"</span><a href="#canceltaskrequest-jsonrpc" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Inherited from <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-jsonrpc">jsonrpc</a></p></aside></section><section><div><span>id: RequestId</span><a href="#canceltaskrequest-id" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Inherited from <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-id">id</a></p></aside></section><section><div><span>method: "tasks/cancel"</span><a href="#canceltaskrequest-method" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Overrides <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-method">method</a></p></aside></section><section><div><span>params: \{ taskId: string }</span><a href="#canceltaskrequest-params" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><div>Type Declaration</div><ul><li><div><span>taskId</span><span>: </span><span>string</span></div><div><p>The task identifier to cancel.</p> </div></li></ul></div><aside><p>Overrides <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-params">params</a></p></aside></section> | |
| </div> | |
| <div> | |
| ### `CancelTaskResult` | |
| <div><span>CancelTaskResult</span><span>:</span> <a href="#result">Result</a> <span>&</span> <a href="#task">Task</a></div><div><p>The response to a tasks/cancel request.</p> </div> | |
| </div> | |
| ## `prompts/get` | |
| <div> | |
| ### `GetPromptRequest` | |
| <div><span>interface</span> <span>GetPromptRequest</span> <span>\{</span><br /> <a href="#getpromptrequest-jsonrpc">jsonrpc</a><span>:</span> <span>"2.0"</span><span>;</span><br /> <a href="#getpromptrequest-id">id</a><span>:</span> <a href="#requestid">RequestId</a><span>;</span><br /> <a href="#getpromptrequest-method">method</a><span>:</span> <span>"prompts/get"</span><span>;</span><br /> <a href="#getpromptrequest-params">params</a><span>:</span> <a href="#getpromptrequestparams">GetPromptRequestParams</a><span>;</span><br /><span>}</span></div><div><p>Used by the client to get a prompt provided by the server.</p> </div><section><div><span>jsonrpc: "2.0"</span><a href="#getpromptrequest-jsonrpc" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Inherited from <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-jsonrpc">jsonrpc</a></p></aside></section><section><div><span>id: RequestId</span><a href="#getpromptrequest-id" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Inherited from <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-id">id</a></p></aside></section><section><div><span>method: "prompts/get"</span><a href="#getpromptrequest-method" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Overrides <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-method">method</a></p></aside></section><section><div><span>params: GetPromptRequestParams</span><a href="#getpromptrequest-params" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Overrides <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-params">params</a></p></aside></section> | |
| </div> | |
| <div> | |
| ### `GetPromptRequestParams` | |
| <div><span>interface</span> <span>GetPromptRequestParams</span> <span>\{</span><br /> <a href="#getpromptrequestparams-_meta">\_meta</a><span>?:</span> <span>\{</span> <span>progressToken</span><span>?:</span> <a href="#progresstoken">ProgressToken</a><span>;</span> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>unknown</span> <span>}</span><span>;</span><br /> <a href="#getpromptrequestparams-name">name</a><span>:</span> <span>string</span><span>;</span><br /> <a href="#getpromptrequestparams-arguments">arguments</a><span>?:</span> <span>\{</span> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>string</span> <span>}</span><span>;</span><br /><span>}</span></div><div><p>Parameters for a <code>prompts/get</code> request.</p> </div><section><div><span>\_meta?: \{ progressToken?: ProgressToken; \[key: string]: unknown }</span><a href="#getpromptrequestparams-_meta" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>See <a href="/specification/2025-11-25/basic/index#meta">General fields: <code>\_meta</code></a> for notes on <code>\_meta</code> usage.</p> </div><div><div>Type Declaration</div><ul><li><div><span>\[</span><span>key</span>: <span>string</span><span>]:</span> <span>unknown</span></div></li><li><div><code>Optional</code><span>progressToken</span><span>?: </span><a href="#progresstoken">ProgressToken</a></div><div><p>If specified, the caller is requesting out-of-band progress notifications for this request (as represented by notifications/progress). The value of this parameter is an opaque token that will be attached to any subsequent notifications. The receiver is not obligated to provide these notifications.</p> </div></li></ul></div><aside><p>Inherited from RequestParams.\_meta</p></aside></section><section><div><span>name: string</span><a href="#getpromptrequestparams-name" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>The name of the prompt or prompt template.</p> </div></section><section><div><span>arguments?: \{ \[key: string]: string }</span><a href="#getpromptrequestparams-arguments" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Arguments to use for templating the prompt.</p> </div></section> | |
| </div> | |
| <div> | |
| ### `GetPromptResult` | |
| <div><span>interface</span> <span>GetPromptResult</span> <span>\{</span><br /> <a href="#getpromptresult-_meta">\_meta</a><span>?:</span> <span>\{</span> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>unknown</span> <span>}</span><span>;</span><br /> <a href="#getpromptresult-description">description</a><span>?:</span> <span>string</span><span>;</span><br /> <a href="#getpromptresult-messages">messages</a><span>:</span> <a href="#promptmessage">PromptMessage</a><span>\[]</span><span>;</span><br /> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>unknown</span><span>;</span><br /><span>}</span></div><div><p>The server's response to a prompts/get request from the client.</p> </div><section><div><span>\_meta?: \{ \[key: string]: unknown }</span><a href="#getpromptresult-_meta" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>See <a href="/specification/2025-11-25/basic/index#meta">General fields: <code>\_meta</code></a> for notes on <code>\_meta</code> usage.</p> </div><aside><p>Inherited from <a href="#result">Result</a>.<a href="#result-_meta">\_meta</a></p></aside></section><section><div><span>description?: string</span><a href="#getpromptresult-description" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>An optional description for the prompt.</p> </div></section><section><div><span>messages: PromptMessage\[]</span><a href="#getpromptresult-messages" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section> | |
| </div> | |
| <div> | |
| ### `PromptMessage` | |
| <div><span>interface</span> <span>PromptMessage</span> <span>\{</span><br /> <a href="#promptmessage-role">role</a><span>:</span> <a href="#role">Role</a><span>;</span><br /> <a href="#promptmessage-content">content</a><span>:</span> <a href="#contentblock">ContentBlock</a><span>;</span><br /><span>}</span></div><div><p>Describes a message returned as part of a prompt.</p> <p>This is similar to <code>SamplingMessage</code>, but also supports the embedding of | |
| resources from the MCP server.</p> </div><section><div><span>role: Role</span><a href="#promptmessage-role" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section><div><span>content: ContentBlock</span><a href="#promptmessage-content" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section> | |
| </div> | |
| ## `prompts/list` | |
| <div> | |
| ### `ListPromptsRequest` | |
| <div><span>interface</span> <span>ListPromptsRequest</span> <span>\{</span><br /> <a href="#listpromptsrequest-jsonrpc">jsonrpc</a><span>:</span> <span>"2.0"</span><span>;</span><br /> <a href="#listpromptsrequest-id">id</a><span>:</span> <a href="#requestid">RequestId</a><span>;</span><br /> <a href="#listpromptsrequest-params">params</a><span>?:</span> <span>PaginatedRequestParams</span><span>;</span><br /> <a href="#listpromptsrequest-method">method</a><span>:</span> <span>"prompts/list"</span><span>;</span><br /><span>}</span></div><div><p>Sent from the client to request a list of prompts and prompt templates the server has.</p> </div><section><div><span>jsonrpc: "2.0"</span><a href="#listpromptsrequest-jsonrpc" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Inherited from PaginatedRequest.jsonrpc</p></aside></section><section><div><span>id: RequestId</span><a href="#listpromptsrequest-id" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Inherited from PaginatedRequest.id</p></aside></section><section><div><span>params?: PaginatedRequestParams</span><a href="#listpromptsrequest-params" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Inherited from PaginatedRequest.params</p></aside></section><section><div><span>method: "prompts/list"</span><a href="#listpromptsrequest-method" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Overrides PaginatedRequest.method</p></aside></section> | |
| </div> | |
| <div> | |
| ### `ListPromptsResult` | |
| <div><span>interface</span> <span>ListPromptsResult</span> <span>\{</span><br /> <a href="#listpromptsresult-_meta">\_meta</a><span>?:</span> <span>\{</span> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>unknown</span> <span>}</span><span>;</span><br /> <a href="#listpromptsresult-nextcursor">nextCursor</a><span>?:</span> <span>string</span><span>;</span><br /> <a href="#listpromptsresult-prompts">prompts</a><span>:</span> <a href="#prompt">Prompt</a><span>\[]</span><span>;</span><br /> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>unknown</span><span>;</span><br /><span>}</span></div><div><p>The server's response to a prompts/list request from the client.</p> </div><section><div><span>\_meta?: \{ \[key: string]: unknown }</span><a href="#listpromptsresult-_meta" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>See <a href="/specification/2025-11-25/basic/index#meta">General fields: <code>\_meta</code></a> for notes on <code>\_meta</code> usage.</p> </div><aside><p>Inherited from PaginatedResult.\_meta</p></aside></section><section><div><span>nextCursor?: string</span><a href="#listpromptsresult-nextcursor" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>An opaque token representing the pagination position after the last returned result. | |
| If present, there may be more results available.</p> </div><aside><p>Inherited from PaginatedResult.nextCursor</p></aside></section><section><div><span>prompts: Prompt\[]</span><a href="#listpromptsresult-prompts" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section> | |
| </div> | |
| <div> | |
| ### `Prompt` | |
| <div><span>interface</span> <span>Prompt</span> <span>\{</span><br /> <a href="#prompt-icons">icons</a><span>?:</span> <a href="#icon">Icon</a><span>\[]</span><span>;</span><br /> <a href="#prompt-name">name</a><span>:</span> <span>string</span><span>;</span><br /> <a href="#prompt-title">title</a><span>?:</span> <span>string</span><span>;</span><br /> <a href="#prompt-description">description</a><span>?:</span> <span>string</span><span>;</span><br /> <a href="#prompt-arguments">arguments</a><span>?:</span> <a href="#promptargument">PromptArgument</a><span>\[]</span><span>;</span><br /> <a href="#prompt-_meta">\_meta</a><span>?:</span> <span>\{</span> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>unknown</span> <span>}</span><span>;</span><br /><span>}</span></div><div><p>A prompt or prompt template that the server offers.</p> </div><section><div><span>icons?: Icon\[]</span><a href="#prompt-icons" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Optional set of sized icons that the client can display in a user interface.</p> <p>Clients that support rendering icons MUST support at least the following MIME types:</p> <ul> <li><code>image/png</code> - PNG images (safe, universal compatibility)</li> <li><code>image/jpeg</code> (and <code>image/jpg</code>) - JPEG images (safe, universal compatibility)</li> </ul> <p>Clients that support rendering icons SHOULD also support:</p> <ul> <li><code>image/svg+xml</code> - SVG images (scalable but requires security precautions)</li> <li><code>image/webp</code> - WebP images (modern, efficient format)</li> </ul> </div><aside><p>Inherited from Icons.icons</p></aside></section><section><div><span>name: string</span><a href="#prompt-name" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Intended for programmatic or logical use, but used as a display name in past specs or fallback (if title isn't present).</p> </div><aside><p>Inherited from BaseMetadata.name</p></aside></section><section><div><span>title?: string</span><a href="#prompt-title" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Intended for UI and end-user contexts — optimized to be human-readable and easily understood, | |
| even by those unfamiliar with domain-specific terminology.</p> <p>If not provided, the name should be used for display (except for Tool, | |
| where <code>annotations.title</code> should be given precedence over using <code>name</code>, | |
| if present).</p> </div><aside><p>Inherited from BaseMetadata.title</p></aside></section><section><div><span>description?: string</span><a href="#prompt-description" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>An optional description of what this prompt provides</p> </div></section><section><div><span>arguments?: PromptArgument\[]</span><a href="#prompt-arguments" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>A list of arguments to use for templating the prompt.</p> </div></section><section><div><span>\_meta?: \{ \[key: string]: unknown }</span><a href="#prompt-_meta" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>See <a href="/specification/2025-11-25/basic/index#meta">General fields: <code>\_meta</code></a> for notes on <code>\_meta</code> usage.</p> </div></section> | |
| </div> | |
| <div> | |
| ### `PromptArgument` | |
| <div><span>interface</span> <span>PromptArgument</span> <span>\{</span><br /> <a href="#promptargument-name">name</a><span>:</span> <span>string</span><span>;</span><br /> <a href="#promptargument-title">title</a><span>?:</span> <span>string</span><span>;</span><br /> <a href="#promptargument-description">description</a><span>?:</span> <span>string</span><span>;</span><br /> <a href="#promptargument-required">required</a><span>?:</span> <span>boolean</span><span>;</span><br /><span>}</span></div><div><p>Describes an argument that a prompt can accept.</p> </div><section><div><span>name: string</span><a href="#promptargument-name" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Intended for programmatic or logical use, but used as a display name in past specs or fallback (if title isn't present).</p> </div><aside><p>Inherited from BaseMetadata.name</p></aside></section><section><div><span>title?: string</span><a href="#promptargument-title" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Intended for UI and end-user contexts — optimized to be human-readable and easily understood, | |
| even by those unfamiliar with domain-specific terminology.</p> <p>If not provided, the name should be used for display (except for Tool, | |
| where <code>annotations.title</code> should be given precedence over using <code>name</code>, | |
| if present).</p> </div><aside><p>Inherited from BaseMetadata.title</p></aside></section><section><div><span>description?: string</span><a href="#promptargument-description" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>A human-readable description of the argument.</p> </div></section><section><div><span>required?: boolean</span><a href="#promptargument-required" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Whether this argument must be provided.</p> </div></section> | |
| </div> | |
| ## `resources/list` | |
| <div> | |
| ### `ListResourcesRequest` | |
| <div><span>interface</span> <span>ListResourcesRequest</span> <span>\{</span><br /> <a href="#listresourcesrequest-jsonrpc">jsonrpc</a><span>:</span> <span>"2.0"</span><span>;</span><br /> <a href="#listresourcesrequest-id">id</a><span>:</span> <a href="#requestid">RequestId</a><span>;</span><br /> <a href="#listresourcesrequest-params">params</a><span>?:</span> <span>PaginatedRequestParams</span><span>;</span><br /> <a href="#listresourcesrequest-method">method</a><span>:</span> <span>"resources/list"</span><span>;</span><br /><span>}</span></div><div><p>Sent from the client to request a list of resources the server has.</p> </div><section><div><span>jsonrpc: "2.0"</span><a href="#listresourcesrequest-jsonrpc" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Inherited from PaginatedRequest.jsonrpc</p></aside></section><section><div><span>id: RequestId</span><a href="#listresourcesrequest-id" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Inherited from PaginatedRequest.id</p></aside></section><section><div><span>params?: PaginatedRequestParams</span><a href="#listresourcesrequest-params" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Inherited from PaginatedRequest.params</p></aside></section><section><div><span>method: "resources/list"</span><a href="#listresourcesrequest-method" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Overrides PaginatedRequest.method</p></aside></section> | |
| </div> | |
| <div> | |
| ### `ListResourcesResult` | |
| <div><span>interface</span> <span>ListResourcesResult</span> <span>\{</span><br /> <a href="#listresourcesresult-_meta">\_meta</a><span>?:</span> <span>\{</span> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>unknown</span> <span>}</span><span>;</span><br /> <a href="#listresourcesresult-nextcursor">nextCursor</a><span>?:</span> <span>string</span><span>;</span><br /> <a href="#listresourcesresult-resources">resources</a><span>:</span> <a href="#resource">Resource</a><span>\[]</span><span>;</span><br /> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>unknown</span><span>;</span><br /><span>}</span></div><div><p>The server's response to a resources/list request from the client.</p> </div><section><div><span>\_meta?: \{ \[key: string]: unknown }</span><a href="#listresourcesresult-_meta" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>See <a href="/specification/2025-11-25/basic/index#meta">General fields: <code>\_meta</code></a> for notes on <code>\_meta</code> usage.</p> </div><aside><p>Inherited from PaginatedResult.\_meta</p></aside></section><section><div><span>nextCursor?: string</span><a href="#listresourcesresult-nextcursor" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>An opaque token representing the pagination position after the last returned result. | |
| If present, there may be more results available.</p> </div><aside><p>Inherited from PaginatedResult.nextCursor</p></aside></section><section><div><span>resources: Resource\[]</span><a href="#listresourcesresult-resources" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section> | |
| </div> | |
| <div> | |
| ### `Resource` | |
| <div><span>interface</span> <span>Resource</span> <span>\{</span><br /> <a href="#resource-icons">icons</a><span>?:</span> <a href="#icon">Icon</a><span>\[]</span><span>;</span><br /> <a href="#resource-name">name</a><span>:</span> <span>string</span><span>;</span><br /> <a href="#resource-title">title</a><span>?:</span> <span>string</span><span>;</span><br /> <a href="#resource-uri">uri</a><span>:</span> <span>string</span><span>;</span><br /> <a href="#resource-description">description</a><span>?:</span> <span>string</span><span>;</span><br /> <a href="#resource-mimetype">mimeType</a><span>?:</span> <span>string</span><span>;</span><br /> <a href="#resource-annotations">annotations</a><span>?:</span> <a href="#annotations">Annotations</a><span>;</span><br /> <a href="#resource-size">size</a><span>?:</span> <span>number</span><span>;</span><br /> <a href="#resource-_meta">\_meta</a><span>?:</span> <span>\{</span> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>unknown</span> <span>}</span><span>;</span><br /><span>}</span></div><div><p>A known resource that the server is capable of reading.</p> </div><section><div><span>icons?: Icon\[]</span><a href="#resource-icons" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Optional set of sized icons that the client can display in a user interface.</p> <p>Clients that support rendering icons MUST support at least the following MIME types:</p> <ul> <li><code>image/png</code> - PNG images (safe, universal compatibility)</li> <li><code>image/jpeg</code> (and <code>image/jpg</code>) - JPEG images (safe, universal compatibility)</li> </ul> <p>Clients that support rendering icons SHOULD also support:</p> <ul> <li><code>image/svg+xml</code> - SVG images (scalable but requires security precautions)</li> <li><code>image/webp</code> - WebP images (modern, efficient format)</li> </ul> </div><aside><p>Inherited from Icons.icons</p></aside></section><section><div><span>name: string</span><a href="#resource-name" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Intended for programmatic or logical use, but used as a display name in past specs or fallback (if title isn't present).</p> </div><aside><p>Inherited from BaseMetadata.name</p></aside></section><section><div><span>title?: string</span><a href="#resource-title" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Intended for UI and end-user contexts — optimized to be human-readable and easily understood, | |
| even by those unfamiliar with domain-specific terminology.</p> <p>If not provided, the name should be used for display (except for Tool, | |
| where <code>annotations.title</code> should be given precedence over using <code>name</code>, | |
| if present).</p> </div><aside><p>Inherited from BaseMetadata.title</p></aside></section><section><div><span>uri: string</span><a href="#resource-uri" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>The URI of this resource.</p> </div></section><section><div><span>description?: string</span><a href="#resource-description" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>A description of what this resource represents.</p> <p>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.</p> </div></section><section><div><span>mimeType?: string</span><a href="#resource-mimetype" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>The MIME type of this resource, if known.</p> </div></section><section><div><span>annotations?: Annotations</span><a href="#resource-annotations" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Optional annotations for the client.</p> </div></section><section><div><span>size?: number</span><a href="#resource-size" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>The size of the raw resource content, in bytes (i.e., before base64 encoding or any tokenization), if known.</p> <p>This can be used by Hosts to display file sizes and estimate context window usage.</p> </div></section><section><div><span>\_meta?: \{ \[key: string]: unknown }</span><a href="#resource-_meta" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>See <a href="/specification/2025-11-25/basic/index#meta">General fields: <code>\_meta</code></a> for notes on <code>\_meta</code> usage.</p> </div></section> | |
| </div> | |
| ## `resources/read` | |
| <div> | |
| ### `ReadResourceRequest` | |
| <div><span>interface</span> <span>ReadResourceRequest</span> <span>\{</span><br /> <a href="#readresourcerequest-jsonrpc">jsonrpc</a><span>:</span> <span>"2.0"</span><span>;</span><br /> <a href="#readresourcerequest-id">id</a><span>:</span> <a href="#requestid">RequestId</a><span>;</span><br /> <a href="#readresourcerequest-method">method</a><span>:</span> <span>"resources/read"</span><span>;</span><br /> <a href="#readresourcerequest-params">params</a><span>:</span> <a href="#readresourcerequestparams">ReadResourceRequestParams</a><span>;</span><br /><span>}</span></div><div><p>Sent from the client to the server, to read a specific resource URI.</p> </div><section><div><span>jsonrpc: "2.0"</span><a href="#readresourcerequest-jsonrpc" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Inherited from <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-jsonrpc">jsonrpc</a></p></aside></section><section><div><span>id: RequestId</span><a href="#readresourcerequest-id" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Inherited from <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-id">id</a></p></aside></section><section><div><span>method: "resources/read"</span><a href="#readresourcerequest-method" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Overrides <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-method">method</a></p></aside></section><section><div><span>params: ReadResourceRequestParams</span><a href="#readresourcerequest-params" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Overrides <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-params">params</a></p></aside></section> | |
| </div> | |
| <div> | |
| ### `ReadResourceRequestParams` | |
| <div><span>interface</span> <span>ReadResourceRequestParams</span> <span>\{</span><br /> <a href="#readresourcerequestparams-_meta">\_meta</a><span>?:</span> <span>\{</span> <span>progressToken</span><span>?:</span> <a href="#progresstoken">ProgressToken</a><span>;</span> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>unknown</span> <span>}</span><span>;</span><br /> <a href="#readresourcerequestparams-uri">uri</a><span>:</span> <span>string</span><span>;</span><br /><span>}</span></div><div><p>Parameters for a <code>resources/read</code> request.</p> </div><section><div><span>\_meta?: \{ progressToken?: ProgressToken; \[key: string]: unknown }</span><a href="#readresourcerequestparams-_meta" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>See <a href="/specification/2025-11-25/basic/index#meta">General fields: <code>\_meta</code></a> for notes on <code>\_meta</code> usage.</p> </div><div><div>Type Declaration</div><ul><li><div><span>\[</span><span>key</span>: <span>string</span><span>]:</span> <span>unknown</span></div></li><li><div><code>Optional</code><span>progressToken</span><span>?: </span><a href="#progresstoken">ProgressToken</a></div><div><p>If specified, the caller is requesting out-of-band progress notifications for this request (as represented by notifications/progress). The value of this parameter is an opaque token that will be attached to any subsequent notifications. The receiver is not obligated to provide these notifications.</p> </div></li></ul></div><aside><p>Inherited from ResourceRequestParams.\_meta</p></aside></section><section><div><span>uri: string</span><a href="#readresourcerequestparams-uri" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>The URI of the resource. The URI can use any protocol; it is up to the server how to interpret it.</p> </div><aside><p>Inherited from ResourceRequestParams.uri</p></aside></section> | |
| </div> | |
| <div> | |
| ### `ReadResourceResult` | |
| <div><span>interface</span> <span>ReadResourceResult</span> <span>\{</span><br /> <a href="#readresourceresult-_meta">\_meta</a><span>?:</span> <span>\{</span> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>unknown</span> <span>}</span><span>;</span><br /> <a href="#readresourceresult-contents">contents</a><span>:</span> (<a href="#textresourcecontents">TextResourceContents</a> <span>|</span> <a href="#blobresourcecontents">BlobResourceContents</a>)<span>\[]</span><span>;</span><br /> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>unknown</span><span>;</span><br /><span>}</span></div><div><p>The server's response to a resources/read request from the client.</p> </div><section><div><span>\_meta?: \{ \[key: string]: unknown }</span><a href="#readresourceresult-_meta" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>See <a href="/specification/2025-11-25/basic/index#meta">General fields: <code>\_meta</code></a> for notes on <code>\_meta</code> usage.</p> </div><aside><p>Inherited from <a href="#result">Result</a>.<a href="#result-_meta">\_meta</a></p></aside></section><section><div><span>contents: (TextResourceContents | BlobResourceContents)\[]</span><a href="#readresourceresult-contents" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section> | |
| </div> | |
| ## `resources/subscribe` | |
| <div> | |
| ### `SubscribeRequest` | |
| <div><span>interface</span> <span>SubscribeRequest</span> <span>\{</span><br /> <a href="#subscriberequest-jsonrpc">jsonrpc</a><span>:</span> <span>"2.0"</span><span>;</span><br /> <a href="#subscriberequest-id">id</a><span>:</span> <a href="#requestid">RequestId</a><span>;</span><br /> <a href="#subscriberequest-method">method</a><span>:</span> <span>"resources/subscribe"</span><span>;</span><br /> <a href="#subscriberequest-params">params</a><span>:</span> <a href="#subscriberequestparams">SubscribeRequestParams</a><span>;</span><br /><span>}</span></div><div><p>Sent from the client to request resources/updated notifications from the server whenever a particular resource changes.</p> </div><section><div><span>jsonrpc: "2.0"</span><a href="#subscriberequest-jsonrpc" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Inherited from <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-jsonrpc">jsonrpc</a></p></aside></section><section><div><span>id: RequestId</span><a href="#subscriberequest-id" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Inherited from <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-id">id</a></p></aside></section><section><div><span>method: "resources/subscribe"</span><a href="#subscriberequest-method" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Overrides <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-method">method</a></p></aside></section><section><div><span>params: SubscribeRequestParams</span><a href="#subscriberequest-params" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Overrides <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-params">params</a></p></aside></section> | |
| </div> | |
| <div> | |
| ### `SubscribeRequestParams` | |
| <div><span>interface</span> <span>SubscribeRequestParams</span> <span>\{</span><br /> <a href="#subscriberequestparams-_meta">\_meta</a><span>?:</span> <span>\{</span> <span>progressToken</span><span>?:</span> <a href="#progresstoken">ProgressToken</a><span>;</span> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>unknown</span> <span>}</span><span>;</span><br /> <a href="#subscriberequestparams-uri">uri</a><span>:</span> <span>string</span><span>;</span><br /><span>}</span></div><div><p>Parameters for a <code>resources/subscribe</code> request.</p> </div><section><div><span>\_meta?: \{ progressToken?: ProgressToken; \[key: string]: unknown }</span><a href="#subscriberequestparams-_meta" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>See <a href="/specification/2025-11-25/basic/index#meta">General fields: <code>\_meta</code></a> for notes on <code>\_meta</code> usage.</p> </div><div><div>Type Declaration</div><ul><li><div><span>\[</span><span>key</span>: <span>string</span><span>]:</span> <span>unknown</span></div></li><li><div><code>Optional</code><span>progressToken</span><span>?: </span><a href="#progresstoken">ProgressToken</a></div><div><p>If specified, the caller is requesting out-of-band progress notifications for this request (as represented by notifications/progress). The value of this parameter is an opaque token that will be attached to any subsequent notifications. The receiver is not obligated to provide these notifications.</p> </div></li></ul></div><aside><p>Inherited from ResourceRequestParams.\_meta</p></aside></section><section><div><span>uri: string</span><a href="#subscriberequestparams-uri" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>The URI of the resource. The URI can use any protocol; it is up to the server how to interpret it.</p> </div><aside><p>Inherited from ResourceRequestParams.uri</p></aside></section> | |
| </div> | |
| ## `resources/templates/list` | |
| <div> | |
| ### `ListResourceTemplatesRequest` | |
| <div><span>interface</span> <span>ListResourceTemplatesRequest</span> <span>\{</span><br /> <a href="#listresourcetemplatesrequest-jsonrpc">jsonrpc</a><span>:</span> <span>"2.0"</span><span>;</span><br /> <a href="#listresourcetemplatesrequest-id">id</a><span>:</span> <a href="#requestid">RequestId</a><span>;</span><br /> <a href="#listresourcetemplatesrequest-params">params</a><span>?:</span> <span>PaginatedRequestParams</span><span>;</span><br /> <a href="#listresourcetemplatesrequest-method">method</a><span>:</span> <span>"resources/templates/list"</span><span>;</span><br /><span>}</span></div><div><p>Sent from the client to request a list of resource templates the server has.</p> </div><section><div><span>jsonrpc: "2.0"</span><a href="#listresourcetemplatesrequest-jsonrpc" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Inherited from PaginatedRequest.jsonrpc</p></aside></section><section><div><span>id: RequestId</span><a href="#listresourcetemplatesrequest-id" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Inherited from PaginatedRequest.id</p></aside></section><section><div><span>params?: PaginatedRequestParams</span><a href="#listresourcetemplatesrequest-params" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Inherited from PaginatedRequest.params</p></aside></section><section><div><span>method: "resources/templates/list"</span><a href="#listresourcetemplatesrequest-method" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Overrides PaginatedRequest.method</p></aside></section> | |
| </div> | |
| <div> | |
| ### `ListResourceTemplatesResult` | |
| <div><span>interface</span> <span>ListResourceTemplatesResult</span> <span>\{</span><br /> <a href="#listresourcetemplatesresult-_meta">\_meta</a><span>?:</span> <span>\{</span> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>unknown</span> <span>}</span><span>;</span><br /> <a href="#listresourcetemplatesresult-nextcursor">nextCursor</a><span>?:</span> <span>string</span><span>;</span><br /> <a href="#listresourcetemplatesresult-resourcetemplates">resourceTemplates</a><span>:</span> <a href="#resourcetemplate">ResourceTemplate</a><span>\[]</span><span>;</span><br /> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>unknown</span><span>;</span><br /><span>}</span></div><div><p>The server's response to a resources/templates/list request from the client.</p> </div><section><div><span>\_meta?: \{ \[key: string]: unknown }</span><a href="#listresourcetemplatesresult-_meta" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>See <a href="/specification/2025-11-25/basic/index#meta">General fields: <code>\_meta</code></a> for notes on <code>\_meta</code> usage.</p> </div><aside><p>Inherited from PaginatedResult.\_meta</p></aside></section><section><div><span>nextCursor?: string</span><a href="#listresourcetemplatesresult-nextcursor" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>An opaque token representing the pagination position after the last returned result. | |
| If present, there may be more results available.</p> </div><aside><p>Inherited from PaginatedResult.nextCursor</p></aside></section><section><div><span>resourceTemplates: ResourceTemplate\[]</span><a href="#listresourcetemplatesresult-resourcetemplates" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section> | |
| </div> | |
| <div> | |
| ### `ResourceTemplate` | |
| <div><span>interface</span> <span>ResourceTemplate</span> <span>\{</span><br /> <a href="#resourcetemplate-icons">icons</a><span>?:</span> <a href="#icon">Icon</a><span>\[]</span><span>;</span><br /> <a href="#resourcetemplate-name">name</a><span>:</span> <span>string</span><span>;</span><br /> <a href="#resourcetemplate-title">title</a><span>?:</span> <span>string</span><span>;</span><br /> <a href="#resourcetemplate-uritemplate">uriTemplate</a><span>:</span> <span>string</span><span>;</span><br /> <a href="#resourcetemplate-description">description</a><span>?:</span> <span>string</span><span>;</span><br /> <a href="#resourcetemplate-mimetype">mimeType</a><span>?:</span> <span>string</span><span>;</span><br /> <a href="#resourcetemplate-annotations">annotations</a><span>?:</span> <a href="#annotations">Annotations</a><span>;</span><br /> <a href="#resourcetemplate-_meta">\_meta</a><span>?:</span> <span>\{</span> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>unknown</span> <span>}</span><span>;</span><br /><span>}</span></div><div><p>A template description for resources available on the server.</p> </div><section><div><span>icons?: Icon\[]</span><a href="#resourcetemplate-icons" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Optional set of sized icons that the client can display in a user interface.</p> <p>Clients that support rendering icons MUST support at least the following MIME types:</p> <ul> <li><code>image/png</code> - PNG images (safe, universal compatibility)</li> <li><code>image/jpeg</code> (and <code>image/jpg</code>) - JPEG images (safe, universal compatibility)</li> </ul> <p>Clients that support rendering icons SHOULD also support:</p> <ul> <li><code>image/svg+xml</code> - SVG images (scalable but requires security precautions)</li> <li><code>image/webp</code> - WebP images (modern, efficient format)</li> </ul> </div><aside><p>Inherited from Icons.icons</p></aside></section><section><div><span>name: string</span><a href="#resourcetemplate-name" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Intended for programmatic or logical use, but used as a display name in past specs or fallback (if title isn't present).</p> </div><aside><p>Inherited from BaseMetadata.name</p></aside></section><section><div><span>title?: string</span><a href="#resourcetemplate-title" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Intended for UI and end-user contexts — optimized to be human-readable and easily understood, | |
| even by those unfamiliar with domain-specific terminology.</p> <p>If not provided, the name should be used for display (except for Tool, | |
| where <code>annotations.title</code> should be given precedence over using <code>name</code>, | |
| if present).</p> </div><aside><p>Inherited from BaseMetadata.title</p></aside></section><section><div><span>uriTemplate: string</span><a href="#resourcetemplate-uritemplate" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>A URI template (according to RFC 6570) that can be used to construct resource URIs.</p> </div></section><section><div><span>description?: string</span><a href="#resourcetemplate-description" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>A description of what this template is for.</p> <p>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.</p> </div></section><section><div><span>mimeType?: string</span><a href="#resourcetemplate-mimetype" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>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.</p> </div></section><section><div><span>annotations?: Annotations</span><a href="#resourcetemplate-annotations" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Optional annotations for the client.</p> </div></section><section><div><span>\_meta?: \{ \[key: string]: unknown }</span><a href="#resourcetemplate-_meta" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>See <a href="/specification/2025-11-25/basic/index#meta">General fields: <code>\_meta</code></a> for notes on <code>\_meta</code> usage.</p> </div></section> | |
| </div> | |
| ## `resources/unsubscribe` | |
| <div> | |
| ### `UnsubscribeRequest` | |
| <div><span>interface</span> <span>UnsubscribeRequest</span> <span>\{</span><br /> <a href="#unsubscriberequest-jsonrpc">jsonrpc</a><span>:</span> <span>"2.0"</span><span>;</span><br /> <a href="#unsubscriberequest-id">id</a><span>:</span> <a href="#requestid">RequestId</a><span>;</span><br /> <a href="#unsubscriberequest-method">method</a><span>:</span> <span>"resources/unsubscribe"</span><span>;</span><br /> <a href="#unsubscriberequest-params">params</a><span>:</span> <a href="#unsubscriberequestparams">UnsubscribeRequestParams</a><span>;</span><br /><span>}</span></div><div><p>Sent from the client to request cancellation of resources/updated notifications from the server. This should follow a previous resources/subscribe request.</p> </div><section><div><span>jsonrpc: "2.0"</span><a href="#unsubscriberequest-jsonrpc" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Inherited from <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-jsonrpc">jsonrpc</a></p></aside></section><section><div><span>id: RequestId</span><a href="#unsubscriberequest-id" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Inherited from <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-id">id</a></p></aside></section><section><div><span>method: "resources/unsubscribe"</span><a href="#unsubscriberequest-method" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Overrides <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-method">method</a></p></aside></section><section><div><span>params: UnsubscribeRequestParams</span><a href="#unsubscriberequest-params" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Overrides <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-params">params</a></p></aside></section> | |
| </div> | |
| <div> | |
| ### `UnsubscribeRequestParams` | |
| <div><span>interface</span> <span>UnsubscribeRequestParams</span> <span>\{</span><br /> <a href="#unsubscriberequestparams-_meta">\_meta</a><span>?:</span> <span>\{</span> <span>progressToken</span><span>?:</span> <a href="#progresstoken">ProgressToken</a><span>;</span> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>unknown</span> <span>}</span><span>;</span><br /> <a href="#unsubscriberequestparams-uri">uri</a><span>:</span> <span>string</span><span>;</span><br /><span>}</span></div><div><p>Parameters for a <code>resources/unsubscribe</code> request.</p> </div><section><div><span>\_meta?: \{ progressToken?: ProgressToken; \[key: string]: unknown }</span><a href="#unsubscriberequestparams-_meta" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>See <a href="/specification/2025-11-25/basic/index#meta">General fields: <code>\_meta</code></a> for notes on <code>\_meta</code> usage.</p> </div><div><div>Type Declaration</div><ul><li><div><span>\[</span><span>key</span>: <span>string</span><span>]:</span> <span>unknown</span></div></li><li><div><code>Optional</code><span>progressToken</span><span>?: </span><a href="#progresstoken">ProgressToken</a></div><div><p>If specified, the caller is requesting out-of-band progress notifications for this request (as represented by notifications/progress). The value of this parameter is an opaque token that will be attached to any subsequent notifications. The receiver is not obligated to provide these notifications.</p> </div></li></ul></div><aside><p>Inherited from ResourceRequestParams.\_meta</p></aside></section><section><div><span>uri: string</span><a href="#unsubscriberequestparams-uri" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>The URI of the resource. The URI can use any protocol; it is up to the server how to interpret it.</p> </div><aside><p>Inherited from ResourceRequestParams.uri</p></aside></section> | |
| </div> | |
| ## `roots/list` | |
| <div> | |
| ### `ListRootsRequest` | |
| <div><span>interface</span> <span>ListRootsRequest</span> <span>\{</span><br /> <a href="#listrootsrequest-jsonrpc">jsonrpc</a><span>:</span> <span>"2.0"</span><span>;</span><br /> <a href="#listrootsrequest-id">id</a><span>:</span> <a href="#requestid">RequestId</a><span>;</span><br /> <a href="#listrootsrequest-method">method</a><span>:</span> <span>"roots/list"</span><span>;</span><br /> <a href="#listrootsrequest-params">params</a><span>?:</span> <span>RequestParams</span><span>;</span><br /><span>}</span></div><div><p>Sent from the server to request a list of root URIs from the client. Roots allow | |
| servers to ask for specific directories or files to operate on. A common example | |
| for roots is providing a set of repositories or directories a server should operate | |
| on.</p> <p>This request is typically used when the server needs to understand the file system | |
| structure or access specific locations that the client has permission to read from.</p> </div><section><div><span>jsonrpc: "2.0"</span><a href="#listrootsrequest-jsonrpc" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Inherited from <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-jsonrpc">jsonrpc</a></p></aside></section><section><div><span>id: RequestId</span><a href="#listrootsrequest-id" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Inherited from <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-id">id</a></p></aside></section><section><div><span>method: "roots/list"</span><a href="#listrootsrequest-method" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Overrides <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-method">method</a></p></aside></section><section><div><span>params?: RequestParams</span><a href="#listrootsrequest-params" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Overrides <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-params">params</a></p></aside></section> | |
| </div> | |
| <div> | |
| ### `ListRootsResult` | |
| <div><span>interface</span> <span>ListRootsResult</span> <span>\{</span><br /> <a href="#listrootsresult-_meta">\_meta</a><span>?:</span> <span>\{</span> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>unknown</span> <span>}</span><span>;</span><br /> <a href="#listrootsresult-roots">roots</a><span>:</span> <a href="#root">Root</a><span>\[]</span><span>;</span><br /> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>unknown</span><span>;</span><br /><span>}</span></div><div><p>The client's response to a roots/list request from the server. | |
| This result contains an array of Root objects, each representing a root directory | |
| or file that the server can operate on.</p> </div><section><div><span>\_meta?: \{ \[key: string]: unknown }</span><a href="#listrootsresult-_meta" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>See <a href="/specification/2025-11-25/basic/index#meta">General fields: <code>\_meta</code></a> for notes on <code>\_meta</code> usage.</p> </div><aside><p>Inherited from <a href="#result">Result</a>.<a href="#result-_meta">\_meta</a></p></aside></section><section><div><span>roots: Root\[]</span><a href="#listrootsresult-roots" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section> | |
| </div> | |
| <div> | |
| ### `Root` | |
| <div><span>interface</span> <span>Root</span> <span>\{</span><br /> <a href="#root-uri">uri</a><span>:</span> <span>string</span><span>;</span><br /> <a href="#root-name">name</a><span>?:</span> <span>string</span><span>;</span><br /> <a href="#root-_meta">\_meta</a><span>?:</span> <span>\{</span> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>unknown</span> <span>}</span><span>;</span><br /><span>}</span></div><div><p>Represents a root directory or file that the server can operate on.</p> </div><section><div><span>uri: string</span><a href="#root-uri" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>The URI identifying the root. This <em>must</em> start with file:// for now. | |
| This restriction may be relaxed in future versions of the protocol to allow | |
| other URI schemes.</p> </div></section><section><div><span>name?: string</span><a href="#root-name" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>An optional name for the root. This can be used to provide a human-readable | |
| identifier for the root, which may be useful for display purposes or for | |
| referencing the root in other parts of the application.</p> </div></section><section><div><span>\_meta?: \{ \[key: string]: unknown }</span><a href="#root-_meta" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>See <a href="/specification/2025-11-25/basic/index#meta">General fields: <code>\_meta</code></a> for notes on <code>\_meta</code> usage.</p> </div></section> | |
| </div> | |
| ## `sampling/createMessage` | |
| <div> | |
| ### `CreateMessageRequest` | |
| <div><span>interface</span> <span>CreateMessageRequest</span> <span>\{</span><br /> <a href="#createmessagerequest-jsonrpc">jsonrpc</a><span>:</span> <span>"2.0"</span><span>;</span><br /> <a href="#createmessagerequest-id">id</a><span>:</span> <a href="#requestid">RequestId</a><span>;</span><br /> <a href="#createmessagerequest-method">method</a><span>:</span> <span>"sampling/createMessage"</span><span>;</span><br /> <a href="#createmessagerequest-params">params</a><span>:</span> <a href="#createmessagerequestparams">CreateMessageRequestParams</a><span>;</span><br /><span>}</span></div><div><p>A request from the server to sample an LLM via the client. The client has full discretion over which model to select. The client should also inform the user before beginning sampling, to allow them to inspect the request (human in the loop) and decide whether to approve it.</p> </div><section><div><span>jsonrpc: "2.0"</span><a href="#createmessagerequest-jsonrpc" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Inherited from <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-jsonrpc">jsonrpc</a></p></aside></section><section><div><span>id: RequestId</span><a href="#createmessagerequest-id" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Inherited from <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-id">id</a></p></aside></section><section><div><span>method: "sampling/createMessage"</span><a href="#createmessagerequest-method" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Overrides <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-method">method</a></p></aside></section><section><div><span>params: CreateMessageRequestParams</span><a href="#createmessagerequest-params" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Overrides <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-params">params</a></p></aside></section> | |
| </div> | |
| <div> | |
| ### `CreateMessageRequestParams` | |
| <div><span>interface</span> <span>CreateMessageRequestParams</span> <span>\{</span><br /> <a href="#createmessagerequestparams-task">task</a><span>?:</span> <a href="#taskmetadata">TaskMetadata</a><span>;</span><br /> <a href="#createmessagerequestparams-_meta">\_meta</a><span>?:</span> <span>\{</span> <span>progressToken</span><span>?:</span> <a href="#progresstoken">ProgressToken</a><span>;</span> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>unknown</span> <span>}</span><span>;</span><br /> <a href="#createmessagerequestparams-messages">messages</a><span>:</span> <a href="#samplingmessage">SamplingMessage</a><span>\[]</span><span>;</span><br /> <a href="#createmessagerequestparams-modelpreferences">modelPreferences</a><span>?:</span> <a href="#modelpreferences">ModelPreferences</a><span>;</span><br /> <a href="#createmessagerequestparams-systemprompt">systemPrompt</a><span>?:</span> <span>string</span><span>;</span><br /> <a href="#createmessagerequestparams-includecontext">includeContext</a><span>?:</span> <span>"none"</span> <span>|</span> <span>"thisServer"</span> <span>|</span> <span>"allServers"</span><span>;</span><br /> <a href="#createmessagerequestparams-temperature">temperature</a><span>?:</span> <span>number</span><span>;</span><br /> <a href="#createmessagerequestparams-maxtokens">maxTokens</a><span>:</span> <span>number</span><span>;</span><br /> <a href="#createmessagerequestparams-stopsequences">stopSequences</a><span>?:</span> <span>string</span><span>\[]</span><span>;</span><br /> <a href="#createmessagerequestparams-metadata">metadata</a><span>?:</span> <span>object</span><span>;</span><br /> <a href="#createmessagerequestparams-tools">tools</a><span>?:</span> <a href="#tool">Tool</a><span>\[]</span><span>;</span><br /> <a href="#createmessagerequestparams-toolchoice">toolChoice</a><span>?:</span> <a href="#toolchoice">ToolChoice</a><span>;</span><br /><span>}</span></div><div><p>Parameters for a <code>sampling/createMessage</code> request.</p> </div><section><div><span>task?: TaskMetadata</span><a href="#createmessagerequestparams-task" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>If specified, the caller is requesting task-augmented execution for this request. | |
| The request will return a CreateTaskResult immediately, and the actual result can be | |
| retrieved later via tasks/result.</p> <p>Task augmentation is subject to capability negotiation - receivers MUST declare support | |
| for task augmentation of specific request types in their capabilities.</p> </div><aside><p>Inherited from TaskAugmentedRequestParams.task</p></aside></section><section><div><span>\_meta?: \{ progressToken?: ProgressToken; \[key: string]: unknown }</span><a href="#createmessagerequestparams-_meta" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>See <a href="/specification/2025-11-25/basic/index#meta">General fields: <code>\_meta</code></a> for notes on <code>\_meta</code> usage.</p> </div><div><div>Type Declaration</div><ul><li><div><span>\[</span><span>key</span>: <span>string</span><span>]:</span> <span>unknown</span></div></li><li><div><code>Optional</code><span>progressToken</span><span>?: </span><a href="#progresstoken">ProgressToken</a></div><div><p>If specified, the caller is requesting out-of-band progress notifications for this request (as represented by notifications/progress). The value of this parameter is an opaque token that will be attached to any subsequent notifications. The receiver is not obligated to provide these notifications.</p> </div></li></ul></div><aside><p>Inherited from TaskAugmentedRequestParams.\_meta</p></aside></section><section><div><span>messages: SamplingMessage\[]</span><a href="#createmessagerequestparams-messages" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section><div><span>modelPreferences?: ModelPreferences</span><a href="#createmessagerequestparams-modelpreferences" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>The server's preferences for which model to select. The client MAY ignore these preferences.</p> </div></section><section><div><span>systemPrompt?: string</span><a href="#createmessagerequestparams-systemprompt" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>An optional system prompt the server wants to use for sampling. The client MAY modify or omit this prompt.</p> </div></section><section><div><span>includeContext?: "none" | "thisServer" | "allServers"</span><a href="#createmessagerequestparams-includecontext" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>A request to include context from one or more MCP servers (including the caller), to be attached to the prompt. | |
| The client MAY ignore this request.</p> <p>Default is "none". Values "thisServer" and "allServers" are soft-deprecated. Servers SHOULD only use these values if the client | |
| declares ClientCapabilities.sampling.context. These values may be removed in future spec releases.</p> </div></section><section><div><span>temperature?: number</span><a href="#createmessagerequestparams-temperature" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section><div><span>maxTokens: number</span><a href="#createmessagerequestparams-maxtokens" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>The requested maximum number of tokens to sample (to prevent runaway completions).</p> <p>The client MAY choose to sample fewer tokens than the requested maximum.</p> </div></section><section><div><span>stopSequences?: string\[]</span><a href="#createmessagerequestparams-stopsequences" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section><div><span>metadata?: object</span><a href="#createmessagerequestparams-metadata" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Optional metadata to pass through to the LLM provider. The format of this metadata is provider-specific.</p> </div></section><section><div><span>tools?: Tool\[]</span><a href="#createmessagerequestparams-tools" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Tools that the model may use during generation. | |
| The client MUST return an error if this field is provided but ClientCapabilities.sampling.tools is not declared.</p> </div></section><section><div><span>toolChoice?: ToolChoice</span><a href="#createmessagerequestparams-toolchoice" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Controls how the model uses tools. | |
| The client MUST return an error if this field is provided but ClientCapabilities.sampling.tools is not declared. | |
| Default is <code>\{ mode: "auto" }</code>.</p> </div></section> | |
| </div> | |
| <div> | |
| ### `CreateMessageResult` | |
| <div><span>interface</span> <span>CreateMessageResult</span> <span>\{</span><br /> <a href="#createmessageresult-_meta">\_meta</a><span>?:</span> <span>\{</span> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>unknown</span> <span>}</span><span>;</span><br /> <a href="#createmessageresult-model">model</a><span>:</span> <span>string</span><span>;</span><br /> <a href="#createmessageresult-stopreason">stopReason</a><span>?:</span> <span>string</span><span>;</span><br /> <a href="#createmessageresult-role">role</a><span>:</span> <a href="#role">Role</a><span>;</span><br /> <a href="#createmessageresult-content">content</a><span>:</span> <a href="#samplingmessagecontentblock">SamplingMessageContentBlock</a> <span>|</span> <a href="#samplingmessagecontentblock">SamplingMessageContentBlock</a><span>\[]</span><span>;</span><br /> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>unknown</span><span>;</span><br /><span>}</span></div><div><p>The client's response to a sampling/createMessage request from the server. | |
| The client should inform the user before returning the sampled message, to allow them | |
| to inspect the response (human in the loop) and decide whether to allow the server to see it.</p> </div><section><div><span>\_meta?: \{ \[key: string]: unknown }</span><a href="#createmessageresult-_meta" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>See <a href="/specification/2025-11-25/basic/index#meta">General fields: <code>\_meta</code></a> for notes on <code>\_meta</code> usage.</p> </div><aside><p>Inherited from <a href="#result">Result</a>.<a href="#result-_meta">\_meta</a></p></aside></section><section><div><span>model: string</span><a href="#createmessageresult-model" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>The name of the model that generated the message.</p> </div></section><section><div><span>stopReason?: string</span><a href="#createmessageresult-stopreason" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>The reason why sampling stopped, if known.</p> <p>Standard values:</p> <ul> <li>"endTurn": Natural end of the assistant's turn</li> <li>"stopSequence": A stop sequence was encountered</li> <li>"maxTokens": Maximum token limit was reached</li> <li>"toolUse": The model wants to use one or more tools</li> </ul> <p>This field is an open string to allow for provider-specific stop reasons.</p> </div></section><section><div><span>role: Role</span><a href="#createmessageresult-role" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Inherited from <a href="#samplingmessage">SamplingMessage</a>.<a href="#samplingmessage-role">role</a></p></aside></section><section><div><span>content: SamplingMessageContentBlock | SamplingMessageContentBlock\[]</span><a href="#createmessageresult-content" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Inherited from <a href="#samplingmessage">SamplingMessage</a>.<a href="#samplingmessage-content">content</a></p></aside></section> | |
| </div> | |
| <div> | |
| ### `ModelHint` | |
| <div><span>interface</span> <span>ModelHint</span> <span>\{</span><br /> <a href="#modelhint-name">name</a><span>?:</span> <span>string</span><span>;</span><br /><span>}</span></div><div><p>Hints to use for model selection.</p> <p>Keys not declared here are currently left unspecified by the spec and are up | |
| to the client to interpret.</p> </div><section><div><span>name?: string</span><a href="#modelhint-name" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>A hint for a model name.</p> <p>The client SHOULD treat this as a substring of a model name; for example:</p> <ul> <li><code>claude-3-5-sonnet</code> should match <code>claude-3-5-sonnet-20241022</code></li> <li><code>sonnet</code> should match <code>claude-3-5-sonnet-20241022</code>, <code>claude-3-sonnet-20240229</code>, etc.</li> <li><code>claude</code> should match any Claude model</li> </ul> <p>The client MAY also map the string to a different provider's model name or a different model family, as long as it fills a similar niche; for example:</p> <ul> <li><code>gemini-1.5-flash</code> could match <code>claude-3-haiku-20240307</code></li> </ul> </div></section> | |
| </div> | |
| <div> | |
| ### `ModelPreferences` | |
| <div><span>interface</span> <span>ModelPreferences</span> <span>\{</span><br /> <a href="#modelpreferences-hints">hints</a><span>?:</span> <a href="#modelhint">ModelHint</a><span>\[]</span><span>;</span><br /> <a href="#modelpreferences-costpriority">costPriority</a><span>?:</span> <span>number</span><span>;</span><br /> <a href="#modelpreferences-speedpriority">speedPriority</a><span>?:</span> <span>number</span><span>;</span><br /> <a href="#modelpreferences-intelligencepriority">intelligencePriority</a><span>?:</span> <span>number</span><span>;</span><br /><span>}</span></div><div><p>The server's preferences for model selection, requested of the client during sampling.</p> <p>Because LLMs can vary along multiple dimensions, choosing the "best" model is | |
| rarely straightforward. Different models excel in different areas—some are | |
| faster but less capable, others are more capable but more expensive, and so | |
| on. This interface allows servers to express their priorities across multiple | |
| dimensions to help clients make an appropriate selection for their use case.</p> <p>These preferences are always advisory. The client MAY ignore them. It is also | |
| up to the client to decide how to interpret these preferences and how to | |
| balance them against other considerations.</p> </div><section><div><span>hints?: ModelHint\[]</span><a href="#modelpreferences-hints" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Optional hints to use for model selection.</p> <p>If multiple hints are specified, the client MUST evaluate them in order | |
| (such that the first match is taken).</p> <p>The client SHOULD prioritize these hints over the numeric priorities, but | |
| MAY still use the priorities to select from ambiguous matches.</p> </div></section><section><div><span>costPriority?: number</span><a href="#modelpreferences-costpriority" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>How much to prioritize cost when selecting a model. A value of 0 means cost | |
| is not important, while a value of 1 means cost is the most important | |
| factor.</p> </div></section><section><div><span>speedPriority?: number</span><a href="#modelpreferences-speedpriority" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>How much to prioritize sampling speed (latency) when selecting a model. A | |
| value of 0 means speed is not important, while a value of 1 means speed is | |
| the most important factor.</p> </div></section><section><div><span>intelligencePriority?: number</span><a href="#modelpreferences-intelligencepriority" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>How much to prioritize intelligence and capabilities when selecting a | |
| model. A value of 0 means intelligence is not important, while a value of 1 | |
| means intelligence is the most important factor.</p> </div></section> | |
| </div> | |
| <div> | |
| ### `SamplingMessage` | |
| <div><span>interface</span> <span>SamplingMessage</span> <span>\{</span><br /> <a href="#samplingmessage-role">role</a><span>:</span> <a href="#role">Role</a><span>;</span><br /> <a href="#samplingmessage-content">content</a><span>:</span> <a href="#samplingmessagecontentblock">SamplingMessageContentBlock</a> <span>|</span> <a href="#samplingmessagecontentblock">SamplingMessageContentBlock</a><span>\[]</span><span>;</span><br /> <a href="#samplingmessage-_meta">\_meta</a><span>?:</span> <span>\{</span> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>unknown</span> <span>}</span><span>;</span><br /><span>}</span></div><div><p>Describes a message issued to or received from an LLM API.</p> </div><section><div><span>role: Role</span><a href="#samplingmessage-role" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section><div><span>content: SamplingMessageContentBlock | SamplingMessageContentBlock\[]</span><a href="#samplingmessage-content" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section><div><span>\_meta?: \{ \[key: string]: unknown }</span><a href="#samplingmessage-_meta" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>See <a href="/specification/2025-11-25/basic/index#meta">General fields: <code>\_meta</code></a> for notes on <code>\_meta</code> usage.</p> </div></section> | |
| </div> | |
| <div> | |
| ### `ToolChoice` | |
| <div><span>interface</span> <span>ToolChoice</span> <span>\{</span><br /> <a href="#toolchoice-mode">mode</a><span>?:</span> <span>"none"</span> <span>|</span> <span>"required"</span> <span>|</span> <span>"auto"</span><span>;</span><br /><span>}</span></div><div><p>Controls tool selection behavior for sampling requests.</p> </div><section><div><span>mode?: "none" | "required" | "auto"</span><a href="#toolchoice-mode" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Controls the tool use ability of the model:</p> <ul> <li>"auto": Model decides whether to use tools (default)</li> <li>"required": Model MUST use at least one tool before completing</li> <li>"none": Model MUST NOT use any tools</li> </ul> </div></section> | |
| </div> | |
| <div> | |
| ### `ToolResultContent` | |
| <div><span>interface</span> <span>ToolResultContent</span> <span>\{</span><br /> <a href="#toolresultcontent-type">type</a><span>:</span> <span>"tool\_result"</span><span>;</span><br /> <a href="#toolresultcontent-tooluseid">toolUseId</a><span>:</span> <span>string</span><span>;</span><br /> <a href="#toolresultcontent-content">content</a><span>:</span> <a href="#contentblock">ContentBlock</a><span>\[]</span><span>;</span><br /> <a href="#toolresultcontent-structuredcontent">structuredContent</a><span>?:</span> <span>\{</span> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>unknown</span> <span>}</span><span>;</span><br /> <a href="#toolresultcontent-iserror">isError</a><span>?:</span> <span>boolean</span><span>;</span><br /> <a href="#toolresultcontent-_meta">\_meta</a><span>?:</span> <span>\{</span> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>unknown</span> <span>}</span><span>;</span><br /><span>}</span></div><div><p>The result of a tool use, provided by the user back to the assistant.</p> </div><section><div><span>type: "tool\_result"</span><a href="#toolresultcontent-type" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section><div><span>toolUseId: string</span><a href="#toolresultcontent-tooluseid" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>The ID of the tool use this result corresponds to.</p> <p>This MUST match the ID from a previous ToolUseContent.</p> </div></section><section><div><span>content: ContentBlock\[]</span><a href="#toolresultcontent-content" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>The unstructured result content of the tool use.</p> <p>This has the same format as CallToolResult.content and can include text, images, | |
| audio, resource links, and embedded resources.</p> </div></section><section><div><span>structuredContent?: \{ \[key: string]: unknown }</span><a href="#toolresultcontent-structuredcontent" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>An optional structured result object.</p> <p>If the tool defined an outputSchema, this SHOULD conform to that schema.</p> </div></section><section><div><span>isError?: boolean</span><a href="#toolresultcontent-iserror" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Whether the tool use resulted in an error.</p> <p>If true, the content typically describes the error that occurred. | |
| Default: false</p> </div></section><section><div><span>\_meta?: \{ \[key: string]: unknown }</span><a href="#toolresultcontent-_meta" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Optional metadata about the tool result. Clients SHOULD preserve this field when | |
| including tool results in subsequent sampling requests to enable caching optimizations.</p> <p>See <a href="/specification/2025-11-25/basic/index#meta">General fields: <code>\_meta</code></a> for notes on <code>\_meta</code> usage.</p> </div></section> | |
| </div> | |
| <div> | |
| ### `ToolUseContent` | |
| <div><span>interface</span> <span>ToolUseContent</span> <span>\{</span><br /> <a href="#toolusecontent-type">type</a><span>:</span> <span>"tool\_use"</span><span>;</span><br /> <a href="#toolusecontent-id">id</a><span>:</span> <span>string</span><span>;</span><br /> <a href="#toolusecontent-name">name</a><span>:</span> <span>string</span><span>;</span><br /> <a href="#toolusecontent-input">input</a><span>:</span> <span>\{</span> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>unknown</span> <span>}</span><span>;</span><br /> <a href="#toolusecontent-_meta">\_meta</a><span>?:</span> <span>\{</span> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>unknown</span> <span>}</span><span>;</span><br /><span>}</span></div><div><p>A request from the assistant to call a tool.</p> </div><section><div><span>type: "tool\_use"</span><a href="#toolusecontent-type" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section><div><span>id: string</span><a href="#toolusecontent-id" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>A unique identifier for this tool use.</p> <p>This ID is used to match tool results to their corresponding tool uses.</p> </div></section><section><div><span>name: string</span><a href="#toolusecontent-name" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>The name of the tool to call.</p> </div></section><section><div><span>input: \{ \[key: string]: unknown }</span><a href="#toolusecontent-input" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>The arguments to pass to the tool, conforming to the tool's input schema.</p> </div></section><section><div><span>\_meta?: \{ \[key: string]: unknown }</span><a href="#toolusecontent-_meta" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Optional metadata about the tool use. Clients SHOULD preserve this field when | |
| including tool uses in subsequent sampling requests to enable caching optimizations.</p> <p>See <a href="/specification/2025-11-25/basic/index#meta">General fields: <code>\_meta</code></a> for notes on <code>\_meta</code> usage.</p> </div></section> | |
| </div> | |
| ## `tools/call` | |
| <div> | |
| ### `CallToolRequest` | |
| <div><span>interface</span> <span>CallToolRequest</span> <span>\{</span><br /> <a href="#calltoolrequest-jsonrpc">jsonrpc</a><span>:</span> <span>"2.0"</span><span>;</span><br /> <a href="#calltoolrequest-id">id</a><span>:</span> <a href="#requestid">RequestId</a><span>;</span><br /> <a href="#calltoolrequest-method">method</a><span>:</span> <span>"tools/call"</span><span>;</span><br /> <a href="#calltoolrequest-params">params</a><span>:</span> <a href="#calltoolrequestparams">CallToolRequestParams</a><span>;</span><br /><span>}</span></div><div><p>Used by the client to invoke a tool provided by the server.</p> </div><section><div><span>jsonrpc: "2.0"</span><a href="#calltoolrequest-jsonrpc" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Inherited from <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-jsonrpc">jsonrpc</a></p></aside></section><section><div><span>id: RequestId</span><a href="#calltoolrequest-id" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Inherited from <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-id">id</a></p></aside></section><section><div><span>method: "tools/call"</span><a href="#calltoolrequest-method" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Overrides <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-method">method</a></p></aside></section><section><div><span>params: CallToolRequestParams</span><a href="#calltoolrequest-params" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Overrides <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-params">params</a></p></aside></section> | |
| </div> | |
| <div> | |
| ### `CallToolRequestParams` | |
| <div><span>interface</span> <span>CallToolRequestParams</span> <span>\{</span><br /> <a href="#calltoolrequestparams-task">task</a><span>?:</span> <a href="#taskmetadata">TaskMetadata</a><span>;</span><br /> <a href="#calltoolrequestparams-_meta">\_meta</a><span>?:</span> <span>\{</span> <span>progressToken</span><span>?:</span> <a href="#progresstoken">ProgressToken</a><span>;</span> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>unknown</span> <span>}</span><span>;</span><br /> <a href="#calltoolrequestparams-name">name</a><span>:</span> <span>string</span><span>;</span><br /> <a href="#calltoolrequestparams-arguments">arguments</a><span>?:</span> <span>\{</span> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>unknown</span> <span>}</span><span>;</span><br /><span>}</span></div><div><p>Parameters for a <code>tools/call</code> request.</p> </div><section><div><span>task?: TaskMetadata</span><a href="#calltoolrequestparams-task" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>If specified, the caller is requesting task-augmented execution for this request. | |
| The request will return a CreateTaskResult immediately, and the actual result can be | |
| retrieved later via tasks/result.</p> <p>Task augmentation is subject to capability negotiation - receivers MUST declare support | |
| for task augmentation of specific request types in their capabilities.</p> </div><aside><p>Inherited from TaskAugmentedRequestParams.task</p></aside></section><section><div><span>\_meta?: \{ progressToken?: ProgressToken; \[key: string]: unknown }</span><a href="#calltoolrequestparams-_meta" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>See <a href="/specification/2025-11-25/basic/index#meta">General fields: <code>\_meta</code></a> for notes on <code>\_meta</code> usage.</p> </div><div><div>Type Declaration</div><ul><li><div><span>\[</span><span>key</span>: <span>string</span><span>]:</span> <span>unknown</span></div></li><li><div><code>Optional</code><span>progressToken</span><span>?: </span><a href="#progresstoken">ProgressToken</a></div><div><p>If specified, the caller is requesting out-of-band progress notifications for this request (as represented by notifications/progress). The value of this parameter is an opaque token that will be attached to any subsequent notifications. The receiver is not obligated to provide these notifications.</p> </div></li></ul></div><aside><p>Inherited from TaskAugmentedRequestParams.\_meta</p></aside></section><section><div><span>name: string</span><a href="#calltoolrequestparams-name" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>The name of the tool.</p> </div></section><section><div><span>arguments?: \{ \[key: string]: unknown }</span><a href="#calltoolrequestparams-arguments" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Arguments to use for the tool call.</p> </div></section> | |
| </div> | |
| <div> | |
| ### `CallToolResult` | |
| <div><span>interface</span> <span>CallToolResult</span> <span>\{</span><br /> <a href="#calltoolresult-_meta">\_meta</a><span>?:</span> <span>\{</span> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>unknown</span> <span>}</span><span>;</span><br /> <a href="#calltoolresult-content">content</a><span>:</span> <a href="#contentblock">ContentBlock</a><span>\[]</span><span>;</span><br /> <a href="#calltoolresult-structuredcontent">structuredContent</a><span>?:</span> <span>\{</span> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>unknown</span> <span>}</span><span>;</span><br /> <a href="#calltoolresult-iserror">isError</a><span>?:</span> <span>boolean</span><span>;</span><br /> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>unknown</span><span>;</span><br /><span>}</span></div><div><p>The server's response to a tool call.</p> </div><section><div><span>\_meta?: \{ \[key: string]: unknown }</span><a href="#calltoolresult-_meta" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>See <a href="/specification/2025-11-25/basic/index#meta">General fields: <code>\_meta</code></a> for notes on <code>\_meta</code> usage.</p> </div><aside><p>Inherited from <a href="#result">Result</a>.<a href="#result-_meta">\_meta</a></p></aside></section><section><div><span>content: ContentBlock\[]</span><a href="#calltoolresult-content" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>A list of content objects that represent the unstructured result of the tool call.</p> </div></section><section><div><span>structuredContent?: \{ \[key: string]: unknown }</span><a href="#calltoolresult-structuredcontent" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>An optional JSON object that represents the structured result of the tool call.</p> </div></section><section><div><span>isError?: boolean</span><a href="#calltoolresult-iserror" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Whether the tool call ended in an error.</p> <p>If not set, this is assumed to be false (the call was successful).</p> <p>Any errors that originate from the tool SHOULD be reported inside the result | |
| object, with <code>isError</code> set to true, <em>not</em> as an MCP protocol-level error | |
| response. Otherwise, the LLM would not be able to see that an error occurred | |
| and self-correct.</p> <p>However, any errors in <em>finding</em> the tool, an error indicating that the | |
| server does not support tool calls, or any other exceptional conditions, | |
| should be reported as an MCP error response.</p> </div></section> | |
| </div> | |
| ## `tools/list` | |
| <div> | |
| ### `ListToolsRequest` | |
| <div><span>interface</span> <span>ListToolsRequest</span> <span>\{</span><br /> <a href="#listtoolsrequest-jsonrpc">jsonrpc</a><span>:</span> <span>"2.0"</span><span>;</span><br /> <a href="#listtoolsrequest-id">id</a><span>:</span> <a href="#requestid">RequestId</a><span>;</span><br /> <a href="#listtoolsrequest-params">params</a><span>?:</span> <span>PaginatedRequestParams</span><span>;</span><br /> <a href="#listtoolsrequest-method">method</a><span>:</span> <span>"tools/list"</span><span>;</span><br /><span>}</span></div><div><p>Sent from the client to request a list of tools the server has.</p> </div><section><div><span>jsonrpc: "2.0"</span><a href="#listtoolsrequest-jsonrpc" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Inherited from PaginatedRequest.jsonrpc</p></aside></section><section><div><span>id: RequestId</span><a href="#listtoolsrequest-id" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Inherited from PaginatedRequest.id</p></aside></section><section><div><span>params?: PaginatedRequestParams</span><a href="#listtoolsrequest-params" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Inherited from PaginatedRequest.params</p></aside></section><section><div><span>method: "tools/list"</span><a href="#listtoolsrequest-method" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside><p>Overrides PaginatedRequest.method</p></aside></section> | |
| </div> | |
| <div> | |
| ### `ListToolsResult` | |
| <div><span>interface</span> <span>ListToolsResult</span> <span>\{</span><br /> <a href="#listtoolsresult-_meta">\_meta</a><span>?:</span> <span>\{</span> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>unknown</span> <span>}</span><span>;</span><br /> <a href="#listtoolsresult-nextcursor">nextCursor</a><span>?:</span> <span>string</span><span>;</span><br /> <a href="#listtoolsresult-tools">tools</a><span>:</span> <a href="#tool">Tool</a><span>\[]</span><span>;</span><br /> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>unknown</span><span>;</span><br /><span>}</span></div><div><p>The server's response to a tools/list request from the client.</p> </div><section><div><span>\_meta?: \{ \[key: string]: unknown }</span><a href="#listtoolsresult-_meta" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>See <a href="/specification/2025-11-25/basic/index#meta">General fields: <code>\_meta</code></a> for notes on <code>\_meta</code> usage.</p> </div><aside><p>Inherited from PaginatedResult.\_meta</p></aside></section><section><div><span>nextCursor?: string</span><a href="#listtoolsresult-nextcursor" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>An opaque token representing the pagination position after the last returned result. | |
| If present, there may be more results available.</p> </div><aside><p>Inherited from PaginatedResult.nextCursor</p></aside></section><section><div><span>tools: Tool\[]</span><a href="#listtoolsresult-tools" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section> | |
| </div> | |
| <div> | |
| ### `Tool` | |
| <div><span>interface</span> <span>Tool</span> <span>\{</span><br /> <a href="#tool-icons">icons</a><span>?:</span> <a href="#icon">Icon</a><span>\[]</span><span>;</span><br /> <a href="#tool-name">name</a><span>:</span> <span>string</span><span>;</span><br /> <a href="#tool-title">title</a><span>?:</span> <span>string</span><span>;</span><br /> <a href="#tool-description">description</a><span>?:</span> <span>string</span><span>;</span><br /> <a href="#tool-inputschema">inputSchema</a><span>:</span> <span>\{</span><br /> <span>\$schema</span><span>?:</span> <span>string</span><span>;</span><br /> <span>type</span><span>:</span> <span>"object"</span><span>;</span><br /> <span>properties</span><span>?:</span> <span>\{</span> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>object</span> <span>}</span><span>;</span><br /> <span>required</span><span>?:</span> <span>string</span><span>\[]</span><span>;</span><br /> <span>}</span><span>;</span><br /> <a href="#tool-execution">execution</a><span>?:</span> <a href="#toolexecution">ToolExecution</a><span>;</span><br /> <a href="#tool-outputschema">outputSchema</a><span>?:</span> <span>\{</span><br /> <span>\$schema</span><span>?:</span> <span>string</span><span>;</span><br /> <span>type</span><span>:</span> <span>"object"</span><span>;</span><br /> <span>properties</span><span>?:</span> <span>\{</span> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>object</span> <span>}</span><span>;</span><br /> <span>required</span><span>?:</span> <span>string</span><span>\[]</span><span>;</span><br /> <span>}</span><span>;</span><br /> <a href="#tool-annotations">annotations</a><span>?:</span> <a href="#toolannotations">ToolAnnotations</a><span>;</span><br /> <a href="#tool-_meta">\_meta</a><span>?:</span> <span>\{</span> <span>\[</span><span>key</span><span>:</span> <span>string</span><span>]:</span> <span>unknown</span> <span>}</span><span>;</span><br /><span>}</span></div><div><p>Definition for a tool the client can call.</p> </div><section><div><span>icons?: Icon\[]</span><a href="#tool-icons" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Optional set of sized icons that the client can display in a user interface.</p> <p>Clients that support rendering icons MUST support at least the following MIME types:</p> <ul> <li><code>image/png</code> - PNG images (safe, universal compatibility)</li> <li><code>image/jpeg</code> (and <code>image/jpg</code>) - JPEG images (safe, universal compatibility)</li> </ul> <p>Clients that support rendering icons SHOULD also support:</p> <ul> <li><code>image/svg+xml</code> - SVG images (scalable but requires security precautions)</li> <li><code>image/webp</code> - WebP images (modern, efficient format)</li> </ul> </div><aside><p>Inherited from Icons.icons</p></aside></section><section><div><span>name: string</span><a href="#tool-name" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Intended for programmatic or logical use, but used as a display name in past specs or fallback (if title isn't present).</p> </div><aside><p>Inherited from BaseMetadata.name</p></aside></section><section><div><span>title?: string</span><a href="#tool-title" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Intended for UI and end-user contexts — optimized to be human-readable and easily understood, | |
| even by those unfamiliar with domain-specific terminology.</p> <p>If not provided, the name should be used for display (except for Tool, | |
| where <code>annotations.title</code> should be given precedence over using <code>name</code>, | |
| if present).</p> </div><aside><p>Inherited from BaseMetadata.title</p></aside></section><section><div><span>description?: string</span><a href="#tool-description" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>A human-readable description of the tool.</p> <p>This can be used by clients to improve the LLM's understanding of available tools. It can be thought of like a "hint" to the model.</p> </div></section><section><div><span>inputSchema: \{ \$schema?: string; type: "object"; properties?: \{ \[key: string]: object }; required?: string\[]; }</span><a href="#tool-inputschema" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>A JSON Schema object defining the expected parameters for the tool.</p> </div></section><section><div><span>execution?: ToolExecution</span><a href="#tool-execution" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Execution-related properties for this tool.</p> </div></section><section><div><span>outputSchema?: \{ \$schema?: string; type: "object"; properties?: \{ \[key: string]: object }; required?: string\[]; }</span><a href="#tool-outputschema" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>An optional JSON Schema object defining the structure of the tool's output returned in | |
| the structuredContent field of a CallToolResult.</p> <p>Defaults to JSON Schema 2020-12 when no explicit \$schema is provided. | |
| Currently restricted to type: "object" at the root level.</p> </div></section><section><div><span>annotations?: ToolAnnotations</span><a href="#tool-annotations" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Optional additional tool information.</p> <p>Display name precedence order is: title, annotations.title, then name.</p> </div></section><section><div><span>\_meta?: \{ \[key: string]: unknown }</span><a href="#tool-_meta" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>See <a href="/specification/2025-11-25/basic/index#meta">General fields: <code>\_meta</code></a> for notes on <code>\_meta</code> usage.</p> </div></section> | |
| </div> | |
| <div> | |
| ### `ToolAnnotations` | |
| <div><span>interface</span> <span>ToolAnnotations</span> <span>\{</span><br /> <a href="#toolannotations-title">title</a><span>?:</span> <span>string</span><span>;</span><br /> <a href="#toolannotations-readonlyhint">readOnlyHint</a><span>?:</span> <span>boolean</span><span>;</span><br /> <a href="#toolannotations-destructivehint">destructiveHint</a><span>?:</span> <span>boolean</span><span>;</span><br /> <a href="#toolannotations-idempotenthint">idempotentHint</a><span>?:</span> <span>boolean</span><span>;</span><br /> <a href="#toolannotations-openworldhint">openWorldHint</a><span>?:</span> <span>boolean</span><span>;</span><br /><span>}</span></div><div><p>Additional properties describing a Tool to clients.</p> <p>NOTE: all properties in ToolAnnotations are <strong>hints</strong>. | |
| They are not guaranteed to provide a faithful description of | |
| tool behavior (including descriptive properties like <code>title</code>).</p> <p>Clients should never make tool use decisions based on ToolAnnotations | |
| received from untrusted servers.</p> </div><section><div><span>title?: string</span><a href="#toolannotations-title" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>A human-readable title for the tool.</p> </div></section><section><div><span>readOnlyHint?: boolean</span><a href="#toolannotations-readonlyhint" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>If true, the tool does not modify its environment.</p> <p>Default: false</p> </div></section><section><div><span>destructiveHint?: boolean</span><a href="#toolannotations-destructivehint" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>If true, the tool may perform destructive updates to its environment. | |
| If false, the tool performs only additive updates.</p> <p>(This property is meaningful only when <code>readOnlyHint == false</code>)</p> <p>Default: true</p> </div></section><section><div><span>idempotentHint?: boolean</span><a href="#toolannotations-idempotenthint" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>If true, calling the tool repeatedly with the same arguments | |
| will have no additional effect on its environment.</p> <p>(This property is meaningful only when <code>readOnlyHint == false</code>)</p> <p>Default: false</p> </div></section><section><div><span>openWorldHint?: boolean</span><a href="#toolannotations-openworldhint" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>If true, this tool may interact with an "open world" of external | |
| entities. If false, the tool's domain of interaction is closed. | |
| For example, the world of a web search tool is open, whereas that | |
| of a memory tool is not.</p> <p>Default: true</p> </div></section> | |
| </div> | |
| <div> | |
| ### `ToolExecution` | |
| <div><span>interface</span> <span>ToolExecution</span> <span>\{</span><br /> <a href="#toolexecution-tasksupport">taskSupport</a><span>?:</span> <span>"forbidden"</span> <span>|</span> <span>"optional"</span> <span>|</span> <span>"required"</span><span>;</span><br /><span>}</span></div><div><p>Execution-related properties for a tool.</p> </div><section><div><span>taskSupport?: "forbidden" | "optional" | "required"</span><a href="#toolexecution-tasksupport" aria-label="Permalink"><svg><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div><p>Indicates whether this tool supports task-augmented execution. | |
| This allows clients to handle long-running operations through polling | |
| the task system.</p> <ul> <li>"forbidden": Tool does not support task-augmented execution (default when absent)</li> <li>"optional": Tool may support task-augmented execution</li> <li>"required": Tool requires task-augmented execution</li> </ul> <p>Default: "forbidden"</p> </div></section> | |
| </div> | |