> ## Documentation Index
> Fetch the complete documentation index at: https://mcp-sep-skills-extension.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Schema Reference

<div id="schema-reference" />

## JSON-RPC

<div class="type">
  ### `JSONRPCErrorResponse`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">JSONRPCErrorResponse</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#jsonrpcerrorresponse-jsonrpc">jsonrpc</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"2.0"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#jsonrpcerrorresponse-id">id</a><span class="tsd-signature-symbol">?:</span> <a href="#requestid" class="tsd-signature-type tsd-kind-type-alias">RequestId</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#jsonrpcerrorresponse-error">error</a><span class="tsd-signature-symbol">:</span> <a href="#error" class="tsd-signature-type tsd-kind-interface">Error</a><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>A response to a request that indicates an error occurred.</p> </div><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="jsonrpcerrorresponse-jsonrpc" data-typedoc-h="3"><span>jsonrpc: "2.0"</span><a href="#jsonrpcerrorresponse-jsonrpc" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="jsonrpcerrorresponse-id" data-typedoc-h="3"><span>id?: RequestId</span><a href="#jsonrpcerrorresponse-id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="jsonrpcerrorresponse-error" data-typedoc-h="3"><span>error: Error</span><a href="#jsonrpcerrorresponse-error" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section>
</div>

<div class="type">
  ### `JSONRPCMessage`

  <div class="tsd-signature"><span class="tsd-kind-type-alias">JSONRPCMessage</span><span class="tsd-signature-symbol">:</span> <a href="#jsonrpcrequest" class="tsd-signature-type tsd-kind-interface">JSONRPCRequest</a> <span class="tsd-signature-symbol">|</span> <a href="#jsonrpcnotification" class="tsd-signature-type tsd-kind-interface">JSONRPCNotification</a> <span class="tsd-signature-symbol">|</span> <a href="#jsonrpcresponse" class="tsd-signature-type tsd-kind-type-alias">JSONRPCResponse</a></div><div class="tsd-comment tsd-typography"><p>Refers to any valid JSON-RPC object that can be decoded off the wire, or encoded to be sent.</p> </div>
</div>

<div class="type">
  ### `JSONRPCNotification`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">JSONRPCNotification</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#jsonrpcnotification-method">method</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#jsonrpcnotification-params">params</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">\{</span> <span class="tsd-signature-symbol">\[</span><span class="tsd-kind-index-signature">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <span class="tsd-signature-type">any</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#jsonrpcnotification-jsonrpc">jsonrpc</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"2.0"</span><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>A notification which does not expect a response.</p> </div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="jsonrpcnotification-method" data-typedoc-h="3"><span>method: string</span><a href="#jsonrpcnotification-method" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from Notification.method</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="jsonrpcnotification-params" data-typedoc-h="3"><span>params?: \{ \[key: string]: any }</span><a href="#jsonrpcnotification-params" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from Notification.params</p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="jsonrpcnotification-jsonrpc" data-typedoc-h="3"><span>jsonrpc: "2.0"</span><a href="#jsonrpcnotification-jsonrpc" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section>
</div>

<div class="type">
  ### `JSONRPCRequest`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">JSONRPCRequest</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#jsonrpcrequest-method">method</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#jsonrpcrequest-params">params</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">\{</span> <span class="tsd-signature-symbol">\[</span><span class="tsd-kind-index-signature">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <span class="tsd-signature-type">any</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#jsonrpcrequest-jsonrpc">jsonrpc</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"2.0"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#jsonrpcrequest-id">id</a><span class="tsd-signature-symbol">:</span> <a href="#requestid" class="tsd-signature-type tsd-kind-type-alias">RequestId</a><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>A request that expects a response.</p> </div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="jsonrpcrequest-method" data-typedoc-h="3"><span>method: string</span><a href="#jsonrpcrequest-method" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from Request.method</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="jsonrpcrequest-params" data-typedoc-h="3"><span>params?: \{ \[key: string]: any }</span><a href="#jsonrpcrequest-params" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from Request.params</p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="jsonrpcrequest-jsonrpc" data-typedoc-h="3"><span>jsonrpc: "2.0"</span><a href="#jsonrpcrequest-jsonrpc" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="jsonrpcrequest-id" data-typedoc-h="3"><span>id: RequestId</span><a href="#jsonrpcrequest-id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section>
</div>

<div class="type">
  ### `JSONRPCResponse`

  <div class="tsd-signature"><span class="tsd-kind-type-alias">JSONRPCResponse</span><span class="tsd-signature-symbol">:</span> <a href="#jsonrpcresultresponse" class="tsd-signature-type tsd-kind-interface">JSONRPCResultResponse</a> <span class="tsd-signature-symbol">|</span> <a href="#jsonrpcerrorresponse" class="tsd-signature-type tsd-kind-interface">JSONRPCErrorResponse</a></div><div class="tsd-comment tsd-typography"><p>A response to a request, containing either the result or error.</p> </div>
</div>

<div class="type">
  ### `JSONRPCResultResponse`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">JSONRPCResultResponse</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#jsonrpcresultresponse-jsonrpc">jsonrpc</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"2.0"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#jsonrpcresultresponse-id">id</a><span class="tsd-signature-symbol">:</span> <a href="#requestid" class="tsd-signature-type tsd-kind-type-alias">RequestId</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#jsonrpcresultresponse-result">result</a><span class="tsd-signature-symbol">:</span> <a href="#result" class="tsd-signature-type tsd-kind-interface">Result</a><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>A successful (non-error) response to a request.</p> </div><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="jsonrpcresultresponse-jsonrpc" data-typedoc-h="3"><span>jsonrpc: "2.0"</span><a href="#jsonrpcresultresponse-jsonrpc" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="jsonrpcresultresponse-id" data-typedoc-h="3"><span>id: RequestId</span><a href="#jsonrpcresultresponse-id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="jsonrpcresultresponse-result" data-typedoc-h="3"><span>result: Result</span><a href="#jsonrpcresultresponse-result" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section>
</div>

## Common Types

<div class="type">
  ### `Annotations`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">Annotations</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#annotations-audience">audience</a><span class="tsd-signature-symbol">?:</span> <a href="#role" class="tsd-signature-type tsd-kind-type-alias">Role</a><span class="tsd-signature-symbol">\[]</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#annotations-priority">priority</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#annotations-lastmodified">lastModified</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Optional annotations for the client. The client can use annotations to inform how objects are used or displayed</p> </div><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="annotations-audience" data-typedoc-h="3"><span>audience?: Role\[]</span><a href="#annotations-audience" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><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 class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="annotations-priority" data-typedoc-h="3"><span>priority?: number</span><a href="#annotations-priority" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><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 class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="annotations-lastmodified" data-typedoc-h="3"><span>lastModified?: string</span><a href="#annotations-lastmodified" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><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 class="type">
  ### `Cursor`

  <div class="tsd-signature"><span class="tsd-kind-type-alias">Cursor</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>An opaque token used to represent a cursor for pagination.</p> </div>
</div>

<div class="type">
  ### `EmptyResult`

  <div class="tsd-signature"><span class="tsd-kind-type-alias">EmptyResult</span><span class="tsd-signature-symbol">:</span> <a href="#result" class="tsd-signature-type tsd-kind-interface">Result</a></div><div class="tsd-comment tsd-typography"><p>A result that indicates success but carries no data.</p> </div>
</div>

<div class="type">
  ### `Icon`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">Icon</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#icon-src">src</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#icon-mimetype">mimeType</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#icon-sizes">sizes</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">\[]</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#icon-theme">theme</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"light"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"dark"</span><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>An optionally-sized icon that can be displayed in a user interface.</p> </div><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="icon-src" data-typedoc-h="3"><span>src: string</span><a href="#icon-src" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><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 take 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 class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="icon-mimetype" data-typedoc-h="3"><span>mimeType?: string</span><a href="#icon-mimetype" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><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 class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="icon-sizes" data-typedoc-h="3"><span>sizes?: string\[]</span><a href="#icon-sizes" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><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 class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="icon-theme" data-typedoc-h="3"><span>theme?: "light" | "dark"</span><a href="#icon-theme" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><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 class="type">
  ### `InputResponseRequestParams`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">InputResponseRequestParams</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#inputresponserequestparams-_meta">\_meta</a><span class="tsd-signature-symbol">:</span> <a href="#requestmetaobject" class="tsd-signature-type tsd-kind-interface">RequestMetaObject</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#inputresponserequestparams-inputresponses">inputResponses</a><span class="tsd-signature-symbol">?:</span> <a href="#inputresponses" class="tsd-signature-type tsd-kind-interface">InputResponses</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#inputresponserequestparams-requeststate">requestState</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Common params for any request.</p> </div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="inputresponserequestparams-_meta" data-typedoc-h="3"><span>\_meta: RequestMetaObject</span><a href="#inputresponserequestparams-_meta" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#requestparams">RequestParams</a>.<a href="#requestparams-_meta">\_meta</a></p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="inputresponserequestparams-inputresponses" data-typedoc-h="3"><span>inputResponses?: InputResponses</span><a href="#inputresponserequestparams-inputresponses" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="inputresponserequestparams-requeststate" data-typedoc-h="3"><span>requestState?: string</span><a href="#inputresponserequestparams-requeststate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section>
</div>

<div class="type">
  ### `JSONArray`

  <div class="tsd-signature"><span class="tsd-kind-type-alias">JSONArray</span><span class="tsd-signature-symbol">:</span> <a href="#jsonvalue" class="tsd-signature-type tsd-kind-type-alias">JSONValue</a><span class="tsd-signature-symbol">\[]</span></div>
</div>

<div class="type">
  ### `JSONObject`

  <div class="tsd-signature"><span class="tsd-kind-type-alias">JSONObject</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">\{</span> <span class="tsd-signature-symbol">\[</span><span class="tsd-kind-index-signature">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <a href="#jsonvalue" class="tsd-signature-type tsd-kind-type-alias">JSONValue</a> <span class="tsd-signature-symbol">}</span></div><div class="tsd-type-declaration"><div data-typedoc-h="4">Type Declaration</div><ul class="tsd-parameters"><li class="tsd-parameter-index-signature"><div data-typedoc-h="5"><span class="tsd-signature-symbol">\[</span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <a href="#jsonvalue" class="tsd-signature-type tsd-kind-type-alias">JSONValue</a></div></li></ul></div>
</div>

<div class="type">
  ### `JSONValue`

  <div class="tsd-signature"><span class="tsd-kind-type-alias">JSONValue</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="#jsonobject" class="tsd-signature-type tsd-kind-type-alias">JSONObject</a> <span class="tsd-signature-symbol">|</span> <a href="#jsonarray" class="tsd-signature-type tsd-kind-type-alias">JSONArray</a></div>
</div>

<div class="type">
  ### `LoggingLevel`

  <div class="tsd-signature"><span class="tsd-kind-type-alias">LoggingLevel</span><span class="tsd-signature-symbol">:</span><br />  <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"debug"</span><br />  <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"info"</span><br />  <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"notice"</span><br />  <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"warning"</span><br />  <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"error"</span><br />  <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"critical"</span><br />  <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"alert"</span><br />  <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"emergency"</span></div><div class="tsd-comment tsd-typography"><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 class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><div class="tsd-anchor-link" data-typedoc-h="4">Deprecated</div><p>Deprecated as of protocol version 2026-07-28 (SEP-2577).
  Remains in the specification for at least twelve months; see the
  deprecated features registry.</p> </div></div>
</div>

<div class="type">
  ### `MetaObject`

  <div class="tsd-signature"><span class="tsd-kind-type-alias">MetaObject</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">\<</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Represents the contents of a <code>\_meta</code> field, which clients and servers use to attach additional metadata to their interactions.</p> <p>Certain key names are reserved by MCP for protocol-level metadata; implementations MUST NOT make assumptions about values at these keys. Additionally, specific schema definitions may reserve particular names for purpose-specific metadata, as declared in those definitions.</p> <p>Valid keys have two segments:</p> <p><strong>Prefix:</strong></p> <ul> <li>Optional — if specified, MUST be a series of <em>labels</em> separated by dots (<code>.</code>), followed by a slash (<code>/</code>).</li> <li>Labels MUST start with a letter and end with a letter or digit. Interior characters may be letters, digits, or hyphens (<code>-</code>).</li> <li>Implementations SHOULD use reverse DNS notation (e.g., <code>com.example/</code> rather than <code>example.com/</code>).</li> <li>Any prefix where the second label is <code>modelcontextprotocol</code> or <code>mcp</code> is <strong>reserved</strong> for MCP use. For example: <code>io.modelcontextprotocol/</code>, <code>dev.mcp/</code>, <code>org.modelcontextprotocol.api/</code>, and <code>com.mcp.tools/</code> are all reserved. However, <code>com.example.mcp/</code> is NOT reserved, as the second label is <code>example</code>.</li> </ul> <p><strong>Name:</strong></p> <ul> <li>Unless empty, MUST start and end with an alphanumeric character (<code>\[a-z0-9A-Z]</code>).</li> <li>Interior characters may be alphanumeric, hyphens (<code>-</code>), underscores (<code>\_</code>), or dots (<code>.</code>).</li> </ul> </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><div class="tsd-anchor-link" data-typedoc-h="4">See</div><p><a href="/specification/draft/basic/index#meta">General fields: <code>\_meta</code></a> for more details.</p> </div></div>
</div>

<div class="type">
  ### `NotificationParams`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">NotificationParams</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#notificationparams-_meta">\_meta</a><span class="tsd-signature-symbol">?:</span> <a href="#metaobject" class="tsd-signature-type tsd-kind-type-alias">MetaObject</a><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Common params for any notification.</p> </div><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="notificationparams-_meta" data-typedoc-h="3"><span>\_meta?: MetaObject</span><a href="#notificationparams-_meta" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section>
</div>

<div class="type">
  ### `PaginatedRequestParams`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">PaginatedRequestParams</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#paginatedrequestparams-_meta">\_meta</a><span class="tsd-signature-symbol">:</span> <a href="#requestmetaobject" class="tsd-signature-type tsd-kind-interface">RequestMetaObject</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#paginatedrequestparams-cursor">cursor</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Common params for paginated requests.</p> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: List request with cursor<a href="#paginatedrequestparams-example-list-request-with-cursor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="paginatedrequestparams-example-list-request-with-cursor"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"\_meta"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"io.modelcontextprotocol/protocolVersion"</span><span class="hl-0">: </span><span class="hl-2">"2026-07-28"</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"io.modelcontextprotocol/clientInfo"</span><span class="hl-0">: \{</span><br /><span class="hl-0">      </span><span class="hl-1">"name"</span><span class="hl-0">: </span><span class="hl-2">"ExampleClient"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"version"</span><span class="hl-0">: </span><span class="hl-2">"1.0.0"</span><br /><span class="hl-0">    },</span><br /><span class="hl-0">    </span><span class="hl-1">"io.modelcontextprotocol/clientCapabilities"</span><span class="hl-0">: \{}</span><br /><span class="hl-0">  },</span><br /><span class="hl-0">  </span><span class="hl-1">"cursor"</span><span class="hl-0">: </span><span class="hl-2">"eyJwYWdlIjogMn0="</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="paginatedrequestparams-_meta" data-typedoc-h="3"><span>\_meta: RequestMetaObject</span><a href="#paginatedrequestparams-_meta" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#requestparams">RequestParams</a>.<a href="#requestparams-_meta">\_meta</a></p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="paginatedrequestparams-cursor" data-typedoc-h="3"><span>cursor?: string</span><a href="#paginatedrequestparams-cursor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>An opaque token representing the current pagination position.
  If provided, the server should return results starting after this cursor.</p> </div></section>
</div>

<div class="type">
  ### `ProgressToken`

  <div class="tsd-signature"><span class="tsd-kind-type-alias">ProgressToken</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>A progress token, used to associate progress notifications with the original request.</p> </div>
</div>

<div class="type">
  ### `RequestId`

  <div class="tsd-signature"><span class="tsd-kind-type-alias">RequestId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>A uniquely identifying ID for a request in JSON-RPC.</p> </div>
</div>

<div class="type">
  ### `RequestMetaObject`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">RequestMetaObject</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#requestmetaobject-progresstoken">progressToken</a><span class="tsd-signature-symbol">?:</span> <a href="#progresstoken" class="tsd-signature-type tsd-kind-type-alias">ProgressToken</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#requestmetaobject-iomodelcontextprotocolprotocolversion">"io.modelcontextprotocol/protocolVersion"</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#requestmetaobject-iomodelcontextprotocolclientinfo">"io.modelcontextprotocol/clientInfo"</a><span class="tsd-signature-symbol">:</span> <a href="#implementation" class="tsd-signature-type tsd-kind-interface">Implementation</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#requestmetaobject-iomodelcontextprotocolclientcapabilities">"io.modelcontextprotocol/clientCapabilities"</a><span class="tsd-signature-symbol">:</span> <a href="#clientcapabilities" class="tsd-signature-type tsd-kind-interface">ClientCapabilities</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#requestmetaobject-iomodelcontextprotocolloglevel">"io.modelcontextprotocol/logLevel"</a><span class="tsd-signature-symbol">?:</span> <a href="#logginglevel" class="tsd-signature-type tsd-kind-type-alias">LoggingLevel</a><span class="tsd-signature-symbol">;</span><br />  <span class="tsd-signature-symbol">\[</span><span class="tsd-kind-index-signature">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Extends <a href="#metaobject" class="tsd-kind-type-alias">MetaObject</a> with additional request-specific fields. All key naming rules from <code>MetaObject</code> apply.</p> </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><div class="tsd-anchor-link" data-typedoc-h="4">See</div><ul> <li><a href="#metaobject" class="tsd-kind-type-alias">MetaObject</a> for key naming rules and reserved prefixes.</li> <li><a href="/specification/draft/basic/index#meta">General fields: <code>\_meta</code></a> for more details.</li> </ul> </div></div><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="requestmetaobject-progresstoken" data-typedoc-h="3"><span>progressToken?: ProgressToken</span><a href="#requestmetaobject-progresstoken" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>If specified, the caller is requesting out-of-band progress notifications for this request (as represented by <a href="#progressnotification" class="tsd-kind-interface">notifications/progress</a>). 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></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="requestmetaobject-iomodelcontextprotocolprotocolversion" data-typedoc-h="3"><span>"io.modelcontextprotocol/protocolVersion": string</span><a href="#requestmetaobject-iomodelcontextprotocolprotocolversion" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>The MCP Protocol Version being used for this request. Required.</p> <p>For the HTTP transport, this value MUST match the <code>MCP-Protocol-Version</code>
  header; otherwise the server MUST return a <code>400 Bad Request</code>. If the
  server does not support the requested version, it MUST return an <a href="#unsupportedprotocolversionerror" class="tsd-kind-interface">UnsupportedProtocolVersionError</a>.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="requestmetaobject-iomodelcontextprotocolclientinfo" data-typedoc-h="3"><span>"io.modelcontextprotocol/clientInfo": Implementation</span><a href="#requestmetaobject-iomodelcontextprotocolclientinfo" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Identifies the client software making the request. Required.</p> <p>The <a href="#implementation" class="tsd-kind-interface">Implementation</a> schema requires <code>name</code> and <code>version</code>; other
  fields are optional.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="requestmetaobject-iomodelcontextprotocolclientcapabilities" data-typedoc-h="3"><span>"io.modelcontextprotocol/clientCapabilities": ClientCapabilities</span><a href="#requestmetaobject-iomodelcontextprotocolclientcapabilities" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>The client's capabilities for this specific request. Required.</p> <p>Capabilities are declared per-request rather than once at initialization;
  an empty object means the client supports no optional capabilities.
  Servers MUST NOT infer capabilities from prior requests.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="requestmetaobject-iomodelcontextprotocolloglevel" data-typedoc-h="3"><span class="deprecated">"io.modelcontextprotocol/logLevel"?: LoggingLevel</span><a href="#requestmetaobject-iomodelcontextprotocolloglevel" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>The desired log level for this request. Optional.</p> <p>If absent, the server MUST NOT send any <a href="#loggingmessagenotification" class="tsd-kind-interface">notifications/message</a>
  notifications for this request. The client opts in to log messages by
  explicitly setting a level. Replaces the former <code>logging/setLevel</code> RPC.</p> </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><div class="tsd-anchor-link" data-typedoc-h="4">Deprecated</div><p>Deprecated as of protocol version 2026-07-28 (SEP-2577).
  Remains in the specification for at least twelve months; see the
  deprecated features registry.</p> </div></div></section>
</div>

<div class="type">
  ### `RequestParams`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">RequestParams</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#requestparams-_meta">\_meta</a><span class="tsd-signature-symbol">:</span> <a href="#requestmetaobject" class="tsd-signature-type tsd-kind-interface">RequestMetaObject</a><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Common params for any request.</p> </div><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="requestparams-_meta" data-typedoc-h="3"><span>\_meta: RequestMetaObject</span><a href="#requestparams-_meta" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section>
</div>

<div class="type">
  ### `Result`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">Result</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#result-_meta">\_meta</a><span class="tsd-signature-symbol">?:</span> <a href="#metaobject" class="tsd-signature-type tsd-kind-type-alias">MetaObject</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#result-resulttype">resultType</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <span class="tsd-signature-symbol">\[</span><span class="tsd-kind-index-signature">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Common result fields.</p> </div><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="result-_meta" data-typedoc-h="3"><span>\_meta?: MetaObject</span><a href="#result-_meta" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="result-resulttype" data-typedoc-h="3"><span>resultType: string</span><a href="#result-resulttype" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Indicates the type of the result, which allows the client to determine
  how to parse the result object.</p> <p>Servers implementing this protocol version MUST include this field.
  For backward compatibility, when a client receives a result from a
  server implementing an earlier protocol version (which does not include <code>resultType</code>), the client MUST treat the absent field as <code>"complete"</code>.</p> </div></section>
</div>

<div class="type">
  ### `ResultType`

  <div class="tsd-signature"><span class="tsd-kind-type-alias">ResultType</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"complete"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"input\_required"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Indicates the type of a <a href="#result" class="tsd-kind-interface">Result</a> object, allowing the client to
  determine how to parse the response.</p> <p>complete - the request completed successfully and the result contains the final content.
  input\_required - the request requires additional input and the result contains an <a href="#inputrequiredresult" class="tsd-kind-interface">InputRequiredResult</a> object with instructions for the client to provide additional input before retrying the original request.</p> </div>
</div>

<div class="type">
  ### `Role`

  <div class="tsd-signature"><span class="tsd-kind-type-alias">Role</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"user"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"assistant"</span></div><div class="tsd-comment tsd-typography"><p>The sender or recipient of messages and data in a conversation.</p> </div>
</div>

## Errors

<div class="type">
  ### `Error`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">Error</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#error-code">code</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#error-message">message</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#error-data">data</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="error-code" data-typedoc-h="3"><span>code: number</span><a href="#error-code" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>The error type that occurred.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="error-message" data-typedoc-h="3"><span>message: string</span><a href="#error-message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>A short description of the error. The message SHOULD be limited to a concise single sentence.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="error-data" data-typedoc-h="3"><span>data?: unknown</span><a href="#error-data" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><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 class="type">
  ### `InternalError`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">InternalError</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#internalerror-message">message</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#internalerror-data">data</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#internalerror-code">code</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">-32603</span><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>A JSON-RPC error indicating that an internal error occurred on the receiver. This error is returned when the receiver encounters an unexpected condition that prevents it from fulfilling the request.</p> </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><div class="tsd-anchor-link" data-typedoc-h="4">See</div><p><a href="https://www.jsonrpc.org/specification#error_object">JSON-RPC 2.0 Error Object</a></p> </div><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Unexpected error<a href="#internalerror-example-unexpected-error" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="internalerror-example-unexpected-error"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"code"</span><span class="hl-0">: </span><span class="hl-3">-32603</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"message"</span><span class="hl-0">: </span><span class="hl-2">"Internal error"</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="internalerror-message" data-typedoc-h="3"><span>message: string</span><a href="#internalerror-message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>A short description of the error. The message SHOULD be limited to a concise single sentence.</p> </div><aside class="tsd-sources"><p>Inherited from <a href="#error">Error</a>.<a href="#error-message">message</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="internalerror-data" data-typedoc-h="3"><span>data?: unknown</span><a href="#internalerror-data" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><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><aside class="tsd-sources"><p>Inherited from <a href="#error">Error</a>.<a href="#error-data">data</a></p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="internalerror-code" data-typedoc-h="3"><span>code: -32603</span><a href="#internalerror-code" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>The error type that occurred.</p> </div><aside class="tsd-sources"><p>Overrides <a href="#error">Error</a>.<a href="#error-code">code</a></p></aside></section>
</div>

<div class="type">
  ### `InvalidParamsError`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">InvalidParamsError</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#invalidparamserror-message">message</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#invalidparamserror-data">data</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#invalidparamserror-code">code</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">-32602</span><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>A JSON-RPC error indicating that the method parameters are invalid or malformed.</p> <p>In MCP, this error is returned in various contexts when request parameters fail validation:</p> <ul> <li><strong>Tools</strong>: Unknown tool name or invalid tool arguments</li> <li><strong>Prompts</strong>: Unknown prompt name or missing required arguments</li> <li><strong>Pagination</strong>: Invalid or expired cursor values</li> <li><strong>Logging</strong>: Invalid log level</li> <li><strong>Elicitation</strong>: Server requests an elicitation mode not declared in client capabilities</li> <li><strong>Sampling</strong>: Missing tool result or tool results mixed with other content</li> </ul> </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><div class="tsd-anchor-link" data-typedoc-h="4">See</div><p><a href="https://www.jsonrpc.org/specification#error_object">JSON-RPC 2.0 Error Object</a></p> </div><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Unknown tool<a href="#invalidparamserror-example-unknown-tool" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="invalidparamserror-example-unknown-tool"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"code"</span><span class="hl-0">: </span><span class="hl-3">-32602</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"message"</span><span class="hl-0">: </span><span class="hl-2">"Unknown tool: invalid\_tool\_name"</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Invalid tool arguments<a href="#invalidparamserror-example-invalid-tool-arguments" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="invalidparamserror-example-invalid-tool-arguments"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"code"</span><span class="hl-0">: </span><span class="hl-3">-32602</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"message"</span><span class="hl-0">: </span><span class="hl-2">"Invalid arguments for tool calculate: Missing required property 'expression'"</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Unknown prompt<a href="#invalidparamserror-example-unknown-prompt" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="invalidparamserror-example-unknown-prompt"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"code"</span><span class="hl-0">: </span><span class="hl-3">-32602</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"message"</span><span class="hl-0">: </span><span class="hl-2">"Unknown prompt: invalid\_prompt\_name"</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Invalid cursor<a href="#invalidparamserror-example-invalid-cursor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="invalidparamserror-example-invalid-cursor"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"code"</span><span class="hl-0">: </span><span class="hl-3">-32602</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"message"</span><span class="hl-0">: </span><span class="hl-2">"Invalid cursor"</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="invalidparamserror-message" data-typedoc-h="3"><span>message: string</span><a href="#invalidparamserror-message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>A short description of the error. The message SHOULD be limited to a concise single sentence.</p> </div><aside class="tsd-sources"><p>Inherited from <a href="#error">Error</a>.<a href="#error-message">message</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="invalidparamserror-data" data-typedoc-h="3"><span>data?: unknown</span><a href="#invalidparamserror-data" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><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><aside class="tsd-sources"><p>Inherited from <a href="#error">Error</a>.<a href="#error-data">data</a></p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="invalidparamserror-code" data-typedoc-h="3"><span>code: -32602</span><a href="#invalidparamserror-code" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>The error type that occurred.</p> </div><aside class="tsd-sources"><p>Overrides <a href="#error">Error</a>.<a href="#error-code">code</a></p></aside></section>
</div>

<div class="type">
  ### `InvalidRequestError`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">InvalidRequestError</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#invalidrequesterror-message">message</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#invalidrequesterror-data">data</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#invalidrequesterror-code">code</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">-32600</span><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>A JSON-RPC error indicating that the request is not a valid request object. This error is returned when the message structure does not conform to the JSON-RPC 2.0 specification requirements for a request (e.g., missing required fields like <code>jsonrpc</code> or <code>method</code>, or using invalid types for these fields).</p> </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><div class="tsd-anchor-link" data-typedoc-h="4">See</div><p><a href="https://www.jsonrpc.org/specification#error_object">JSON-RPC 2.0 Error Object</a></p> </div></div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="invalidrequesterror-message" data-typedoc-h="3"><span>message: string</span><a href="#invalidrequesterror-message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>A short description of the error. The message SHOULD be limited to a concise single sentence.</p> </div><aside class="tsd-sources"><p>Inherited from <a href="#error">Error</a>.<a href="#error-message">message</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="invalidrequesterror-data" data-typedoc-h="3"><span>data?: unknown</span><a href="#invalidrequesterror-data" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><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><aside class="tsd-sources"><p>Inherited from <a href="#error">Error</a>.<a href="#error-data">data</a></p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="invalidrequesterror-code" data-typedoc-h="3"><span>code: -32600</span><a href="#invalidrequesterror-code" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>The error type that occurred.</p> </div><aside class="tsd-sources"><p>Overrides <a href="#error">Error</a>.<a href="#error-code">code</a></p></aside></section>
</div>

<div class="type">
  ### `MethodNotFoundError`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">MethodNotFoundError</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#methodnotfounderror-message">message</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#methodnotfounderror-data">data</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#methodnotfounderror-code">code</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">-32601</span><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>A JSON-RPC error indicating that the requested method does not exist or is not available.</p> <p>In MCP, a server returns this error when a client invokes a method the server does not implement — either a genuinely unknown method, or one gated behind a server capability the server did not advertise (e.g., calling <code>prompts/list</code> when the <code>prompts</code> capability was not advertised).</p> <p>A request that requires a client capability the client did not declare is signalled instead by <a href="#missingrequiredclientcapabilityerror" class="tsd-kind-interface">MissingRequiredClientCapabilityError</a> (<code>-32003</code>).</p> </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><div class="tsd-anchor-link" data-typedoc-h="4">See</div><p><a href="https://www.jsonrpc.org/specification#error_object">JSON-RPC 2.0 Error Object</a></p> </div><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Prompts not supported<a href="#methodnotfounderror-example-prompts-not-supported" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="methodnotfounderror-example-prompts-not-supported"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"code"</span><span class="hl-0">: </span><span class="hl-3">-32601</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"message"</span><span class="hl-0">: </span><span class="hl-2">"Prompts not supported"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"data"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"reason"</span><span class="hl-0">: </span><span class="hl-2">"Server does not support the prompts capability"</span><br /><span class="hl-0">  }</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="methodnotfounderror-message" data-typedoc-h="3"><span>message: string</span><a href="#methodnotfounderror-message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>A short description of the error. The message SHOULD be limited to a concise single sentence.</p> </div><aside class="tsd-sources"><p>Inherited from <a href="#error">Error</a>.<a href="#error-message">message</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="methodnotfounderror-data" data-typedoc-h="3"><span>data?: unknown</span><a href="#methodnotfounderror-data" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><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><aside class="tsd-sources"><p>Inherited from <a href="#error">Error</a>.<a href="#error-data">data</a></p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="methodnotfounderror-code" data-typedoc-h="3"><span>code: -32601</span><a href="#methodnotfounderror-code" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>The error type that occurred.</p> </div><aside class="tsd-sources"><p>Overrides <a href="#error">Error</a>.<a href="#error-code">code</a></p></aside></section>
</div>

<div class="type">
  ### `MISSING_REQUIRED_CLIENT_CAPABILITY`

  <div class="tsd-signature"><span class="tsd-kind-variable">MISSING\_REQUIRED\_CLIENT\_CAPABILITY</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">-32003</span></div><div class="tsd-comment tsd-typography"><p>Error code returned when a server requires a client capability that was
  not declared in the request's <code>clientCapabilities</code>.</p> </div>
</div>

<div class="type">
  ### `MissingRequiredClientCapabilityError`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">MissingRequiredClientCapabilityError</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#missingrequiredclientcapabilityerror-jsonrpc">jsonrpc</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"2.0"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#missingrequiredclientcapabilityerror-id">id</a><span class="tsd-signature-symbol">?:</span> <a href="#requestid" class="tsd-signature-type tsd-kind-type-alias">RequestId</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#missingrequiredclientcapabilityerror-error">error</a><span class="tsd-signature-symbol">:</span> <a href="#error" class="tsd-signature-type tsd-kind-interface">Error</a> <span class="tsd-signature-symbol">&</span> <span class="tsd-signature-symbol">\{</span><br />    <span class="tsd-kind-property">code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">-32003</span><span class="tsd-signature-symbol">;</span><br />    <span class="tsd-kind-property">data</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">\{</span> <span class="tsd-kind-property">requiredCapabilities</span><span class="tsd-signature-symbol">:</span> <a href="#clientcapabilities" class="tsd-signature-type tsd-kind-interface">ClientCapabilities</a> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br />  <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Returned when processing a request requires a capability the client did not
  declare in <code>clientCapabilities</code>. For HTTP, the response status code MUST be <code>400 Bad Request</code>.</p> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Missing elicitation capability<a href="#missingrequiredclientcapabilityerror-example-missing-elicitation-capability" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="missingrequiredclientcapabilityerror-example-missing-elicitation-capability"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"jsonrpc"</span><span class="hl-0">: </span><span class="hl-2">"2.0"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"id"</span><span class="hl-0">: </span><span class="hl-3">1</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"error"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"code"</span><span class="hl-0">: </span><span class="hl-3">-32003</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"message"</span><span class="hl-0">: </span><span class="hl-2">"Server requires the elicitation capability for this request"</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"data"</span><span class="hl-0">: \{</span><br /><span class="hl-0">      </span><span class="hl-1">"requiredCapabilities"</span><span class="hl-0">: \{</span><br /><span class="hl-0">        </span><span class="hl-1">"elicitation"</span><span class="hl-0">: \{}</span><br /><span class="hl-0">      }</span><br /><span class="hl-0">    }</span><br /><span class="hl-0">  }</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="missingrequiredclientcapabilityerror-jsonrpc" data-typedoc-h="3"><span>jsonrpc: "2.0"</span><a href="#missingrequiredclientcapabilityerror-jsonrpc" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#jsonrpcerrorresponse">JSONRPCErrorResponse</a>.<a href="#jsonrpcerrorresponse-jsonrpc">jsonrpc</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="missingrequiredclientcapabilityerror-id" data-typedoc-h="3"><span>id?: RequestId</span><a href="#missingrequiredclientcapabilityerror-id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#jsonrpcerrorresponse">JSONRPCErrorResponse</a>.<a href="#jsonrpcerrorresponse-id">id</a></p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="missingrequiredclientcapabilityerror-error" data-typedoc-h="3"><span>error: Error & \{    code: -32003;    data: \{ requiredCapabilities: ClientCapabilities }; }</span><a href="#missingrequiredclientcapabilityerror-error" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section>
</div>

<div class="type">
  ### `ParseError`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ParseError</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#parseerror-message">message</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#parseerror-data">data</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#parseerror-code">code</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">-32700</span><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>A JSON-RPC error indicating that invalid JSON was received by the server. This error is returned when the server cannot parse the JSON text of a message.</p> </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><div class="tsd-anchor-link" data-typedoc-h="4">See</div><p><a href="https://www.jsonrpc.org/specification#error_object">JSON-RPC 2.0 Error Object</a></p> </div><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Invalid JSON<a href="#parseerror-example-invalid-json" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="parseerror-example-invalid-json"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"code"</span><span class="hl-0">: </span><span class="hl-3">-32700</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"message"</span><span class="hl-0">: </span><span class="hl-2">"Parse error: Invalid JSON"</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="parseerror-message" data-typedoc-h="3"><span>message: string</span><a href="#parseerror-message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>A short description of the error. The message SHOULD be limited to a concise single sentence.</p> </div><aside class="tsd-sources"><p>Inherited from <a href="#error">Error</a>.<a href="#error-message">message</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="parseerror-data" data-typedoc-h="3"><span>data?: unknown</span><a href="#parseerror-data" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><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><aside class="tsd-sources"><p>Inherited from <a href="#error">Error</a>.<a href="#error-data">data</a></p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="parseerror-code" data-typedoc-h="3"><span>code: -32700</span><a href="#parseerror-code" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>The error type that occurred.</p> </div><aside class="tsd-sources"><p>Overrides <a href="#error">Error</a>.<a href="#error-code">code</a></p></aside></section>
</div>

<div class="type">
  ### `UNSUPPORTED_PROTOCOL_VERSION`

  <div class="tsd-signature"><span class="tsd-kind-variable">UNSUPPORTED\_PROTOCOL\_VERSION</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">-32004</span></div><div class="tsd-comment tsd-typography"><p>Error code returned when the request's protocol version is not supported
  by the server.</p> </div>
</div>

<div class="type">
  ### `UnsupportedProtocolVersionError`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">UnsupportedProtocolVersionError</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#unsupportedprotocolversionerror-jsonrpc">jsonrpc</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"2.0"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#unsupportedprotocolversionerror-id">id</a><span class="tsd-signature-symbol">?:</span> <a href="#requestid" class="tsd-signature-type tsd-kind-type-alias">RequestId</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#unsupportedprotocolversionerror-error">error</a><span class="tsd-signature-symbol">:</span> <a href="#error" class="tsd-signature-type tsd-kind-interface">Error</a> <span class="tsd-signature-symbol">&</span> <span class="tsd-signature-symbol">\{</span><br />    <span class="tsd-kind-property">code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">-32004</span><span class="tsd-signature-symbol">;</span><br />    <span class="tsd-kind-property">data</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">\{</span> <span class="tsd-kind-property">supported</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">\[]</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">requested</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br />  <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Returned when the request's protocol version is unknown to the server or
  unsupported (e.g., a known experimental or draft version the server has
  chosen not to implement). For HTTP, the response status code MUST be <code>400 Bad Request</code>.</p> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Unsupported protocol version<a href="#unsupportedprotocolversionerror-example-unsupported-protocol-version" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="unsupportedprotocolversionerror-example-unsupported-protocol-version"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"jsonrpc"</span><span class="hl-0">: </span><span class="hl-2">"2.0"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"id"</span><span class="hl-0">: </span><span class="hl-3">1</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"error"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"code"</span><span class="hl-0">: </span><span class="hl-3">-32004</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"message"</span><span class="hl-0">: </span><span class="hl-2">"Unsupported protocol version"</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"data"</span><span class="hl-0">: \{</span><br /><span class="hl-0">      </span><span class="hl-1">"supported"</span><span class="hl-0">: \[</span><span class="hl-2">"2026-07-28"</span><span class="hl-0">, </span><span class="hl-2">"2025-11-25"</span><span class="hl-0">],</span><br /><span class="hl-0">      </span><span class="hl-1">"requested"</span><span class="hl-0">: </span><span class="hl-2">"1900-01-01"</span><br /><span class="hl-0">    }</span><br /><span class="hl-0">  }</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="unsupportedprotocolversionerror-jsonrpc" data-typedoc-h="3"><span>jsonrpc: "2.0"</span><a href="#unsupportedprotocolversionerror-jsonrpc" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#jsonrpcerrorresponse">JSONRPCErrorResponse</a>.<a href="#jsonrpcerrorresponse-jsonrpc">jsonrpc</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="unsupportedprotocolversionerror-id" data-typedoc-h="3"><span>id?: RequestId</span><a href="#unsupportedprotocolversionerror-id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#jsonrpcerrorresponse">JSONRPCErrorResponse</a>.<a href="#jsonrpcerrorresponse-id">id</a></p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="unsupportedprotocolversionerror-error" data-typedoc-h="3"><span>error: Error & \{    code: -32004;    data: \{ supported: string\[]; requested: string }; }</span><a href="#unsupportedprotocolversionerror-error" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section>
</div>

## Content

<div class="type">
  ### `AudioContent`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">AudioContent</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#audiocontent-type">type</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"audio"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#audiocontent-data">data</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#audiocontent-mimetype">mimeType</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#audiocontent-annotations">annotations</a><span class="tsd-signature-symbol">?:</span> <a href="#annotations" class="tsd-signature-type tsd-kind-interface">Annotations</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#audiocontent-_meta">\_meta</a><span class="tsd-signature-symbol">?:</span> <a href="#metaobject" class="tsd-signature-type tsd-kind-type-alias">MetaObject</a><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Audio provided to or from an LLM.</p> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: \`audio/wav\` content<a href="#audiocontent-example-audiowav-content" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="audiocontent-example-audiowav-content"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"audio"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"data"</span><span class="hl-0">: </span><span class="hl-2">"UklGRiQAAABXQVZFZm10IBAAAAABAAEARKwAAIhYAQACABAAZGF0YQAAAAA="</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"mimeType"</span><span class="hl-0">: </span><span class="hl-2">"audio/wav"</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="audiocontent-type" data-typedoc-h="3"><span>type: "audio"</span><a href="#audiocontent-type" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="audiocontent-data" data-typedoc-h="3"><span>data: string</span><a href="#audiocontent-data" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>The base64-encoded audio data.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="audiocontent-mimetype" data-typedoc-h="3"><span>mimeType: string</span><a href="#audiocontent-mimetype" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>The MIME type of the audio. Different providers may support different audio types.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="audiocontent-annotations" data-typedoc-h="3"><span>annotations?: Annotations</span><a href="#audiocontent-annotations" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Optional annotations for the client.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="audiocontent-_meta" data-typedoc-h="3"><span>\_meta?: MetaObject</span><a href="#audiocontent-_meta" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section>
</div>

<div class="type">
  ### `BlobResourceContents`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">BlobResourceContents</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#blobresourcecontents-uri">uri</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#blobresourcecontents-mimetype">mimeType</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#blobresourcecontents-_meta">\_meta</a><span class="tsd-signature-symbol">?:</span> <a href="#metaobject" class="tsd-signature-type tsd-kind-type-alias">MetaObject</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#blobresourcecontents-blob">blob</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Image file contents<a href="#blobresourcecontents-example-image-file-contents" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="blobresourcecontents-example-image-file-contents"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"uri"</span><span class="hl-0">: </span><span class="hl-2">"file:///example.png"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"mimeType"</span><span class="hl-0">: </span><span class="hl-2">"image/png"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"blob"</span><span class="hl-0">: </span><span class="hl-2">"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg=="</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="blobresourcecontents-uri" data-typedoc-h="3"><span>uri: string</span><a href="#blobresourcecontents-uri" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>The URI of this resource.</p> </div><aside class="tsd-sources"><p>Inherited from ResourceContents.uri</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="blobresourcecontents-mimetype" data-typedoc-h="3"><span>mimeType?: string</span><a href="#blobresourcecontents-mimetype" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>The MIME type of this resource, if known.</p> </div><aside class="tsd-sources"><p>Inherited from ResourceContents.mimeType</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="blobresourcecontents-_meta" data-typedoc-h="3"><span>\_meta?: MetaObject</span><a href="#blobresourcecontents-_meta" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from ResourceContents.\_meta</p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="blobresourcecontents-blob" data-typedoc-h="3"><span>blob: string</span><a href="#blobresourcecontents-blob" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>A base64-encoded string representing the binary data of the item.</p> </div></section>
</div>

<div class="type">
  ### `ContentBlock`

  <div class="tsd-signature"><span class="tsd-kind-type-alias">ContentBlock</span><span class="tsd-signature-symbol">:</span><br />  <span class="tsd-signature-symbol">|</span> <a href="#textcontent" class="tsd-signature-type tsd-kind-interface">TextContent</a><br />  <span class="tsd-signature-symbol">|</span> <a href="#imagecontent" class="tsd-signature-type tsd-kind-interface">ImageContent</a><br />  <span class="tsd-signature-symbol">|</span> <a href="#audiocontent" class="tsd-signature-type tsd-kind-interface">AudioContent</a><br />  <span class="tsd-signature-symbol">|</span> <a href="#resourcelink" class="tsd-signature-type tsd-kind-interface">ResourceLink</a><br />  <span class="tsd-signature-symbol">|</span> <a href="#embeddedresource" class="tsd-signature-type tsd-kind-interface">EmbeddedResource</a></div>
</div>

<div class="type">
  ### `EmbeddedResource`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">EmbeddedResource</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#embeddedresource-type">type</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"resource"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#embeddedresource-resource">resource</a><span class="tsd-signature-symbol">:</span> <a href="#textresourcecontents" class="tsd-signature-type tsd-kind-interface">TextResourceContents</a> <span class="tsd-signature-symbol">|</span> <a href="#blobresourcecontents" class="tsd-signature-type tsd-kind-interface">BlobResourceContents</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#embeddedresource-annotations">annotations</a><span class="tsd-signature-symbol">?:</span> <a href="#annotations" class="tsd-signature-type tsd-kind-interface">Annotations</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#embeddedresource-_meta">\_meta</a><span class="tsd-signature-symbol">?:</span> <a href="#metaobject" class="tsd-signature-type tsd-kind-type-alias">MetaObject</a><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><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><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Embedded file resource with annotations<a href="#embeddedresource-example-embedded-file-resource-with-annotations" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="embeddedresource-example-embedded-file-resource-with-annotations"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"resource"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"resource"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"uri"</span><span class="hl-0">: </span><span class="hl-2">"file:///project/src/main.rs"</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"mimeType"</span><span class="hl-0">: </span><span class="hl-2">"text/x-rust"</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"text"</span><span class="hl-0">: </span><span class="hl-2">"fn main() \{</span><span class="hl-4">\n</span><span class="hl-2">    println!(</span><span class="hl-4">\\"</span><span class="hl-2">Hello world!</span><span class="hl-4">\\"</span><span class="hl-2">);</span><span class="hl-4">\n</span><span class="hl-2">}"</span><br /><span class="hl-0">  },</span><br /><span class="hl-0">  </span><span class="hl-1">"annotations"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"audience"</span><span class="hl-0">: \[</span><span class="hl-2">"user"</span><span class="hl-0">, </span><span class="hl-2">"assistant"</span><span class="hl-0">],</span><br /><span class="hl-0">    </span><span class="hl-1">"priority"</span><span class="hl-0">: </span><span class="hl-3">0.7</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"lastModified"</span><span class="hl-0">: </span><span class="hl-2">"2025-05-03T14:30:00Z"</span><br /><span class="hl-0">  }</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="embeddedresource-type" data-typedoc-h="3"><span>type: "resource"</span><a href="#embeddedresource-type" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="embeddedresource-resource" data-typedoc-h="3"><span>resource: TextResourceContents | BlobResourceContents</span><a href="#embeddedresource-resource" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="embeddedresource-annotations" data-typedoc-h="3"><span>annotations?: Annotations</span><a href="#embeddedresource-annotations" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Optional annotations for the client.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="embeddedresource-_meta" data-typedoc-h="3"><span>\_meta?: MetaObject</span><a href="#embeddedresource-_meta" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section>
</div>

<div class="type">
  ### `ImageContent`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ImageContent</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#imagecontent-type">type</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"image"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#imagecontent-data">data</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#imagecontent-mimetype">mimeType</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#imagecontent-annotations">annotations</a><span class="tsd-signature-symbol">?:</span> <a href="#annotations" class="tsd-signature-type tsd-kind-interface">Annotations</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#imagecontent-_meta">\_meta</a><span class="tsd-signature-symbol">?:</span> <a href="#metaobject" class="tsd-signature-type tsd-kind-type-alias">MetaObject</a><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>An image provided to or from an LLM.</p> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: \`image/png\` content with annotations<a href="#imagecontent-example-imagepng-content-with-annotations" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="imagecontent-example-imagepng-content-with-annotations"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"image"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"data"</span><span class="hl-0">: </span><span class="hl-2">"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg=="</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"mimeType"</span><span class="hl-0">: </span><span class="hl-2">"image/png"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"annotations"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"audience"</span><span class="hl-0">: \[</span><span class="hl-2">"user"</span><span class="hl-0">],</span><br /><span class="hl-0">    </span><span class="hl-1">"priority"</span><span class="hl-0">: </span><span class="hl-3">0.9</span><br /><span class="hl-0">  }</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="imagecontent-type" data-typedoc-h="3"><span>type: "image"</span><a href="#imagecontent-type" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="imagecontent-data" data-typedoc-h="3"><span>data: string</span><a href="#imagecontent-data" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>The base64-encoded image data.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="imagecontent-mimetype" data-typedoc-h="3"><span>mimeType: string</span><a href="#imagecontent-mimetype" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>The MIME type of the image. Different providers may support different image types.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="imagecontent-annotations" data-typedoc-h="3"><span>annotations?: Annotations</span><a href="#imagecontent-annotations" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Optional annotations for the client.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="imagecontent-_meta" data-typedoc-h="3"><span>\_meta?: MetaObject</span><a href="#imagecontent-_meta" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section>
</div>

<div class="type">
  ### `ResourceLink`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ResourceLink</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#resourcelink-icons">icons</a><span class="tsd-signature-symbol">?:</span> <a href="#icon" class="tsd-signature-type tsd-kind-interface">Icon</a><span class="tsd-signature-symbol">\[]</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#resourcelink-name">name</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#resourcelink-title">title</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#resourcelink-uri">uri</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#resourcelink-description">description</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#resourcelink-mimetype">mimeType</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#resourcelink-annotations">annotations</a><span class="tsd-signature-symbol">?:</span> <a href="#annotations" class="tsd-signature-type tsd-kind-interface">Annotations</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#resourcelink-size">size</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#resourcelink-_meta">\_meta</a><span class="tsd-signature-symbol">?:</span> <a href="#metaobject" class="tsd-signature-type tsd-kind-type-alias">MetaObject</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#resourcelink-type">type</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"resource\_link"</span><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><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 <a href="#listresourcesrequest" class="tsd-kind-interface">resources/list</a> requests.</p> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: File resource link<a href="#resourcelink-example-file-resource-link" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="resourcelink-example-file-resource-link"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"resource\_link"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"uri"</span><span class="hl-0">: </span><span class="hl-2">"file:///project/src/main.rs"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"name"</span><span class="hl-0">: </span><span class="hl-2">"main.rs"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"description"</span><span class="hl-0">: </span><span class="hl-2">"Primary application entry point"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"mimeType"</span><span class="hl-0">: </span><span class="hl-2">"text/x-rust"</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="resourcelink-icons" data-typedoc-h="3"><span>icons?: Icon\[]</span><a href="#resourcelink-icons" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><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 class="tsd-sources"><p>Inherited from <a href="#resource">Resource</a>.<a href="#resource-icons">icons</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="resourcelink-name" data-typedoc-h="3"><span>name: string</span><a href="#resourcelink-name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><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 class="tsd-sources"><p>Inherited from <a href="#resource">Resource</a>.<a href="#resource-name">name</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="resourcelink-title" data-typedoc-h="3"><span>title?: string</span><a href="#resourcelink-title" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><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 <a href="#tool" class="tsd-kind-interface">Tool</a>,
  where <code>annotations.title</code> should be given precedence over using <code>name</code>,
  if present).</p> </div><aside class="tsd-sources"><p>Inherited from <a href="#resource">Resource</a>.<a href="#resource-title">title</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="resourcelink-uri" data-typedoc-h="3"><span>uri: string</span><a href="#resourcelink-uri" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>The URI of this resource.</p> </div><aside class="tsd-sources"><p>Inherited from <a href="#resource">Resource</a>.<a href="#resource-uri">uri</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="resourcelink-description" data-typedoc-h="3"><span>description?: string</span><a href="#resourcelink-description" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><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 class="tsd-sources"><p>Inherited from <a href="#resource">Resource</a>.<a href="#resource-description">description</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="resourcelink-mimetype" data-typedoc-h="3"><span>mimeType?: string</span><a href="#resourcelink-mimetype" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>The MIME type of this resource, if known.</p> </div><aside class="tsd-sources"><p>Inherited from <a href="#resource">Resource</a>.<a href="#resource-mimetype">mimeType</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="resourcelink-annotations" data-typedoc-h="3"><span>annotations?: Annotations</span><a href="#resourcelink-annotations" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Optional annotations for the client.</p> </div><aside class="tsd-sources"><p>Inherited from <a href="#resource">Resource</a>.<a href="#resource-annotations">annotations</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="resourcelink-size" data-typedoc-h="3"><span>size?: number</span><a href="#resourcelink-size" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><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 class="tsd-sources"><p>Inherited from <a href="#resource">Resource</a>.<a href="#resource-size">size</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="resourcelink-_meta" data-typedoc-h="3"><span>\_meta?: MetaObject</span><a href="#resourcelink-_meta" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#resource">Resource</a>.<a href="#resource-_meta">\_meta</a></p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="resourcelink-type" data-typedoc-h="3"><span>type: "resource\_link"</span><a href="#resourcelink-type" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section>
</div>

<div class="type">
  ### `TextContent`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">TextContent</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#textcontent-type">type</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"text"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#textcontent-text">text</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#textcontent-annotations">annotations</a><span class="tsd-signature-symbol">?:</span> <a href="#annotations" class="tsd-signature-type tsd-kind-interface">Annotations</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#textcontent-_meta">\_meta</a><span class="tsd-signature-symbol">?:</span> <a href="#metaobject" class="tsd-signature-type tsd-kind-type-alias">MetaObject</a><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Text provided to or from an LLM.</p> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Text content<a href="#textcontent-example-text-content" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="textcontent-example-text-content"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"text"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"text"</span><span class="hl-0">: </span><span class="hl-2">"Tool result text"</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="textcontent-type" data-typedoc-h="3"><span>type: "text"</span><a href="#textcontent-type" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="textcontent-text" data-typedoc-h="3"><span>text: string</span><a href="#textcontent-text" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>The text content of the message.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="textcontent-annotations" data-typedoc-h="3"><span>annotations?: Annotations</span><a href="#textcontent-annotations" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Optional annotations for the client.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="textcontent-_meta" data-typedoc-h="3"><span>\_meta?: MetaObject</span><a href="#textcontent-_meta" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section>
</div>

<div class="type">
  ### `TextResourceContents`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">TextResourceContents</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#textresourcecontents-uri">uri</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#textresourcecontents-mimetype">mimeType</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#textresourcecontents-_meta">\_meta</a><span class="tsd-signature-symbol">?:</span> <a href="#metaobject" class="tsd-signature-type tsd-kind-type-alias">MetaObject</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#textresourcecontents-text">text</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Text file contents<a href="#textresourcecontents-example-text-file-contents" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="textresourcecontents-example-text-file-contents"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"uri"</span><span class="hl-0">: </span><span class="hl-2">"file:///example.txt"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"mimeType"</span><span class="hl-0">: </span><span class="hl-2">"text/plain"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"text"</span><span class="hl-0">: </span><span class="hl-2">"Resource content"</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="textresourcecontents-uri" data-typedoc-h="3"><span>uri: string</span><a href="#textresourcecontents-uri" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>The URI of this resource.</p> </div><aside class="tsd-sources"><p>Inherited from ResourceContents.uri</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="textresourcecontents-mimetype" data-typedoc-h="3"><span>mimeType?: string</span><a href="#textresourcecontents-mimetype" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>The MIME type of this resource, if known.</p> </div><aside class="tsd-sources"><p>Inherited from ResourceContents.mimeType</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="textresourcecontents-_meta" data-typedoc-h="3"><span>\_meta?: MetaObject</span><a href="#textresourcecontents-_meta" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from ResourceContents.\_meta</p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="textresourcecontents-text" data-typedoc-h="3"><span>text: string</span><a href="#textresourcecontents-text" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><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 class="type">
  ### `CompleteRequest`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">CompleteRequest</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#completerequest-jsonrpc">jsonrpc</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"2.0"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#completerequest-id">id</a><span class="tsd-signature-symbol">:</span> <a href="#requestid" class="tsd-signature-type tsd-kind-type-alias">RequestId</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#completerequest-method">method</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"completion/complete"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#completerequest-params">params</a><span class="tsd-signature-symbol">:</span> <a href="#completerequestparams" class="tsd-signature-type tsd-kind-interface">CompleteRequestParams</a><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>A request from the client to the server, to ask for completion options.</p> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Completion request<a href="#completerequest-example-completion-request" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="completerequest-example-completion-request"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"jsonrpc"</span><span class="hl-0">: </span><span class="hl-2">"2.0"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"id"</span><span class="hl-0">: </span><span class="hl-2">"completion-example"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"method"</span><span class="hl-0">: </span><span class="hl-2">"completion/complete"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"params"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"\_meta"</span><span class="hl-0">: \{</span><br /><span class="hl-0">      </span><span class="hl-1">"io.modelcontextprotocol/protocolVersion"</span><span class="hl-0">: </span><span class="hl-2">"2026-07-28"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"io.modelcontextprotocol/clientInfo"</span><span class="hl-0">: \{</span><br /><span class="hl-0">        </span><span class="hl-1">"name"</span><span class="hl-0">: </span><span class="hl-2">"ExampleClient"</span><span class="hl-0">,</span><br /><span class="hl-0">        </span><span class="hl-1">"version"</span><span class="hl-0">: </span><span class="hl-2">"1.0.0"</span><br /><span class="hl-0">      },</span><br /><span class="hl-0">      </span><span class="hl-1">"io.modelcontextprotocol/clientCapabilities"</span><span class="hl-0">: \{}</span><br /><span class="hl-0">    },</span><br /><span class="hl-0">    </span><span class="hl-1">"ref"</span><span class="hl-0">: \{</span><br /><span class="hl-0">      </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"ref/prompt"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"name"</span><span class="hl-0">: </span><span class="hl-2">"code\_review"</span><br /><span class="hl-0">    },</span><br /><span class="hl-0">    </span><span class="hl-1">"argument"</span><span class="hl-0">: \{</span><br /><span class="hl-0">      </span><span class="hl-1">"name"</span><span class="hl-0">: </span><span class="hl-2">"language"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"value"</span><span class="hl-0">: </span><span class="hl-2">"py"</span><br /><span class="hl-0">    }</span><br /><span class="hl-0">  }</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="completerequest-jsonrpc" data-typedoc-h="3"><span>jsonrpc: "2.0"</span><a href="#completerequest-jsonrpc" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-jsonrpc">jsonrpc</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="completerequest-id" data-typedoc-h="3"><span>id: RequestId</span><a href="#completerequest-id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-id">id</a></p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="completerequest-method" data-typedoc-h="3"><span>method: "completion/complete"</span><a href="#completerequest-method" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Overrides <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-method">method</a></p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="completerequest-params" data-typedoc-h="3"><span>params: CompleteRequestParams</span><a href="#completerequest-params" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Overrides <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-params">params</a></p></aside></section>
</div>

<div class="type">
  ### `CompleteRequestParams`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">CompleteRequestParams</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#completerequestparams-_meta">\_meta</a><span class="tsd-signature-symbol">:</span> <a href="#requestmetaobject" class="tsd-signature-type tsd-kind-interface">RequestMetaObject</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#completerequestparams-ref">ref</a><span class="tsd-signature-symbol">:</span> <a href="#promptreference" class="tsd-signature-type tsd-kind-interface">PromptReference</a> <span class="tsd-signature-symbol">|</span> <a href="#resourcetemplatereference" class="tsd-signature-type tsd-kind-interface">ResourceTemplateReference</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#completerequestparams-argument">argument</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">\{</span> <span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#completerequestparams-context">context</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">\{</span> <span class="tsd-kind-property">arguments</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">\{</span> <span class="tsd-signature-symbol">\[</span><span class="tsd-kind-index-signature">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Parameters for a <code>completion/complete</code> request.</p> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Prompt argument completion<a href="#completerequestparams-example-prompt-argument-completion" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="completerequestparams-example-prompt-argument-completion"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"\_meta"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"io.modelcontextprotocol/protocolVersion"</span><span class="hl-0">: </span><span class="hl-2">"2026-07-28"</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"io.modelcontextprotocol/clientInfo"</span><span class="hl-0">: \{</span><br /><span class="hl-0">      </span><span class="hl-1">"name"</span><span class="hl-0">: </span><span class="hl-2">"ExampleClient"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"version"</span><span class="hl-0">: </span><span class="hl-2">"1.0.0"</span><br /><span class="hl-0">    },</span><br /><span class="hl-0">    </span><span class="hl-1">"io.modelcontextprotocol/clientCapabilities"</span><span class="hl-0">: \{}</span><br /><span class="hl-0">  },</span><br /><span class="hl-0">  </span><span class="hl-1">"ref"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"ref/prompt"</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"name"</span><span class="hl-0">: </span><span class="hl-2">"code\_review"</span><br /><span class="hl-0">  },</span><br /><span class="hl-0">  </span><span class="hl-1">"argument"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"name"</span><span class="hl-0">: </span><span class="hl-2">"language"</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"value"</span><span class="hl-0">: </span><span class="hl-2">"py"</span><br /><span class="hl-0">  }</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Prompt argument completion with context<a href="#completerequestparams-example-prompt-argument-completion-with-context" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="completerequestparams-example-prompt-argument-completion-with-context"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"\_meta"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"io.modelcontextprotocol/protocolVersion"</span><span class="hl-0">: </span><span class="hl-2">"2026-07-28"</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"io.modelcontextprotocol/clientInfo"</span><span class="hl-0">: \{</span><br /><span class="hl-0">      </span><span class="hl-1">"name"</span><span class="hl-0">: </span><span class="hl-2">"ExampleClient"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"version"</span><span class="hl-0">: </span><span class="hl-2">"1.0.0"</span><br /><span class="hl-0">    },</span><br /><span class="hl-0">    </span><span class="hl-1">"io.modelcontextprotocol/clientCapabilities"</span><span class="hl-0">: \{}</span><br /><span class="hl-0">  },</span><br /><span class="hl-0">  </span><span class="hl-1">"ref"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"ref/prompt"</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"name"</span><span class="hl-0">: </span><span class="hl-2">"code\_review"</span><br /><span class="hl-0">  },</span><br /><span class="hl-0">  </span><span class="hl-1">"argument"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"name"</span><span class="hl-0">: </span><span class="hl-2">"framework"</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"value"</span><span class="hl-0">: </span><span class="hl-2">"fla"</span><br /><span class="hl-0">  },</span><br /><span class="hl-0">  </span><span class="hl-1">"context"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"arguments"</span><span class="hl-0">: \{</span><br /><span class="hl-0">      </span><span class="hl-1">"language"</span><span class="hl-0">: </span><span class="hl-2">"python"</span><br /><span class="hl-0">    }</span><br /><span class="hl-0">  }</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="completerequestparams-_meta" data-typedoc-h="3"><span>\_meta: RequestMetaObject</span><a href="#completerequestparams-_meta" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#requestparams">RequestParams</a>.<a href="#requestparams-_meta">\_meta</a></p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="completerequestparams-ref" data-typedoc-h="3"><span>ref: PromptReference | ResourceTemplateReference</span><a href="#completerequestparams-ref" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="completerequestparams-argument" data-typedoc-h="3"><span>argument: \{ name: string; value: string }</span><a href="#completerequestparams-argument" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>The argument's information</p> </div><div class="tsd-type-declaration"><div data-typedoc-h="4">Type Declaration</div><ul class="tsd-parameters"><li class="tsd-parameter"><div data-typedoc-h="5"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The name of the argument</p> </div></li><li class="tsd-parameter"><div data-typedoc-h="5"><span class="tsd-kind-property">value</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The value of the argument to use for completion matching.</p> </div></li></ul></div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="completerequestparams-context" data-typedoc-h="3"><span>context?: \{ arguments?: \{ \[key: string]: string } }</span><a href="#completerequestparams-context" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Additional, optional context for completions</p> </div><div class="tsd-type-declaration"><div data-typedoc-h="4">Type Declaration</div><ul class="tsd-parameters"><li class="tsd-parameter"><div data-typedoc-h="5"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">arguments</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">\{</span> <span class="tsd-signature-symbol">\[</span><span class="tsd-kind-index-signature">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Previously-resolved variables in a URI template or prompt.</p> </div></li></ul></div></section>
</div>

<div class="type">
  ### `CompleteResultResponse`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">CompleteResultResponse</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#completeresultresponse-jsonrpc">jsonrpc</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"2.0"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#completeresultresponse-id">id</a><span class="tsd-signature-symbol">:</span> <a href="#requestid" class="tsd-signature-type tsd-kind-type-alias">RequestId</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#completeresultresponse-result">result</a><span class="tsd-signature-symbol">:</span> <a href="#completeresult" class="tsd-signature-type tsd-kind-interface">CompleteResult</a><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>A successful response from the server for a <a href="#completerequest" class="tsd-kind-interface">completion/complete</a> request.</p> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Completion result response<a href="#completeresultresponse-example-completion-result-response" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="completeresultresponse-example-completion-result-response"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"jsonrpc"</span><span class="hl-0">: </span><span class="hl-2">"2.0"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"id"</span><span class="hl-0">: </span><span class="hl-2">"completion-example"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"result"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"resultType"</span><span class="hl-0">: </span><span class="hl-2">"complete"</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"completion"</span><span class="hl-0">: \{</span><br /><span class="hl-0">      </span><span class="hl-1">"values"</span><span class="hl-0">: \[</span><span class="hl-2">"flask"</span><span class="hl-0">],</span><br /><span class="hl-0">      </span><span class="hl-1">"total"</span><span class="hl-0">: </span><span class="hl-3">1</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"hasMore"</span><span class="hl-0">: </span><span class="hl-5">false</span><br /><span class="hl-0">    }</span><br /><span class="hl-0">  }</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="completeresultresponse-jsonrpc" data-typedoc-h="3"><span>jsonrpc: "2.0"</span><a href="#completeresultresponse-jsonrpc" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#jsonrpcresultresponse">JSONRPCResultResponse</a>.<a href="#jsonrpcresultresponse-jsonrpc">jsonrpc</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="completeresultresponse-id" data-typedoc-h="3"><span>id: RequestId</span><a href="#completeresultresponse-id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#jsonrpcresultresponse">JSONRPCResultResponse</a>.<a href="#jsonrpcresultresponse-id">id</a></p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="completeresultresponse-result" data-typedoc-h="3"><span>result: CompleteResult</span><a href="#completeresultresponse-result" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Overrides <a href="#jsonrpcresultresponse">JSONRPCResultResponse</a>.<a href="#jsonrpcresultresponse-result">result</a></p></aside></section>
</div>

<div class="type">
  ### `CompleteResult`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">CompleteResult</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#completeresult-_meta">\_meta</a><span class="tsd-signature-symbol">?:</span> <a href="#metaobject" class="tsd-signature-type tsd-kind-type-alias">MetaObject</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#completeresult-resulttype">resultType</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#completeresult-completion">completion</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">\{</span> <span class="tsd-kind-property">values</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">\[]</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">total</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">hasMore</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br />  <span class="tsd-signature-symbol">\[</span><span class="tsd-kind-index-signature">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>The result returned by the server for a <a href="#completerequest" class="tsd-kind-interface">completion/complete</a> request.</p> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Single completion value<a href="#completeresult-example-single-completion-value" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="completeresult-example-single-completion-value"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"resultType"</span><span class="hl-0">: </span><span class="hl-2">"complete"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"completion"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"values"</span><span class="hl-0">: \[</span><span class="hl-2">"flask"</span><span class="hl-0">],</span><br /><span class="hl-0">    </span><span class="hl-1">"total"</span><span class="hl-0">: </span><span class="hl-3">1</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"hasMore"</span><span class="hl-0">: </span><span class="hl-5">false</span><br /><span class="hl-0">  }</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Multiple completion values with more available<a href="#completeresult-example-multiple-completion-values-with-more-available" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="completeresult-example-multiple-completion-values-with-more-available"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"resultType"</span><span class="hl-0">: </span><span class="hl-2">"complete"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"completion"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"values"</span><span class="hl-0">: \[</span><span class="hl-2">"python"</span><span class="hl-0">, </span><span class="hl-2">"pytorch"</span><span class="hl-0">, </span><span class="hl-2">"pyside"</span><span class="hl-0">],</span><br /><span class="hl-0">    </span><span class="hl-1">"total"</span><span class="hl-0">: </span><span class="hl-3">10</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"hasMore"</span><span class="hl-0">: </span><span class="hl-5">true</span><br /><span class="hl-0">  }</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="completeresult-_meta" data-typedoc-h="3"><span>\_meta?: MetaObject</span><a href="#completeresult-_meta" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#result">Result</a>.<a href="#result-_meta">\_meta</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="completeresult-resulttype" data-typedoc-h="3"><span>resultType: string</span><a href="#completeresult-resulttype" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Indicates the type of the result, which allows the client to determine
  how to parse the result object.</p> <p>Servers implementing this protocol version MUST include this field.
  For backward compatibility, when a client receives a result from a
  server implementing an earlier protocol version (which does not include <code>resultType</code>), the client MUST treat the absent field as <code>"complete"</code>.</p> </div><aside class="tsd-sources"><p>Inherited from <a href="#result">Result</a>.<a href="#result-resulttype">resultType</a></p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="completeresult-completion" data-typedoc-h="3"><span>completion: \{ values: string\[]; total?: number; hasMore?: boolean }</span><a href="#completeresult-completion" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-type-declaration"><div data-typedoc-h="4">Type Declaration</div><ul class="tsd-parameters"><li class="tsd-parameter"><div data-typedoc-h="5"><span class="tsd-kind-property">values</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">\[]</span></div><div class="tsd-comment tsd-typography"><p>An array of completion values. Must not exceed 100 items.</p> </div></li><li class="tsd-parameter"><div data-typedoc-h="5"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">total</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The total number of completion options available. This can exceed the number of values actually sent in the response.</p> </div></li><li class="tsd-parameter"><div data-typedoc-h="5"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">hasMore</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><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 class="type">
  ### `PromptReference`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">PromptReference</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#promptreference-name">name</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#promptreference-title">title</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#promptreference-type">type</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ref/prompt"</span><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Identifies a prompt.</p> </div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="promptreference-name" data-typedoc-h="3"><span>name: string</span><a href="#promptreference-name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><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 class="tsd-sources"><p>Inherited from BaseMetadata.name</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="promptreference-title" data-typedoc-h="3"><span>title?: string</span><a href="#promptreference-title" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><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 <a href="#tool" class="tsd-kind-interface">Tool</a>,
  where <code>annotations.title</code> should be given precedence over using <code>name</code>,
  if present).</p> </div><aside class="tsd-sources"><p>Inherited from BaseMetadata.title</p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="promptreference-type" data-typedoc-h="3"><span>type: "ref/prompt"</span><a href="#promptreference-type" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section>
</div>

<div class="type">
  ### `ResourceTemplateReference`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ResourceTemplateReference</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#resourcetemplatereference-type">type</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ref/resource"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#resourcetemplatereference-uri">uri</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>A reference to a resource or resource template definition.</p> </div><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="resourcetemplatereference-type" data-typedoc-h="3"><span>type: "ref/resource"</span><a href="#resourcetemplatereference-type" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="resourcetemplatereference-uri" data-typedoc-h="3"><span>uri: string</span><a href="#resourcetemplatereference-uri" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>The URI or URI template of the resource.</p> </div></section>
</div>

## `elicitation/create`

<div class="type">
  ### `ElicitRequest`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ElicitRequest</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#elicitrequest-method">method</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"elicitation/create"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#elicitrequest-params">params</a><span class="tsd-signature-symbol">:</span> <a href="#elicitrequestparams" class="tsd-signature-type tsd-kind-type-alias">ElicitRequestParams</a><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>A request from the server to elicit additional information from the user via the client.</p> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Elicitation request<a href="#elicitrequest-example-elicitation-request" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="elicitrequest-example-elicitation-request"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"method"</span><span class="hl-0">: </span><span class="hl-2">"elicitation/create"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"params"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"mode"</span><span class="hl-0">: </span><span class="hl-2">"form"</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"message"</span><span class="hl-0">: </span><span class="hl-2">"Please provide your GitHub username"</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"requestedSchema"</span><span class="hl-0">: \{</span><br /><span class="hl-0">      </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"object"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"properties"</span><span class="hl-0">: \{</span><br /><span class="hl-0">        </span><span class="hl-1">"name"</span><span class="hl-0">: \{</span><br /><span class="hl-0">          </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"string"</span><span class="hl-0">,</span><br /><span class="hl-0">          </span><span class="hl-1">"title"</span><span class="hl-0">: </span><span class="hl-2">"GitHub Username"</span><span class="hl-0">,</span><br /><span class="hl-0">          </span><span class="hl-1">"description"</span><span class="hl-0">: </span><span class="hl-2">"Your GitHub username"</span><br /><span class="hl-0">        }</span><br /><span class="hl-0">      },</span><br /><span class="hl-0">      </span><span class="hl-1">"required"</span><span class="hl-0">: \[</span><span class="hl-2">"name"</span><span class="hl-0">]</span><br /><span class="hl-0">    }</span><br /><span class="hl-0">  }</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="elicitrequest-method" data-typedoc-h="3"><span>method: "elicitation/create"</span><a href="#elicitrequest-method" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="elicitrequest-params" data-typedoc-h="3"><span>params: ElicitRequestParams</span><a href="#elicitrequest-params" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section>
</div>

<div class="type">
  ### `ElicitRequestParams`

  <div class="tsd-signature"><span class="tsd-kind-type-alias">ElicitRequestParams</span><span class="tsd-signature-symbol">:</span> <a href="#elicitrequestformparams" class="tsd-signature-type tsd-kind-interface">ElicitRequestFormParams</a> <span class="tsd-signature-symbol">|</span> <a href="#elicitrequesturlparams" class="tsd-signature-type tsd-kind-interface">ElicitRequestURLParams</a></div><div class="tsd-comment tsd-typography"><p>The parameters for a request to elicit additional information from the user via the client.</p> </div>
</div>

<div class="type">
  ### `ElicitResult`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ElicitResult</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#elicitresult-action">action</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"accept"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"decline"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"cancel"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#elicitresult-content">content</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">\{</span> <span class="tsd-signature-symbol">\[</span><span class="tsd-kind-index-signature">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">\[]</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>The result returned by the client for an <a href="#elicitrequest" class="tsd-kind-interface">elicitation/create</a> request.</p> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Input single field<a href="#elicitresult-example-input-single-field" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="elicitresult-example-input-single-field"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"action"</span><span class="hl-0">: </span><span class="hl-2">"accept"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"content"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"name"</span><span class="hl-0">: </span><span class="hl-2">"octocat"</span><br /><span class="hl-0">  }</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Input multiple fields<a href="#elicitresult-example-input-multiple-fields" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="elicitresult-example-input-multiple-fields"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"action"</span><span class="hl-0">: </span><span class="hl-2">"accept"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"content"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"name"</span><span class="hl-0">: </span><span class="hl-2">"Monalisa Octocat"</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"email"</span><span class="hl-0">: </span><span class="hl-2">"[octocat@github.com](mailto:octocat@github.com)"</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"age"</span><span class="hl-0">: </span><span class="hl-3">30</span><br /><span class="hl-0">  }</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Accept URL mode (no content)<a href="#elicitresult-example-accept-url-mode-no-content" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="elicitresult-example-accept-url-mode-no-content"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"action"</span><span class="hl-0">: </span><span class="hl-2">"accept"</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="elicitresult-action" data-typedoc-h="3"><span>action: "accept" | "decline" | "cancel"</span><a href="#elicitresult-action" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>The user action in response to the elicitation.</p> <ul> <li><code>"accept"</code>: User submitted the form/confirmed the action</li> <li><code>"decline"</code>: User explicitly declined the action</li> <li><code>"cancel"</code>: User dismissed without making an explicit choice</li> </ul> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="elicitresult-content" data-typedoc-h="3"><span>content?: \{ \[key: string]: string | number | boolean | string\[] }</span><a href="#elicitresult-content" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>The submitted form data, only present when action is <code>"accept"</code> and mode was <code>"form"</code>.
  Contains values matching the requested schema.
  Omitted for out-of-band mode responses.</p> </div></section>
</div>

<div class="type">
  ### `BooleanSchema`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">BooleanSchema</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#booleanschema-type">type</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"boolean"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#booleanschema-title">title</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#booleanschema-description">description</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#booleanschema-default">default</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Boolean input schema<a href="#booleanschema-example-boolean-input-schema" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="booleanschema-example-boolean-input-schema"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"boolean"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"title"</span><span class="hl-0">: </span><span class="hl-2">"Display Name"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"description"</span><span class="hl-0">: </span><span class="hl-2">"Description text"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"default"</span><span class="hl-0">: </span><span class="hl-5">false</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="booleanschema-type" data-typedoc-h="3"><span>type: "boolean"</span><a href="#booleanschema-type" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="booleanschema-title" data-typedoc-h="3"><span>title?: string</span><a href="#booleanschema-title" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="booleanschema-description" data-typedoc-h="3"><span>description?: string</span><a href="#booleanschema-description" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="booleanschema-default" data-typedoc-h="3"><span>default?: boolean</span><a href="#booleanschema-default" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section>
</div>

<div class="type">
  ### `ElicitRequestFormParams`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ElicitRequestFormParams</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#elicitrequestformparams-mode">mode</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"form"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#elicitrequestformparams-message">message</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#elicitrequestformparams-requestedschema">requestedSchema</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">\{</span><br />    <span class="tsd-kind-property">\$schema</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />    <span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"object"</span><span class="tsd-signature-symbol">;</span><br />    <span class="tsd-kind-property">properties</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">\{</span> <span class="tsd-signature-symbol">\[</span><span class="tsd-kind-index-signature">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <a href="#primitiveschemadefinition" class="tsd-signature-type tsd-kind-type-alias">PrimitiveSchemaDefinition</a> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br />    <span class="tsd-kind-property">required</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">\[]</span><span class="tsd-signature-symbol">;</span><br />  <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>The parameters for a request to elicit non-sensitive information from the user via a form in the client.</p> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Elicit single field<a href="#elicitrequestformparams-example-elicit-single-field" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="elicitrequestformparams-example-elicit-single-field"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"mode"</span><span class="hl-0">: </span><span class="hl-2">"form"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"message"</span><span class="hl-0">: </span><span class="hl-2">"Please provide your GitHub username"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"requestedSchema"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"object"</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"properties"</span><span class="hl-0">: \{</span><br /><span class="hl-0">      </span><span class="hl-1">"name"</span><span class="hl-0">: \{</span><br /><span class="hl-0">        </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"string"</span><br /><span class="hl-0">      }</span><br /><span class="hl-0">    },</span><br /><span class="hl-0">    </span><span class="hl-1">"required"</span><span class="hl-0">: \[</span><span class="hl-2">"name"</span><span class="hl-0">]</span><br /><span class="hl-0">  }</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Elicit multiple fields<a href="#elicitrequestformparams-example-elicit-multiple-fields" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="elicitrequestformparams-example-elicit-multiple-fields"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"mode"</span><span class="hl-0">: </span><span class="hl-2">"form"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"message"</span><span class="hl-0">: </span><span class="hl-2">"Please provide your contact information"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"requestedSchema"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"object"</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"properties"</span><span class="hl-0">: \{</span><br /><span class="hl-0">      </span><span class="hl-1">"name"</span><span class="hl-0">: \{</span><br /><span class="hl-0">        </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"string"</span><span class="hl-0">,</span><br /><span class="hl-0">        </span><span class="hl-1">"description"</span><span class="hl-0">: </span><span class="hl-2">"Your full name"</span><br /><span class="hl-0">      },</span><br /><span class="hl-0">      </span><span class="hl-1">"email"</span><span class="hl-0">: \{</span><br /><span class="hl-0">        </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"string"</span><span class="hl-0">,</span><br /><span class="hl-0">        </span><span class="hl-1">"format"</span><span class="hl-0">: </span><span class="hl-2">"email"</span><span class="hl-0">,</span><br /><span class="hl-0">        </span><span class="hl-1">"description"</span><span class="hl-0">: </span><span class="hl-2">"Your email address"</span><br /><span class="hl-0">      },</span><br /><span class="hl-0">      </span><span class="hl-1">"age"</span><span class="hl-0">: \{</span><br /><span class="hl-0">        </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"number"</span><span class="hl-0">,</span><br /><span class="hl-0">        </span><span class="hl-1">"minimum"</span><span class="hl-0">: </span><span class="hl-3">18</span><span class="hl-0">,</span><br /><span class="hl-0">        </span><span class="hl-1">"description"</span><span class="hl-0">: </span><span class="hl-2">"Your age"</span><br /><span class="hl-0">      }</span><br /><span class="hl-0">    },</span><br /><span class="hl-0">    </span><span class="hl-1">"required"</span><span class="hl-0">: \[</span><span class="hl-2">"name"</span><span class="hl-0">, </span><span class="hl-2">"email"</span><span class="hl-0">]</span><br /><span class="hl-0">  }</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="elicitrequestformparams-mode" data-typedoc-h="3"><span>mode?: "form"</span><a href="#elicitrequestformparams-mode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>The elicitation mode.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="elicitrequestformparams-message" data-typedoc-h="3"><span>message: string</span><a href="#elicitrequestformparams-message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>The message to present to the user describing what information is being requested.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="elicitrequestformparams-requestedschema" data-typedoc-h="3"><span>requestedSchema: \{    \$schema?: string;    type: "object";    properties: \{ \[key: string]: PrimitiveSchemaDefinition };    required?: string\[]; }</span><a href="#elicitrequestformparams-requestedschema" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>A restricted subset of JSON Schema.
  Only top-level properties are allowed, without nesting.</p> </div></section>
</div>

<div class="type">
  ### `ElicitRequestURLParams`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ElicitRequestURLParams</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#elicitrequesturlparams-mode">mode</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"url"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#elicitrequesturlparams-message">message</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#elicitrequesturlparams-elicitationid">elicitationId</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#elicitrequesturlparams-url">url</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>The parameters for a request to elicit information from the user via a URL in the client.</p> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Elicit sensitive data<a href="#elicitrequesturlparams-example-elicit-sensitive-data" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="elicitrequesturlparams-example-elicit-sensitive-data"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"mode"</span><span class="hl-0">: </span><span class="hl-2">"url"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"elicitationId"</span><span class="hl-0">: </span><span class="hl-2">"550e8400-e29b-41d4-a716-446655440000"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"url"</span><span class="hl-0">: </span><span class="hl-2">"[https://mcp.example.com/ui/set\&#x5F;api\&#x5F;key](https://mcp.example.com/ui/set\&#x5F;api\&#x5F;key)"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"message"</span><span class="hl-0">: </span><span class="hl-2">"Please provide your API key to continue."</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="elicitrequesturlparams-mode" data-typedoc-h="3"><span>mode: "url"</span><a href="#elicitrequesturlparams-mode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>The elicitation mode.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="elicitrequesturlparams-message" data-typedoc-h="3"><span>message: string</span><a href="#elicitrequesturlparams-message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>The message to present to the user explaining why the interaction is needed.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="elicitrequesturlparams-elicitationid" data-typedoc-h="3"><span>elicitationId: string</span><a href="#elicitrequesturlparams-elicitationid" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><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 class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="elicitrequesturlparams-url" data-typedoc-h="3"><span>url: string</span><a href="#elicitrequesturlparams-url" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>The URL that the user should navigate to.</p> </div></section>
</div>

<div class="type">
  ### `EnumSchema`

  <div class="tsd-signature"><span class="tsd-kind-type-alias">EnumSchema</span><span class="tsd-signature-symbol">:</span><br />  <span class="tsd-signature-symbol">|</span> <a href="#singleselectenumschema" class="tsd-signature-type tsd-kind-type-alias">SingleSelectEnumSchema</a><br />  <span class="tsd-signature-symbol">|</span> <a href="#multiselectenumschema" class="tsd-signature-type tsd-kind-type-alias">MultiSelectEnumSchema</a><br />  <span class="tsd-signature-symbol">|</span> <a href="#legacytitledenumschema" class="tsd-signature-type tsd-kind-interface">LegacyTitledEnumSchema</a></div>
</div>

<div class="type">
  ### `LegacyTitledEnumSchema`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">LegacyTitledEnumSchema</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#legacytitledenumschema-type">type</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"string"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#legacytitledenumschema-title">title</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#legacytitledenumschema-description">description</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#legacytitledenumschema-enum">enum</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">\[]</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#legacytitledenumschema-enumnames">enumNames</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">\[]</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#legacytitledenumschema-default">default</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Use <a href="#titledsingleselectenumschema" class="tsd-kind-interface">TitledSingleSelectEnumSchema</a> instead.
  This interface will be removed in a future version.</p> </div><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="legacytitledenumschema-type" data-typedoc-h="3"><span>type: "string"</span><a href="#legacytitledenumschema-type" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="legacytitledenumschema-title" data-typedoc-h="3"><span>title?: string</span><a href="#legacytitledenumschema-title" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="legacytitledenumschema-description" data-typedoc-h="3"><span>description?: string</span><a href="#legacytitledenumschema-description" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="legacytitledenumschema-enum" data-typedoc-h="3"><span>enum: string\[]</span><a href="#legacytitledenumschema-enum" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="legacytitledenumschema-enumnames" data-typedoc-h="3"><span>enumNames?: string\[]</span><a href="#legacytitledenumschema-enumnames" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>(Legacy) Display names for enum values.
  Non-standard according to JSON schema 2020-12.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="legacytitledenumschema-default" data-typedoc-h="3"><span>default?: string</span><a href="#legacytitledenumschema-default" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section>
</div>

<div class="type">
  ### `MultiSelectEnumSchema`

  <div class="tsd-signature"><span class="tsd-kind-type-alias">MultiSelectEnumSchema</span><span class="tsd-signature-symbol">:</span><br />  <span class="tsd-signature-symbol">|</span> <a href="#untitledmultiselectenumschema" class="tsd-signature-type tsd-kind-interface">UntitledMultiSelectEnumSchema</a><br />  <span class="tsd-signature-symbol">|</span> <a href="#titledmultiselectenumschema" class="tsd-signature-type tsd-kind-interface">TitledMultiSelectEnumSchema</a></div>
</div>

<div class="type">
  ### `NumberSchema`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">NumberSchema</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#numberschema-type">type</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"number"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"integer"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#numberschema-title">title</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#numberschema-description">description</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#numberschema-minimum">minimum</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#numberschema-maximum">maximum</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#numberschema-default">default</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Number input schema<a href="#numberschema-example-number-input-schema" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="numberschema-example-number-input-schema"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"number"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"title"</span><span class="hl-0">: </span><span class="hl-2">"Display Name"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"description"</span><span class="hl-0">: </span><span class="hl-2">"Description text"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"minimum"</span><span class="hl-0">: </span><span class="hl-3">0</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"maximum"</span><span class="hl-0">: </span><span class="hl-3">100</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"default"</span><span class="hl-0">: </span><span class="hl-3">50</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="numberschema-type" data-typedoc-h="3"><span>type: "number" | "integer"</span><a href="#numberschema-type" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="numberschema-title" data-typedoc-h="3"><span>title?: string</span><a href="#numberschema-title" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="numberschema-description" data-typedoc-h="3"><span>description?: string</span><a href="#numberschema-description" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="numberschema-minimum" data-typedoc-h="3"><span>minimum?: number</span><a href="#numberschema-minimum" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="numberschema-maximum" data-typedoc-h="3"><span>maximum?: number</span><a href="#numberschema-maximum" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="numberschema-default" data-typedoc-h="3"><span>default?: number</span><a href="#numberschema-default" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section>
</div>

<div class="type">
  ### `PrimitiveSchemaDefinition`

  <div class="tsd-signature"><span class="tsd-kind-type-alias">PrimitiveSchemaDefinition</span><span class="tsd-signature-symbol">:</span><br />  <span class="tsd-signature-symbol">|</span> <a href="#stringschema" class="tsd-signature-type tsd-kind-interface">StringSchema</a><br />  <span class="tsd-signature-symbol">|</span> <a href="#numberschema" class="tsd-signature-type tsd-kind-interface">NumberSchema</a><br />  <span class="tsd-signature-symbol">|</span> <a href="#booleanschema" class="tsd-signature-type tsd-kind-interface">BooleanSchema</a><br />  <span class="tsd-signature-symbol">|</span> <a href="#enumschema" class="tsd-signature-type tsd-kind-type-alias">EnumSchema</a></div><div class="tsd-comment tsd-typography"><p>Restricted schema definitions that only allow primitive types
  without nested objects or arrays.</p> </div>
</div>

<div class="type">
  ### `SingleSelectEnumSchema`

  <div class="tsd-signature"><span class="tsd-kind-type-alias">SingleSelectEnumSchema</span><span class="tsd-signature-symbol">:</span><br />  <span class="tsd-signature-symbol">|</span> <a href="#untitledsingleselectenumschema" class="tsd-signature-type tsd-kind-interface">UntitledSingleSelectEnumSchema</a><br />  <span class="tsd-signature-symbol">|</span> <a href="#titledsingleselectenumschema" class="tsd-signature-type tsd-kind-interface">TitledSingleSelectEnumSchema</a></div>
</div>

<div class="type">
  ### `StringSchema`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">StringSchema</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#stringschema-type">type</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"string"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#stringschema-title">title</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#stringschema-description">description</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#stringschema-minlength">minLength</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#stringschema-maxlength">maxLength</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#stringschema-format">format</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"uri"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"email"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"date"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"date-time"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#stringschema-default">default</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Email input schema<a href="#stringschema-example-email-input-schema" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="stringschema-example-email-input-schema"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"string"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"title"</span><span class="hl-0">: </span><span class="hl-2">"Display Name"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"description"</span><span class="hl-0">: </span><span class="hl-2">"Description text"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"minLength"</span><span class="hl-0">: </span><span class="hl-3">3</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"maxLength"</span><span class="hl-0">: </span><span class="hl-3">50</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"format"</span><span class="hl-0">: </span><span class="hl-2">"email"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"default"</span><span class="hl-0">: </span><span class="hl-2">"[user@example.com](mailto:user@example.com)"</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="stringschema-type" data-typedoc-h="3"><span>type: "string"</span><a href="#stringschema-type" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="stringschema-title" data-typedoc-h="3"><span>title?: string</span><a href="#stringschema-title" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="stringschema-description" data-typedoc-h="3"><span>description?: string</span><a href="#stringschema-description" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="stringschema-minlength" data-typedoc-h="3"><span>minLength?: number</span><a href="#stringschema-minlength" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="stringschema-maxlength" data-typedoc-h="3"><span>maxLength?: number</span><a href="#stringschema-maxlength" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="stringschema-format" data-typedoc-h="3"><span>format?: "uri" | "email" | "date" | "date-time"</span><a href="#stringschema-format" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="stringschema-default" data-typedoc-h="3"><span>default?: string</span><a href="#stringschema-default" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section>
</div>

<div class="type">
  ### `TitledMultiSelectEnumSchema`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">TitledMultiSelectEnumSchema</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#titledmultiselectenumschema-type">type</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"array"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#titledmultiselectenumschema-title">title</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#titledmultiselectenumschema-description">description</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#titledmultiselectenumschema-minitems">minItems</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#titledmultiselectenumschema-maxitems">maxItems</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#titledmultiselectenumschema-items">items</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">\{</span> <span class="tsd-kind-property">anyOf</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">\{</span> <span class="tsd-kind-property">const</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">title</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">\[]</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#titledmultiselectenumschema-default">default</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">\[]</span><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Schema for multiple-selection enumeration with display titles for each option.</p> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Titled color multi-select schema<a href="#titledmultiselectenumschema-example-titled-color-multi-select-schema" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="titledmultiselectenumschema-example-titled-color-multi-select-schema"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"array"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"title"</span><span class="hl-0">: </span><span class="hl-2">"Color Selection"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"description"</span><span class="hl-0">: </span><span class="hl-2">"Choose your favorite colors"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"minItems"</span><span class="hl-0">: </span><span class="hl-3">1</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"maxItems"</span><span class="hl-0">: </span><span class="hl-3">2</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"items"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"anyOf"</span><span class="hl-0">: \[</span><br /><span class="hl-0">      \{ </span><span class="hl-1">"const"</span><span class="hl-0">: </span><span class="hl-2">"#FF0000"</span><span class="hl-0">, </span><span class="hl-1">"title"</span><span class="hl-0">: </span><span class="hl-2">"Red"</span><span class="hl-0"> },</span><br /><span class="hl-0">      \{ </span><span class="hl-1">"const"</span><span class="hl-0">: </span><span class="hl-2">"#00FF00"</span><span class="hl-0">, </span><span class="hl-1">"title"</span><span class="hl-0">: </span><span class="hl-2">"Green"</span><span class="hl-0"> },</span><br /><span class="hl-0">      \{ </span><span class="hl-1">"const"</span><span class="hl-0">: </span><span class="hl-2">"#0000FF"</span><span class="hl-0">, </span><span class="hl-1">"title"</span><span class="hl-0">: </span><span class="hl-2">"Blue"</span><span class="hl-0"> }</span><br /><span class="hl-0">    ]</span><br /><span class="hl-0">  },</span><br /><span class="hl-0">  </span><span class="hl-1">"default"</span><span class="hl-0">: \[</span><span class="hl-2">"#FF0000"</span><span class="hl-0">, </span><span class="hl-2">"#00FF00"</span><span class="hl-0">]</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="titledmultiselectenumschema-type" data-typedoc-h="3"><span>type: "array"</span><a href="#titledmultiselectenumschema-type" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="titledmultiselectenumschema-title" data-typedoc-h="3"><span>title?: string</span><a href="#titledmultiselectenumschema-title" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Optional title for the enum field.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="titledmultiselectenumschema-description" data-typedoc-h="3"><span>description?: string</span><a href="#titledmultiselectenumschema-description" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Optional description for the enum field.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="titledmultiselectenumschema-minitems" data-typedoc-h="3"><span>minItems?: number</span><a href="#titledmultiselectenumschema-minitems" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Minimum number of items to select.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="titledmultiselectenumschema-maxitems" data-typedoc-h="3"><span>maxItems?: number</span><a href="#titledmultiselectenumschema-maxitems" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Maximum number of items to select.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="titledmultiselectenumschema-items" data-typedoc-h="3"><span>items: \{ anyOf: \{ const: string; title: string }\[] }</span><a href="#titledmultiselectenumschema-items" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Schema for array items with enum options and display labels.</p> </div><div class="tsd-type-declaration"><div data-typedoc-h="4">Type Declaration</div><ul class="tsd-parameters"><li class="tsd-parameter"><div data-typedoc-h="5"><span class="tsd-kind-property">anyOf</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">\{</span> <span class="tsd-kind-property">const</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">title</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">\[]</span></div><div class="tsd-comment tsd-typography"><p>Array of enum options with values and display labels.</p> </div></li></ul></div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="titledmultiselectenumschema-default" data-typedoc-h="3"><span>default?: string\[]</span><a href="#titledmultiselectenumschema-default" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Optional default value.</p> </div></section>
</div>

<div class="type">
  ### `TitledSingleSelectEnumSchema`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">TitledSingleSelectEnumSchema</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#titledsingleselectenumschema-type">type</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"string"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#titledsingleselectenumschema-title">title</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#titledsingleselectenumschema-description">description</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#titledsingleselectenumschema-oneof">oneOf</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">\{</span> <span class="tsd-kind-property">const</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">title</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">\[]</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#titledsingleselectenumschema-default">default</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Schema for single-selection enumeration with display titles for each option.</p> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Titled color select schema<a href="#titledsingleselectenumschema-example-titled-color-select-schema" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="titledsingleselectenumschema-example-titled-color-select-schema"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"string"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"title"</span><span class="hl-0">: </span><span class="hl-2">"Color Selection"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"description"</span><span class="hl-0">: </span><span class="hl-2">"Choose your favorite color"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"oneOf"</span><span class="hl-0">: \[</span><br /><span class="hl-0">    \{ </span><span class="hl-1">"const"</span><span class="hl-0">: </span><span class="hl-2">"#FF0000"</span><span class="hl-0">, </span><span class="hl-1">"title"</span><span class="hl-0">: </span><span class="hl-2">"Red"</span><span class="hl-0"> },</span><br /><span class="hl-0">    \{ </span><span class="hl-1">"const"</span><span class="hl-0">: </span><span class="hl-2">"#00FF00"</span><span class="hl-0">, </span><span class="hl-1">"title"</span><span class="hl-0">: </span><span class="hl-2">"Green"</span><span class="hl-0"> },</span><br /><span class="hl-0">    \{ </span><span class="hl-1">"const"</span><span class="hl-0">: </span><span class="hl-2">"#0000FF"</span><span class="hl-0">, </span><span class="hl-1">"title"</span><span class="hl-0">: </span><span class="hl-2">"Blue"</span><span class="hl-0"> }</span><br /><span class="hl-0">  ],</span><br /><span class="hl-0">  </span><span class="hl-1">"default"</span><span class="hl-0">: </span><span class="hl-2">"#FF0000"</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="titledsingleselectenumschema-type" data-typedoc-h="3"><span>type: "string"</span><a href="#titledsingleselectenumschema-type" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="titledsingleselectenumschema-title" data-typedoc-h="3"><span>title?: string</span><a href="#titledsingleselectenumschema-title" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Optional title for the enum field.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="titledsingleselectenumschema-description" data-typedoc-h="3"><span>description?: string</span><a href="#titledsingleselectenumschema-description" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Optional description for the enum field.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="titledsingleselectenumschema-oneof" data-typedoc-h="3"><span>oneOf: \{ const: string; title: string }\[]</span><a href="#titledsingleselectenumschema-oneof" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Array of enum options with values and display labels.</p> </div><div class="tsd-type-declaration"><div data-typedoc-h="4">Type Declaration</div><ul class="tsd-parameters"><li class="tsd-parameter"><div data-typedoc-h="5"><span class="tsd-kind-property">const</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The enum value.</p> </div></li><li class="tsd-parameter"><div data-typedoc-h="5"><span class="tsd-kind-property">title</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Display label for this option.</p> </div></li></ul></div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="titledsingleselectenumschema-default" data-typedoc-h="3"><span>default?: string</span><a href="#titledsingleselectenumschema-default" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Optional default value.</p> </div></section>
</div>

<div class="type">
  ### `UntitledMultiSelectEnumSchema`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">UntitledMultiSelectEnumSchema</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#untitledmultiselectenumschema-type">type</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"array"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#untitledmultiselectenumschema-title">title</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#untitledmultiselectenumschema-description">description</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#untitledmultiselectenumschema-minitems">minItems</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#untitledmultiselectenumschema-maxitems">maxItems</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#untitledmultiselectenumschema-items">items</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">\{</span> <span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"string"</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">enum</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">\[]</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#untitledmultiselectenumschema-default">default</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">\[]</span><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Schema for multiple-selection enumeration without display titles for options.</p> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Color multi-select schema<a href="#untitledmultiselectenumschema-example-color-multi-select-schema" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="untitledmultiselectenumschema-example-color-multi-select-schema"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"array"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"title"</span><span class="hl-0">: </span><span class="hl-2">"Color Selection"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"description"</span><span class="hl-0">: </span><span class="hl-2">"Choose your favorite colors"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"minItems"</span><span class="hl-0">: </span><span class="hl-3">1</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"maxItems"</span><span class="hl-0">: </span><span class="hl-3">2</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"items"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"string"</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"enum"</span><span class="hl-0">: \[</span><span class="hl-2">"Red"</span><span class="hl-0">, </span><span class="hl-2">"Green"</span><span class="hl-0">, </span><span class="hl-2">"Blue"</span><span class="hl-0">]</span><br /><span class="hl-0">  },</span><br /><span class="hl-0">  </span><span class="hl-1">"default"</span><span class="hl-0">: \[</span><span class="hl-2">"Red"</span><span class="hl-0">, </span><span class="hl-2">"Green"</span><span class="hl-0">]</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="untitledmultiselectenumschema-type" data-typedoc-h="3"><span>type: "array"</span><a href="#untitledmultiselectenumschema-type" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="untitledmultiselectenumschema-title" data-typedoc-h="3"><span>title?: string</span><a href="#untitledmultiselectenumschema-title" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Optional title for the enum field.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="untitledmultiselectenumschema-description" data-typedoc-h="3"><span>description?: string</span><a href="#untitledmultiselectenumschema-description" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Optional description for the enum field.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="untitledmultiselectenumschema-minitems" data-typedoc-h="3"><span>minItems?: number</span><a href="#untitledmultiselectenumschema-minitems" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Minimum number of items to select.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="untitledmultiselectenumschema-maxitems" data-typedoc-h="3"><span>maxItems?: number</span><a href="#untitledmultiselectenumschema-maxitems" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Maximum number of items to select.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="untitledmultiselectenumschema-items" data-typedoc-h="3"><span>items: \{ type: "string"; enum: string\[] }</span><a href="#untitledmultiselectenumschema-items" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Schema for the array items.</p> </div><div class="tsd-type-declaration"><div data-typedoc-h="4">Type Declaration</div><ul class="tsd-parameters"><li class="tsd-parameter"><div data-typedoc-h="5"><span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"string"</span></div></li><li class="tsd-parameter"><div data-typedoc-h="5"><span class="tsd-kind-property">enum</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">\[]</span></div><div class="tsd-comment tsd-typography"><p>Array of enum values to choose from.</p> </div></li></ul></div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="untitledmultiselectenumschema-default" data-typedoc-h="3"><span>default?: string\[]</span><a href="#untitledmultiselectenumschema-default" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Optional default value.</p> </div></section>
</div>

<div class="type">
  ### `UntitledSingleSelectEnumSchema`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">UntitledSingleSelectEnumSchema</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#untitledsingleselectenumschema-type">type</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"string"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#untitledsingleselectenumschema-title">title</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#untitledsingleselectenumschema-description">description</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#untitledsingleselectenumschema-enum">enum</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">\[]</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#untitledsingleselectenumschema-default">default</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Schema for single-selection enumeration without display titles for options.</p> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Color select schema<a href="#untitledsingleselectenumschema-example-color-select-schema" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="untitledsingleselectenumschema-example-color-select-schema"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"string"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"title"</span><span class="hl-0">: </span><span class="hl-2">"Color Selection"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"description"</span><span class="hl-0">: </span><span class="hl-2">"Choose your favorite color"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"enum"</span><span class="hl-0">: \[</span><span class="hl-2">"Red"</span><span class="hl-0">, </span><span class="hl-2">"Green"</span><span class="hl-0">, </span><span class="hl-2">"Blue"</span><span class="hl-0">],</span><br /><span class="hl-0">  </span><span class="hl-1">"default"</span><span class="hl-0">: </span><span class="hl-2">"Red"</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="untitledsingleselectenumschema-type" data-typedoc-h="3"><span>type: "string"</span><a href="#untitledsingleselectenumschema-type" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="untitledsingleselectenumschema-title" data-typedoc-h="3"><span>title?: string</span><a href="#untitledsingleselectenumschema-title" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Optional title for the enum field.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="untitledsingleselectenumschema-description" data-typedoc-h="3"><span>description?: string</span><a href="#untitledsingleselectenumschema-description" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Optional description for the enum field.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="untitledsingleselectenumschema-enum" data-typedoc-h="3"><span>enum: string\[]</span><a href="#untitledsingleselectenumschema-enum" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Array of enum values to choose from.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="untitledsingleselectenumschema-default" data-typedoc-h="3"><span>default?: string</span><a href="#untitledsingleselectenumschema-default" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Optional default value.</p> </div></section>
</div>

## `notifications/cancelled`

<div class="type">
  ### `CancelledNotification`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">CancelledNotification</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#cancellednotification-jsonrpc">jsonrpc</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"2.0"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#cancellednotification-method">method</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"notifications/cancelled"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#cancellednotification-params">params</a><span class="tsd-signature-symbol">:</span> <a href="#cancellednotificationparams" class="tsd-signature-type tsd-kind-interface">CancelledNotificationParams</a><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><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> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: User-requested cancellation<a href="#cancellednotification-example-user-requested-cancellation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="cancellednotification-example-user-requested-cancellation"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"jsonrpc"</span><span class="hl-0">: </span><span class="hl-2">"2.0"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"method"</span><span class="hl-0">: </span><span class="hl-2">"notifications/cancelled"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"params"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"requestId"</span><span class="hl-0">: </span><span class="hl-2">"123"</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"reason"</span><span class="hl-0">: </span><span class="hl-2">"User requested cancellation"</span><br /><span class="hl-0">  }</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="cancellednotification-jsonrpc" data-typedoc-h="3"><span>jsonrpc: "2.0"</span><a href="#cancellednotification-jsonrpc" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#jsonrpcnotification">JSONRPCNotification</a>.<a href="#jsonrpcnotification-jsonrpc">jsonrpc</a></p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="cancellednotification-method" data-typedoc-h="3"><span>method: "notifications/cancelled"</span><a href="#cancellednotification-method" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Overrides <a href="#jsonrpcnotification">JSONRPCNotification</a>.<a href="#jsonrpcnotification-method">method</a></p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="cancellednotification-params" data-typedoc-h="3"><span>params: CancelledNotificationParams</span><a href="#cancellednotification-params" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Overrides <a href="#jsonrpcnotification">JSONRPCNotification</a>.<a href="#jsonrpcnotification-params">params</a></p></aside></section>
</div>

<div class="type">
  ### `CancelledNotificationParams`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">CancelledNotificationParams</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#cancellednotificationparams-_meta">\_meta</a><span class="tsd-signature-symbol">?:</span> <a href="#metaobject" class="tsd-signature-type tsd-kind-type-alias">MetaObject</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#cancellednotificationparams-requestid">requestId</a><span class="tsd-signature-symbol">?:</span> <a href="#requestid" class="tsd-signature-type tsd-kind-type-alias">RequestId</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#cancellednotificationparams-reason">reason</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Parameters for a <code>notifications/cancelled</code> notification.</p> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: User-requested cancellation<a href="#cancellednotificationparams-example-user-requested-cancellation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="cancellednotificationparams-example-user-requested-cancellation"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"requestId"</span><span class="hl-0">: </span><span class="hl-2">"123"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"reason"</span><span class="hl-0">: </span><span class="hl-2">"User requested cancellation"</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="cancellednotificationparams-_meta" data-typedoc-h="3"><span>\_meta?: MetaObject</span><a href="#cancellednotificationparams-_meta" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#notificationparams">NotificationParams</a>.<a href="#notificationparams-_meta">\_meta</a></p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="cancellednotificationparams-requestid" data-typedoc-h="3"><span>requestId?: RequestId</span><a href="#cancellednotificationparams-requestid" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><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.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="cancellednotificationparams-reason" data-typedoc-h="3"><span>reason?: string</span><a href="#cancellednotificationparams-reason" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>An optional string describing the reason for the cancellation. This MAY be logged or presented to the user.</p> </div></section>
</div>

## `notifications/message`

<div class="type">
  ### `LoggingMessageNotification`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">LoggingMessageNotification</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#loggingmessagenotification-jsonrpc">jsonrpc</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"2.0"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#loggingmessagenotification-method">method</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"notifications/message"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#loggingmessagenotification-params">params</a><span class="tsd-signature-symbol">:</span> <a href="#loggingmessagenotificationparams" class="tsd-signature-type tsd-kind-interface">LoggingMessageNotificationParams</a><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>JSONRPCNotification of a log message passed from server to client. The client opts in by setting <code>"io.modelcontextprotocol/logLevel"</code> in a request's <code>\_meta</code>.</p> </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><div class="tsd-anchor-link" data-typedoc-h="4">Deprecated</div><p>Deprecated as of protocol version 2026-07-28 (SEP-2577).
  Remains in the specification for at least twelve months; see the
  deprecated features registry.</p> </div><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Log database connection failed<a href="#loggingmessagenotification-example-log-database-connection-failed" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="loggingmessagenotification-example-log-database-connection-failed"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"jsonrpc"</span><span class="hl-0">: </span><span class="hl-2">"2.0"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"method"</span><span class="hl-0">: </span><span class="hl-2">"notifications/message"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"params"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"level"</span><span class="hl-0">: </span><span class="hl-2">"error"</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"logger"</span><span class="hl-0">: </span><span class="hl-2">"database"</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"data"</span><span class="hl-0">: \{</span><br /><span class="hl-0">      </span><span class="hl-1">"error"</span><span class="hl-0">: </span><span class="hl-2">"Connection failed"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"details"</span><span class="hl-0">: \{</span><br /><span class="hl-0">        </span><span class="hl-1">"host"</span><span class="hl-0">: </span><span class="hl-2">"localhost"</span><span class="hl-0">,</span><br /><span class="hl-0">        </span><span class="hl-1">"port"</span><span class="hl-0">: </span><span class="hl-3">5432</span><br /><span class="hl-0">      }</span><br /><span class="hl-0">    }</span><br /><span class="hl-0">  }</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="loggingmessagenotification-jsonrpc" data-typedoc-h="3"><span class="deprecated">jsonrpc: "2.0"</span><a href="#loggingmessagenotification-jsonrpc" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#jsonrpcnotification">JSONRPCNotification</a>.<a href="#jsonrpcnotification-jsonrpc">jsonrpc</a></p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="loggingmessagenotification-method" data-typedoc-h="3"><span class="deprecated">method: "notifications/message"</span><a href="#loggingmessagenotification-method" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Overrides <a href="#jsonrpcnotification">JSONRPCNotification</a>.<a href="#jsonrpcnotification-method">method</a></p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="loggingmessagenotification-params" data-typedoc-h="3"><span class="deprecated">params: LoggingMessageNotificationParams</span><a href="#loggingmessagenotification-params" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Overrides <a href="#jsonrpcnotification">JSONRPCNotification</a>.<a href="#jsonrpcnotification-params">params</a></p></aside></section>
</div>

<div class="type">
  ### `LoggingMessageNotificationParams`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">LoggingMessageNotificationParams</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#loggingmessagenotificationparams-_meta">\_meta</a><span class="tsd-signature-symbol">?:</span> <a href="#metaobject" class="tsd-signature-type tsd-kind-type-alias">MetaObject</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#loggingmessagenotificationparams-level">level</a><span class="tsd-signature-symbol">:</span> <a href="#logginglevel" class="tsd-signature-type tsd-kind-type-alias">LoggingLevel</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#loggingmessagenotificationparams-logger">logger</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#loggingmessagenotificationparams-data">data</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Parameters for a <code>notifications/message</code> notification.</p> </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><div class="tsd-anchor-link" data-typedoc-h="4">Deprecated</div><p>Deprecated as of protocol version 2026-07-28 (SEP-2577).
  Remains in the specification for at least twelve months; see the
  deprecated features registry.</p> </div><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Log database connection failed<a href="#loggingmessagenotificationparams-example-log-database-connection-failed" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="loggingmessagenotificationparams-example-log-database-connection-failed"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"level"</span><span class="hl-0">: </span><span class="hl-2">"error"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"logger"</span><span class="hl-0">: </span><span class="hl-2">"database"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"data"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"error"</span><span class="hl-0">: </span><span class="hl-2">"Connection failed"</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"details"</span><span class="hl-0">: \{</span><br /><span class="hl-0">      </span><span class="hl-1">"host"</span><span class="hl-0">: </span><span class="hl-2">"localhost"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"port"</span><span class="hl-0">: </span><span class="hl-3">5432</span><br /><span class="hl-0">    }</span><br /><span class="hl-0">  }</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="loggingmessagenotificationparams-_meta" data-typedoc-h="3"><span class="deprecated">\_meta?: MetaObject</span><a href="#loggingmessagenotificationparams-_meta" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#notificationparams">NotificationParams</a>.<a href="#notificationparams-_meta">\_meta</a></p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="loggingmessagenotificationparams-level" data-typedoc-h="3"><span class="deprecated">level: LoggingLevel</span><a href="#loggingmessagenotificationparams-level" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>The severity of this log message.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="loggingmessagenotificationparams-logger" data-typedoc-h="3"><span class="deprecated">logger?: string</span><a href="#loggingmessagenotificationparams-logger" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>An optional name of the logger issuing this message.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="loggingmessagenotificationparams-data" data-typedoc-h="3"><span class="deprecated">data: unknown</span><a href="#loggingmessagenotificationparams-data" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><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 class="type">
  ### `ProgressNotification`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ProgressNotification</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#progressnotification-jsonrpc">jsonrpc</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"2.0"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#progressnotification-method">method</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"notifications/progress"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#progressnotification-params">params</a><span class="tsd-signature-symbol">:</span> <a href="#progressnotificationparams" class="tsd-signature-type tsd-kind-interface">ProgressNotificationParams</a><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>An out-of-band notification used to inform the receiver of a progress update for a long-running request.</p> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Progress message<a href="#progressnotification-example-progress-message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="progressnotification-example-progress-message"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"jsonrpc"</span><span class="hl-0">: </span><span class="hl-2">"2.0"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"method"</span><span class="hl-0">: </span><span class="hl-2">"notifications/progress"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"params"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"progressToken"</span><span class="hl-0">: </span><span class="hl-2">"oivaizmir"</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"progress"</span><span class="hl-0">: </span><span class="hl-3">50</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"total"</span><span class="hl-0">: </span><span class="hl-3">100</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"message"</span><span class="hl-0">: </span><span class="hl-2">"Reticulating splines..."</span><br /><span class="hl-0">  }</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="progressnotification-jsonrpc" data-typedoc-h="3"><span>jsonrpc: "2.0"</span><a href="#progressnotification-jsonrpc" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#jsonrpcnotification">JSONRPCNotification</a>.<a href="#jsonrpcnotification-jsonrpc">jsonrpc</a></p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="progressnotification-method" data-typedoc-h="3"><span>method: "notifications/progress"</span><a href="#progressnotification-method" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Overrides <a href="#jsonrpcnotification">JSONRPCNotification</a>.<a href="#jsonrpcnotification-method">method</a></p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="progressnotification-params" data-typedoc-h="3"><span>params: ProgressNotificationParams</span><a href="#progressnotification-params" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Overrides <a href="#jsonrpcnotification">JSONRPCNotification</a>.<a href="#jsonrpcnotification-params">params</a></p></aside></section>
</div>

<div class="type">
  ### `ProgressNotificationParams`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ProgressNotificationParams</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#progressnotificationparams-_meta">\_meta</a><span class="tsd-signature-symbol">?:</span> <a href="#metaobject" class="tsd-signature-type tsd-kind-type-alias">MetaObject</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#progressnotificationparams-progresstoken">progressToken</a><span class="tsd-signature-symbol">:</span> <a href="#progresstoken" class="tsd-signature-type tsd-kind-type-alias">ProgressToken</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#progressnotificationparams-progress">progress</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#progressnotificationparams-total">total</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#progressnotificationparams-message">message</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Parameters for a <a href="#progressnotification" class="tsd-kind-interface">notifications/progress</a> notification.</p> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Progress message<a href="#progressnotificationparams-example-progress-message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="progressnotificationparams-example-progress-message"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"progressToken"</span><span class="hl-0">: </span><span class="hl-2">"oivaizmir"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"progress"</span><span class="hl-0">: </span><span class="hl-3">50</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"total"</span><span class="hl-0">: </span><span class="hl-3">100</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"message"</span><span class="hl-0">: </span><span class="hl-2">"Reticulating splines..."</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="progressnotificationparams-_meta" data-typedoc-h="3"><span>\_meta?: MetaObject</span><a href="#progressnotificationparams-_meta" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#notificationparams">NotificationParams</a>.<a href="#notificationparams-_meta">\_meta</a></p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="progressnotificationparams-progresstoken" data-typedoc-h="3"><span>progressToken: ProgressToken</span><a href="#progressnotificationparams-progresstoken" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><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 class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="progressnotificationparams-progress" data-typedoc-h="3"><span>progress: number</span><a href="#progressnotificationparams-progress" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>The progress thus far. This should increase every time progress is made, even if the total is unknown.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="progressnotificationparams-total" data-typedoc-h="3"><span>total?: number</span><a href="#progressnotificationparams-total" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Total number of items to process (or total progress required), if known.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="progressnotificationparams-message" data-typedoc-h="3"><span>message?: string</span><a href="#progressnotificationparams-message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>An optional message describing the current progress.</p> </div></section>
</div>

## `notifications/prompts/list_changed`

<div class="type">
  ### `PromptListChangedNotification`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">PromptListChangedNotification</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#promptlistchangednotification-jsonrpc">jsonrpc</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"2.0"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#promptlistchangednotification-method">method</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"notifications/prompts/list\_changed"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#promptlistchangednotification-params">params</a><span class="tsd-signature-symbol">?:</span> <a href="#notificationparams" class="tsd-signature-type tsd-kind-interface">NotificationParams</a><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><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><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Prompts list changed<a href="#promptlistchangednotification-example-prompts-list-changed" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="promptlistchangednotification-example-prompts-list-changed"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"jsonrpc"</span><span class="hl-0">: </span><span class="hl-2">"2.0"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"method"</span><span class="hl-0">: </span><span class="hl-2">"notifications/prompts/list\_changed"</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="promptlistchangednotification-jsonrpc" data-typedoc-h="3"><span>jsonrpc: "2.0"</span><a href="#promptlistchangednotification-jsonrpc" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#jsonrpcnotification">JSONRPCNotification</a>.<a href="#jsonrpcnotification-jsonrpc">jsonrpc</a></p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="promptlistchangednotification-method" data-typedoc-h="3"><span>method: "notifications/prompts/list\_changed"</span><a href="#promptlistchangednotification-method" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Overrides <a href="#jsonrpcnotification">JSONRPCNotification</a>.<a href="#jsonrpcnotification-method">method</a></p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="promptlistchangednotification-params" data-typedoc-h="3"><span>params?: NotificationParams</span><a href="#promptlistchangednotification-params" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Overrides <a href="#jsonrpcnotification">JSONRPCNotification</a>.<a href="#jsonrpcnotification-params">params</a></p></aside></section>
</div>

## `notifications/resources/list_changed`

<div class="type">
  ### `ResourceListChangedNotification`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ResourceListChangedNotification</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#resourcelistchangednotification-jsonrpc">jsonrpc</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"2.0"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#resourcelistchangednotification-method">method</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"notifications/resources/list\_changed"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#resourcelistchangednotification-params">params</a><span class="tsd-signature-symbol">?:</span> <a href="#notificationparams" class="tsd-signature-type tsd-kind-interface">NotificationParams</a><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><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><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Resources list changed<a href="#resourcelistchangednotification-example-resources-list-changed" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="resourcelistchangednotification-example-resources-list-changed"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"jsonrpc"</span><span class="hl-0">: </span><span class="hl-2">"2.0"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"method"</span><span class="hl-0">: </span><span class="hl-2">"notifications/resources/list\_changed"</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="resourcelistchangednotification-jsonrpc" data-typedoc-h="3"><span>jsonrpc: "2.0"</span><a href="#resourcelistchangednotification-jsonrpc" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#jsonrpcnotification">JSONRPCNotification</a>.<a href="#jsonrpcnotification-jsonrpc">jsonrpc</a></p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="resourcelistchangednotification-method" data-typedoc-h="3"><span>method: "notifications/resources/list\_changed"</span><a href="#resourcelistchangednotification-method" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Overrides <a href="#jsonrpcnotification">JSONRPCNotification</a>.<a href="#jsonrpcnotification-method">method</a></p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="resourcelistchangednotification-params" data-typedoc-h="3"><span>params?: NotificationParams</span><a href="#resourcelistchangednotification-params" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Overrides <a href="#jsonrpcnotification">JSONRPCNotification</a>.<a href="#jsonrpcnotification-params">params</a></p></aside></section>
</div>

## `notifications/resources/updated`

<div class="type">
  ### `ResourceUpdatedNotification`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ResourceUpdatedNotification</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#resourceupdatednotification-jsonrpc">jsonrpc</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"2.0"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#resourceupdatednotification-method">method</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"notifications/resources/updated"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#resourceupdatednotification-params">params</a><span class="tsd-signature-symbol">:</span> <a href="#resourceupdatednotificationparams" class="tsd-signature-type tsd-kind-interface">ResourceUpdatedNotificationParams</a><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>A notification from the server to the client, informing it that a resource has changed and may need to be read again. This is only sent for resources the client opted in to via the <code>resourceSubscriptions</code> field of a <a href="#subscriptionslistenrequest" class="tsd-kind-interface">subscriptions/listen</a> request.</p> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: File resource updated notification<a href="#resourceupdatednotification-example-file-resource-updated-notification" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="resourceupdatednotification-example-file-resource-updated-notification"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"jsonrpc"</span><span class="hl-0">: </span><span class="hl-2">"2.0"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"method"</span><span class="hl-0">: </span><span class="hl-2">"notifications/resources/updated"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"params"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"uri"</span><span class="hl-0">: </span><span class="hl-2">"file:///project/src/main.rs"</span><br /><span class="hl-0">  }</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="resourceupdatednotification-jsonrpc" data-typedoc-h="3"><span>jsonrpc: "2.0"</span><a href="#resourceupdatednotification-jsonrpc" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#jsonrpcnotification">JSONRPCNotification</a>.<a href="#jsonrpcnotification-jsonrpc">jsonrpc</a></p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="resourceupdatednotification-method" data-typedoc-h="3"><span>method: "notifications/resources/updated"</span><a href="#resourceupdatednotification-method" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Overrides <a href="#jsonrpcnotification">JSONRPCNotification</a>.<a href="#jsonrpcnotification-method">method</a></p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="resourceupdatednotification-params" data-typedoc-h="3"><span>params: ResourceUpdatedNotificationParams</span><a href="#resourceupdatednotification-params" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Overrides <a href="#jsonrpcnotification">JSONRPCNotification</a>.<a href="#jsonrpcnotification-params">params</a></p></aside></section>
</div>

<div class="type">
  ### `ResourceUpdatedNotificationParams`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ResourceUpdatedNotificationParams</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#resourceupdatednotificationparams-_meta">\_meta</a><span class="tsd-signature-symbol">?:</span> <a href="#metaobject" class="tsd-signature-type tsd-kind-type-alias">MetaObject</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#resourceupdatednotificationparams-uri">uri</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Parameters for a <code>notifications/resources/updated</code> notification.</p> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: File resource updated<a href="#resourceupdatednotificationparams-example-file-resource-updated" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="resourceupdatednotificationparams-example-file-resource-updated"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"uri"</span><span class="hl-0">: </span><span class="hl-2">"file:///project/src/main.rs"</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="resourceupdatednotificationparams-_meta" data-typedoc-h="3"><span>\_meta?: MetaObject</span><a href="#resourceupdatednotificationparams-_meta" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#notificationparams">NotificationParams</a>.<a href="#notificationparams-_meta">\_meta</a></p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="resourceupdatednotificationparams-uri" data-typedoc-h="3"><span>uri: string</span><a href="#resourceupdatednotificationparams-uri" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><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/subscriptions/acknowledged`

<div class="type">
  ### `SubscriptionsAcknowledgedNotification`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">SubscriptionsAcknowledgedNotification</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#subscriptionsacknowledgednotification-jsonrpc">jsonrpc</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"2.0"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#subscriptionsacknowledgednotification-method">method</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"notifications/subscriptions/acknowledged"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#subscriptionsacknowledgednotification-params">params</a><span class="tsd-signature-symbol">:</span> <a href="#subscriptionsacknowledgednotificationparams" class="tsd-signature-type tsd-kind-interface">SubscriptionsAcknowledgedNotificationParams</a><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Sent by the server as the first message on a <a href="#subscriptionslistenrequest" class="tsd-kind-interface">subscriptions/listen</a> stream to acknowledge
  that the subscription has been established and to report which notification
  types it agreed to honor.</p> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Listen acknowledged<a href="#subscriptionsacknowledgednotification-example-listen-acknowledged" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="subscriptionsacknowledgednotification-example-listen-acknowledged"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"jsonrpc"</span><span class="hl-0">: </span><span class="hl-2">"2.0"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"method"</span><span class="hl-0">: </span><span class="hl-2">"notifications/subscriptions/acknowledged"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"params"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"\_meta"</span><span class="hl-0">: \{</span><br /><span class="hl-0">      </span><span class="hl-1">"io.modelcontextprotocol/subscriptionId"</span><span class="hl-0">: </span><span class="hl-2">"listen-1"</span><br /><span class="hl-0">    },</span><br /><span class="hl-0">    </span><span class="hl-1">"notifications"</span><span class="hl-0">: \{</span><br /><span class="hl-0">      </span><span class="hl-1">"toolsListChanged"</span><span class="hl-0">: </span><span class="hl-5">true</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"resourceSubscriptions"</span><span class="hl-0">: \[</span><span class="hl-2">"file:///project/config.json"</span><span class="hl-0">]</span><br /><span class="hl-0">    }</span><br /><span class="hl-0">  }</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="subscriptionsacknowledgednotification-jsonrpc" data-typedoc-h="3"><span>jsonrpc: "2.0"</span><a href="#subscriptionsacknowledgednotification-jsonrpc" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#jsonrpcnotification">JSONRPCNotification</a>.<a href="#jsonrpcnotification-jsonrpc">jsonrpc</a></p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="subscriptionsacknowledgednotification-method" data-typedoc-h="3"><span>method: "notifications/subscriptions/acknowledged"</span><a href="#subscriptionsacknowledgednotification-method" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Overrides <a href="#jsonrpcnotification">JSONRPCNotification</a>.<a href="#jsonrpcnotification-method">method</a></p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="subscriptionsacknowledgednotification-params" data-typedoc-h="3"><span>params: SubscriptionsAcknowledgedNotificationParams</span><a href="#subscriptionsacknowledgednotification-params" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Overrides <a href="#jsonrpcnotification">JSONRPCNotification</a>.<a href="#jsonrpcnotification-params">params</a></p></aside></section>
</div>

<div class="type">
  ### `SubscriptionsAcknowledgedNotificationParams`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">SubscriptionsAcknowledgedNotificationParams</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#subscriptionsacknowledgednotificationparams-_meta">\_meta</a><span class="tsd-signature-symbol">?:</span> <a href="#metaobject" class="tsd-signature-type tsd-kind-type-alias">MetaObject</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#subscriptionsacknowledgednotificationparams-notifications">notifications</a><span class="tsd-signature-symbol">:</span> <a href="#subscriptionfilter" class="tsd-signature-type tsd-kind-interface">SubscriptionFilter</a><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Parameters for a <a href="#subscriptionsacknowledgednotification" class="tsd-kind-interface">notifications/subscriptions/acknowledged</a> notification.</p> </div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="subscriptionsacknowledgednotificationparams-_meta" data-typedoc-h="3"><span>\_meta?: MetaObject</span><a href="#subscriptionsacknowledgednotificationparams-_meta" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#notificationparams">NotificationParams</a>.<a href="#notificationparams-_meta">\_meta</a></p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="subscriptionsacknowledgednotificationparams-notifications" data-typedoc-h="3"><span>notifications: SubscriptionFilter</span><a href="#subscriptionsacknowledgednotificationparams-notifications" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>The subset of requested notification types the server agreed to honor.
  Only includes notification types the server actually supports; if the
  client requested an unsupported type (e.g., <code>promptsListChanged</code> when
  the server has no prompts), it is omitted from this set.</p> </div></section>
</div>

## `notifications/tools/list_changed`

<div class="type">
  ### `ToolListChangedNotification`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ToolListChangedNotification</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#toollistchangednotification-jsonrpc">jsonrpc</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"2.0"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#toollistchangednotification-method">method</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"notifications/tools/list\_changed"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#toollistchangednotification-params">params</a><span class="tsd-signature-symbol">?:</span> <a href="#notificationparams" class="tsd-signature-type tsd-kind-interface">NotificationParams</a><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><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><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Tools list changed<a href="#toollistchangednotification-example-tools-list-changed" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="toollistchangednotification-example-tools-list-changed"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"jsonrpc"</span><span class="hl-0">: </span><span class="hl-2">"2.0"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"method"</span><span class="hl-0">: </span><span class="hl-2">"notifications/tools/list\_changed"</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="toollistchangednotification-jsonrpc" data-typedoc-h="3"><span>jsonrpc: "2.0"</span><a href="#toollistchangednotification-jsonrpc" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#jsonrpcnotification">JSONRPCNotification</a>.<a href="#jsonrpcnotification-jsonrpc">jsonrpc</a></p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="toollistchangednotification-method" data-typedoc-h="3"><span>method: "notifications/tools/list\_changed"</span><a href="#toollistchangednotification-method" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Overrides <a href="#jsonrpcnotification">JSONRPCNotification</a>.<a href="#jsonrpcnotification-method">method</a></p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="toollistchangednotification-params" data-typedoc-h="3"><span>params?: NotificationParams</span><a href="#toollistchangednotification-params" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Overrides <a href="#jsonrpcnotification">JSONRPCNotification</a>.<a href="#jsonrpcnotification-params">params</a></p></aside></section>
</div>

## `notifications/elicitation/complete`

<div class="type">
  ### `ElicitationCompleteNotification`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ElicitationCompleteNotification</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#elicitationcompletenotification-jsonrpc">jsonrpc</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"2.0"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#elicitationcompletenotification-method">method</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"notifications/elicitation/complete"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#elicitationcompletenotification-params">params</a><span class="tsd-signature-symbol">:</span> <a href="#elicitationcompletenotificationparams" class="tsd-signature-type tsd-kind-interface">ElicitationCompleteNotificationParams</a><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>An optional notification from the server to the client, informing it of a completion of a out-of-band elicitation request.</p> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Elicitation complete<a href="#elicitationcompletenotification-example-elicitation-complete" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="elicitationcompletenotification-example-elicitation-complete"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"jsonrpc"</span><span class="hl-0">: </span><span class="hl-2">"2.0"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"method"</span><span class="hl-0">: </span><span class="hl-2">"notifications/elicitation/complete"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"params"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"elicitationId"</span><span class="hl-0">: </span><span class="hl-2">"550e8400-e29b-41d4-a716-446655440000"</span><br /><span class="hl-0">  }</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="elicitationcompletenotification-jsonrpc" data-typedoc-h="3"><span>jsonrpc: "2.0"</span><a href="#elicitationcompletenotification-jsonrpc" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#jsonrpcnotification">JSONRPCNotification</a>.<a href="#jsonrpcnotification-jsonrpc">jsonrpc</a></p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="elicitationcompletenotification-method" data-typedoc-h="3"><span>method: "notifications/elicitation/complete"</span><a href="#elicitationcompletenotification-method" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Overrides <a href="#jsonrpcnotification">JSONRPCNotification</a>.<a href="#jsonrpcnotification-method">method</a></p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="elicitationcompletenotification-params" data-typedoc-h="3"><span>params: ElicitationCompleteNotificationParams</span><a href="#elicitationcompletenotification-params" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Overrides <a href="#jsonrpcnotification">JSONRPCNotification</a>.<a href="#jsonrpcnotification-params">params</a></p></aside></section>
</div>

<div class="type">
  ### `ElicitationCompleteNotificationParams`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ElicitationCompleteNotificationParams</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#elicitationcompletenotificationparams-_meta">\_meta</a><span class="tsd-signature-symbol">?:</span> <a href="#metaobject" class="tsd-signature-type tsd-kind-type-alias">MetaObject</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#elicitationcompletenotificationparams-elicitationid">elicitationId</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Parameters for a <a href="#elicitationcompletenotification" class="tsd-kind-interface">notifications/elicitation/complete</a> notification.</p> </div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="elicitationcompletenotificationparams-_meta" data-typedoc-h="3"><span>\_meta?: MetaObject</span><a href="#elicitationcompletenotificationparams-_meta" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#notificationparams">NotificationParams</a>.<a href="#notificationparams-_meta">\_meta</a></p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="elicitationcompletenotificationparams-elicitationid" data-typedoc-h="3"><span>elicitationId: string</span><a href="#elicitationcompletenotificationparams-elicitationid" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>The ID of the elicitation that completed.</p> </div></section>
</div>

## Multi Round-Trip

<div class="type">
  ### `InputRequests`

  <div class="tsd-signature"><span class="tsd-kind-interface">InputRequests</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><div class="tsd-comment tsd-typography"><p>A map of server-initiated requests that the client must fulfill.
  Keys are server-assigned identifiers; values are the request objects.</p> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Elicitation and sampling input requests<a href="#inputrequests-example-elicitation-and-sampling-input-requests" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="inputrequests-example-elicitation-and-sampling-input-requests"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"github\_login"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"method"</span><span class="hl-0">: </span><span class="hl-2">"elicitation/create"</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"params"</span><span class="hl-0">: \{</span><br /><span class="hl-0">      </span><span class="hl-1">"mode"</span><span class="hl-0">: </span><span class="hl-2">"form"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"message"</span><span class="hl-0">: </span><span class="hl-2">"Please provide your GitHub username"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"requestedSchema"</span><span class="hl-0">: \{</span><br /><span class="hl-0">        </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"object"</span><span class="hl-0">,</span><br /><span class="hl-0">        </span><span class="hl-1">"properties"</span><span class="hl-0">: \{</span><br /><span class="hl-0">          </span><span class="hl-1">"name"</span><span class="hl-0">: \{</span><br /><span class="hl-0">            </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"string"</span><br /><span class="hl-0">          }</span><br /><span class="hl-0">        },</span><br /><span class="hl-0">        </span><span class="hl-1">"required"</span><span class="hl-0">: \[</span><span class="hl-2">"name"</span><span class="hl-0">]</span><br /><span class="hl-0">      }</span><br /><span class="hl-0">    }</span><br /><span class="hl-0">  },</span><br /><span class="hl-0">  </span><span class="hl-1">"capital\_of\_france"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"method"</span><span class="hl-0">: </span><span class="hl-2">"sampling/createMessage"</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"params"</span><span class="hl-0">: \{</span><br /><span class="hl-0">      </span><span class="hl-1">"messages"</span><span class="hl-0">: \[</span><br /><span class="hl-0">        \{</span><br /><span class="hl-0">          </span><span class="hl-1">"role"</span><span class="hl-0">: </span><span class="hl-2">"user"</span><span class="hl-0">,</span><br /><span class="hl-0">          </span><span class="hl-1">"content"</span><span class="hl-0">: \{</span><br /><span class="hl-0">            </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"text"</span><span class="hl-0">,</span><br /><span class="hl-0">            </span><span class="hl-1">"text"</span><span class="hl-0">: </span><span class="hl-2">"What is the capital of France?"</span><br /><span class="hl-0">          }</span><br /><span class="hl-0">        }</span><br /><span class="hl-0">      ],</span><br /><span class="hl-0">      </span><span class="hl-1">"maxTokens"</span><span class="hl-0">: </span><span class="hl-3">100</span><br /><span class="hl-0">    }</span><br /><span class="hl-0">  }</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div>
</div>

<div class="type">
  ### `InputRequiredResult`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">InputRequiredResult</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#inputrequiredresult-_meta">\_meta</a><span class="tsd-signature-symbol">?:</span> <a href="#metaobject" class="tsd-signature-type tsd-kind-type-alias">MetaObject</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#inputrequiredresult-resulttype">resultType</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#inputrequiredresult-inputrequests">inputRequests</a><span class="tsd-signature-symbol">?:</span> <a href="#inputrequests" class="tsd-signature-type tsd-kind-interface">InputRequests</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#inputrequiredresult-requeststate">requestState</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <span class="tsd-signature-symbol">\[</span><span class="tsd-kind-index-signature">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>An InputRequiredResult sent by the server to indicate that additional input is needed
  before the request can be completed.</p> <p>At least one of <code>inputRequests</code> or <code>requestState</code> MUST be present.</p> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: InputRequiredResult with elicitation and sampling input requests and request state<a href="#inputrequiredresult-example-inputrequiredresult-with-elicitation-and-sampling-input-requests-and-request-state" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="inputrequiredresult-example-inputrequiredresult-with-elicitation-and-sampling-input-requests-and-request-state"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"resultType"</span><span class="hl-0">: </span><span class="hl-2">"input\_required"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"inputRequests"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"github\_login"</span><span class="hl-0">: \{</span><br /><span class="hl-0">      </span><span class="hl-1">"method"</span><span class="hl-0">: </span><span class="hl-2">"elicitation/create"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"params"</span><span class="hl-0">: \{</span><br /><span class="hl-0">        </span><span class="hl-1">"message"</span><span class="hl-0">: </span><span class="hl-2">"Please provide your GitHub username"</span><span class="hl-0">,</span><br /><span class="hl-0">        </span><span class="hl-1">"requestedSchema"</span><span class="hl-0">: \{</span><br /><span class="hl-0">          </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"object"</span><span class="hl-0">,</span><br /><span class="hl-0">          </span><span class="hl-1">"properties"</span><span class="hl-0">: \{</span><br /><span class="hl-0">            </span><span class="hl-1">"name"</span><span class="hl-0">: \{</span><br /><span class="hl-0">              </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"string"</span><br /><span class="hl-0">            }</span><br /><span class="hl-0">          },</span><br /><span class="hl-0">          </span><span class="hl-1">"required"</span><span class="hl-0">: \[</span><span class="hl-2">"name"</span><span class="hl-0">]</span><br /><span class="hl-0">        }</span><br /><span class="hl-0">      }</span><br /><span class="hl-0">    },</span><br /><span class="hl-0">    </span><span class="hl-1">"capital\_of\_france"</span><span class="hl-0">: \{</span><br /><span class="hl-0">      </span><span class="hl-1">"method"</span><span class="hl-0">: </span><span class="hl-2">"sampling/createMessage"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"params"</span><span class="hl-0">: \{</span><br /><span class="hl-0">        </span><span class="hl-1">"messages"</span><span class="hl-0">: \[</span><br /><span class="hl-0">          \{</span><br /><span class="hl-0">            </span><span class="hl-1">"role"</span><span class="hl-0">: </span><span class="hl-2">"user"</span><span class="hl-0">,</span><br /><span class="hl-0">            </span><span class="hl-1">"content"</span><span class="hl-0">: \{</span><br /><span class="hl-0">              </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"text"</span><span class="hl-0">,</span><br /><span class="hl-0">              </span><span class="hl-1">"text"</span><span class="hl-0">: </span><span class="hl-2">"What is the capital of France?"</span><br /><span class="hl-0">            }</span><br /><span class="hl-0">          }</span><br /><span class="hl-0">        ],</span><br /><span class="hl-0">        </span><span class="hl-1">"maxTokens"</span><span class="hl-0">: </span><span class="hl-3">100</span><br /><span class="hl-0">      }</span><br /><span class="hl-0">    }</span><br /><span class="hl-0">  },</span><br /><span class="hl-0">  </span><span class="hl-1">"requestState"</span><span class="hl-0">: </span><span class="hl-2">"eyJsb2NhdGlvbiI6Ik5ldyBZb3JrIn0"</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: InputRequiredResult with request state only (load shedding)<a href="#inputrequiredresult-example-inputrequiredresult-with-request-state-only-load-shedding" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="inputrequiredresult-example-inputrequiredresult-with-request-state-only-load-shedding"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"resultType"</span><span class="hl-0">: </span><span class="hl-2">"input\_required"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"requestState"</span><span class="hl-0">: </span><span class="hl-2">"eyJwcm9ncmVzcyI6IjUwJSIsInN0YXRlIjoicHJvY2Vzc2luZyJ9"</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="inputrequiredresult-_meta" data-typedoc-h="3"><span>\_meta?: MetaObject</span><a href="#inputrequiredresult-_meta" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#result">Result</a>.<a href="#result-_meta">\_meta</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="inputrequiredresult-resulttype" data-typedoc-h="3"><span>resultType: string</span><a href="#inputrequiredresult-resulttype" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Indicates the type of the result, which allows the client to determine
  how to parse the result object.</p> <p>Servers implementing this protocol version MUST include this field.
  For backward compatibility, when a client receives a result from a
  server implementing an earlier protocol version (which does not include <code>resultType</code>), the client MUST treat the absent field as <code>"complete"</code>.</p> </div><aside class="tsd-sources"><p>Inherited from <a href="#result">Result</a>.<a href="#result-resulttype">resultType</a></p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="inputrequiredresult-inputrequests" data-typedoc-h="3"><span>inputRequests?: InputRequests</span><a href="#inputrequiredresult-inputrequests" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="inputrequiredresult-requeststate" data-typedoc-h="3"><span>requestState?: string</span><a href="#inputrequiredresult-requeststate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section>
</div>

<div class="type">
  ### `InputResponses`

  <div class="tsd-signature"><span class="tsd-kind-interface">InputResponses</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><div class="tsd-comment tsd-typography"><p>A map of client responses to server-initiated requests.
  Keys correspond to the keys in the <a href="#inputrequests" class="tsd-kind-interface">InputRequests</a> map;
  values are the client's result for each request.</p> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Elicitation and sampling input responses<a href="#inputresponses-example-elicitation-and-sampling-input-responses" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="inputresponses-example-elicitation-and-sampling-input-responses"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"github\_login"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"action"</span><span class="hl-0">: </span><span class="hl-2">"accept"</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"content"</span><span class="hl-0">: \{</span><br /><span class="hl-0">      </span><span class="hl-1">"name"</span><span class="hl-0">: </span><span class="hl-2">"octocat"</span><br /><span class="hl-0">    }</span><br /><span class="hl-0">  },</span><br /><span class="hl-0">  </span><span class="hl-1">"capital\_of\_france"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"role"</span><span class="hl-0">: </span><span class="hl-2">"assistant"</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"content"</span><span class="hl-0">: \{</span><br /><span class="hl-0">      </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"text"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"text"</span><span class="hl-0">: </span><span class="hl-2">"The capital of France is Paris."</span><br /><span class="hl-0">    },</span><br /><span class="hl-0">    </span><span class="hl-1">"model"</span><span class="hl-0">: </span><span class="hl-2">"claude-3-sonnet-20240307"</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"stopReason"</span><span class="hl-0">: </span><span class="hl-2">"endTurn"</span><br /><span class="hl-0">  }</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div>
</div>

## `prompts/get`

<div class="type">
  ### `GetPromptRequest`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">GetPromptRequest</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#getpromptrequest-jsonrpc">jsonrpc</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"2.0"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#getpromptrequest-id">id</a><span class="tsd-signature-symbol">:</span> <a href="#requestid" class="tsd-signature-type tsd-kind-type-alias">RequestId</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#getpromptrequest-method">method</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"prompts/get"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#getpromptrequest-params">params</a><span class="tsd-signature-symbol">:</span> <a href="#getpromptrequestparams" class="tsd-signature-type tsd-kind-interface">GetPromptRequestParams</a><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Used by the client to get a prompt provided by the server.</p> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Get prompt request<a href="#getpromptrequest-example-get-prompt-request" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="getpromptrequest-example-get-prompt-request"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"jsonrpc"</span><span class="hl-0">: </span><span class="hl-2">"2.0"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"id"</span><span class="hl-0">: </span><span class="hl-2">"get-prompt-example"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"method"</span><span class="hl-0">: </span><span class="hl-2">"prompts/get"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"params"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"\_meta"</span><span class="hl-0">: \{</span><br /><span class="hl-0">      </span><span class="hl-1">"io.modelcontextprotocol/protocolVersion"</span><span class="hl-0">: </span><span class="hl-2">"2026-07-28"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"io.modelcontextprotocol/clientInfo"</span><span class="hl-0">: \{</span><br /><span class="hl-0">        </span><span class="hl-1">"name"</span><span class="hl-0">: </span><span class="hl-2">"ExampleClient"</span><span class="hl-0">,</span><br /><span class="hl-0">        </span><span class="hl-1">"version"</span><span class="hl-0">: </span><span class="hl-2">"1.0.0"</span><br /><span class="hl-0">      },</span><br /><span class="hl-0">      </span><span class="hl-1">"io.modelcontextprotocol/clientCapabilities"</span><span class="hl-0">: \{}</span><br /><span class="hl-0">    },</span><br /><span class="hl-0">    </span><span class="hl-1">"name"</span><span class="hl-0">: </span><span class="hl-2">"code\_review"</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"arguments"</span><span class="hl-0">: \{</span><br /><span class="hl-0">      </span><span class="hl-1">"code"</span><span class="hl-0">: </span><span class="hl-2">"def hello():</span><span class="hl-4">\n</span><span class="hl-2">    print('world')"</span><br /><span class="hl-0">    }</span><br /><span class="hl-0">  }</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="getpromptrequest-jsonrpc" data-typedoc-h="3"><span>jsonrpc: "2.0"</span><a href="#getpromptrequest-jsonrpc" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-jsonrpc">jsonrpc</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="getpromptrequest-id" data-typedoc-h="3"><span>id: RequestId</span><a href="#getpromptrequest-id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-id">id</a></p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="getpromptrequest-method" data-typedoc-h="3"><span>method: "prompts/get"</span><a href="#getpromptrequest-method" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Overrides <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-method">method</a></p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="getpromptrequest-params" data-typedoc-h="3"><span>params: GetPromptRequestParams</span><a href="#getpromptrequest-params" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Overrides <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-params">params</a></p></aside></section>
</div>

<div class="type">
  ### `GetPromptRequestParams`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">GetPromptRequestParams</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#getpromptrequestparams-_meta">\_meta</a><span class="tsd-signature-symbol">:</span> <a href="#requestmetaobject" class="tsd-signature-type tsd-kind-interface">RequestMetaObject</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#getpromptrequestparams-inputresponses">inputResponses</a><span class="tsd-signature-symbol">?:</span> <a href="#inputresponses" class="tsd-signature-type tsd-kind-interface">InputResponses</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#getpromptrequestparams-requeststate">requestState</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#getpromptrequestparams-name">name</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#getpromptrequestparams-arguments">arguments</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">\{</span> <span class="tsd-signature-symbol">\[</span><span class="tsd-kind-index-signature">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Parameters for a <code>prompts/get</code> request.</p> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Get code review prompt<a href="#getpromptrequestparams-example-get-code-review-prompt" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="getpromptrequestparams-example-get-code-review-prompt"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"\_meta"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"io.modelcontextprotocol/protocolVersion"</span><span class="hl-0">: </span><span class="hl-2">"2026-07-28"</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"io.modelcontextprotocol/clientInfo"</span><span class="hl-0">: \{</span><br /><span class="hl-0">      </span><span class="hl-1">"name"</span><span class="hl-0">: </span><span class="hl-2">"ExampleClient"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"version"</span><span class="hl-0">: </span><span class="hl-2">"1.0.0"</span><br /><span class="hl-0">    },</span><br /><span class="hl-0">    </span><span class="hl-1">"io.modelcontextprotocol/clientCapabilities"</span><span class="hl-0">: \{}</span><br /><span class="hl-0">  },</span><br /><span class="hl-0">  </span><span class="hl-1">"name"</span><span class="hl-0">: </span><span class="hl-2">"code\_review"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"arguments"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"code"</span><span class="hl-0">: </span><span class="hl-2">"def hello():</span><span class="hl-4">\n</span><span class="hl-2">    print('world')"</span><br /><span class="hl-0">  }</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="getpromptrequestparams-_meta" data-typedoc-h="3"><span>\_meta: RequestMetaObject</span><a href="#getpromptrequestparams-_meta" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#inputresponserequestparams">InputResponseRequestParams</a>.<a href="#inputresponserequestparams-_meta">\_meta</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="getpromptrequestparams-inputresponses" data-typedoc-h="3"><span>inputResponses?: InputResponses</span><a href="#getpromptrequestparams-inputresponses" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#inputresponserequestparams">InputResponseRequestParams</a>.<a href="#inputresponserequestparams-inputresponses">inputResponses</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="getpromptrequestparams-requeststate" data-typedoc-h="3"><span>requestState?: string</span><a href="#getpromptrequestparams-requeststate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#inputresponserequestparams">InputResponseRequestParams</a>.<a href="#inputresponserequestparams-requeststate">requestState</a></p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="getpromptrequestparams-name" data-typedoc-h="3"><span>name: string</span><a href="#getpromptrequestparams-name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>The name of the prompt or prompt template.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="getpromptrequestparams-arguments" data-typedoc-h="3"><span>arguments?: \{ \[key: string]: string }</span><a href="#getpromptrequestparams-arguments" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Arguments to use for templating the prompt.</p> </div></section>
</div>

<div class="type">
  ### `GetPromptResultResponse`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">GetPromptResultResponse</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#getpromptresultresponse-jsonrpc">jsonrpc</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"2.0"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#getpromptresultresponse-id">id</a><span class="tsd-signature-symbol">:</span> <a href="#requestid" class="tsd-signature-type tsd-kind-type-alias">RequestId</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#getpromptresultresponse-result">result</a><span class="tsd-signature-symbol">:</span> <a href="#inputrequiredresult" class="tsd-signature-type tsd-kind-interface">InputRequiredResult</a> <span class="tsd-signature-symbol">|</span> <a href="#getpromptresult" class="tsd-signature-type tsd-kind-interface">GetPromptResult</a><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>A successful response from the server for a <a href="#getpromptrequest" class="tsd-kind-interface">prompts/get</a> request.</p> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Get prompt result response<a href="#getpromptresultresponse-example-get-prompt-result-response" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="getpromptresultresponse-example-get-prompt-result-response"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"jsonrpc"</span><span class="hl-0">: </span><span class="hl-2">"2.0"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"id"</span><span class="hl-0">: </span><span class="hl-2">"get-prompt-example"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"result"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"resultType"</span><span class="hl-0">: </span><span class="hl-2">"complete"</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"description"</span><span class="hl-0">: </span><span class="hl-2">"Code review prompt"</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"messages"</span><span class="hl-0">: \[</span><br /><span class="hl-0">      \{</span><br /><span class="hl-0">        </span><span class="hl-1">"role"</span><span class="hl-0">: </span><span class="hl-2">"user"</span><span class="hl-0">,</span><br /><span class="hl-0">        </span><span class="hl-1">"content"</span><span class="hl-0">: \{</span><br /><span class="hl-0">          </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"text"</span><span class="hl-0">,</span><br /><span class="hl-0">          </span><span class="hl-1">"text"</span><span class="hl-0">: </span><span class="hl-2">"Please review this Python code:</span><span class="hl-4">\n</span><span class="hl-2">def hello():</span><span class="hl-4">\n</span><span class="hl-2">    print('world')"</span><br /><span class="hl-0">        }</span><br /><span class="hl-0">      }</span><br /><span class="hl-0">    ]</span><br /><span class="hl-0">  }</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="getpromptresultresponse-jsonrpc" data-typedoc-h="3"><span>jsonrpc: "2.0"</span><a href="#getpromptresultresponse-jsonrpc" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#jsonrpcresultresponse">JSONRPCResultResponse</a>.<a href="#jsonrpcresultresponse-jsonrpc">jsonrpc</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="getpromptresultresponse-id" data-typedoc-h="3"><span>id: RequestId</span><a href="#getpromptresultresponse-id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#jsonrpcresultresponse">JSONRPCResultResponse</a>.<a href="#jsonrpcresultresponse-id">id</a></p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="getpromptresultresponse-result" data-typedoc-h="3"><span>result: InputRequiredResult | GetPromptResult</span><a href="#getpromptresultresponse-result" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Overrides <a href="#jsonrpcresultresponse">JSONRPCResultResponse</a>.<a href="#jsonrpcresultresponse-result">result</a></p></aside></section>
</div>

<div class="type">
  ### `GetPromptResult`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">GetPromptResult</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#getpromptresult-_meta">\_meta</a><span class="tsd-signature-symbol">?:</span> <a href="#metaobject" class="tsd-signature-type tsd-kind-type-alias">MetaObject</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#getpromptresult-resulttype">resultType</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#getpromptresult-description">description</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#getpromptresult-messages">messages</a><span class="tsd-signature-symbol">:</span> <a href="#promptmessage" class="tsd-signature-type tsd-kind-interface">PromptMessage</a><span class="tsd-signature-symbol">\[]</span><span class="tsd-signature-symbol">;</span><br />  <span class="tsd-signature-symbol">\[</span><span class="tsd-kind-index-signature">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>The result returned by the server for a <a href="#getpromptrequest" class="tsd-kind-interface">prompts/get</a> request.</p> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Code review prompt<a href="#getpromptresult-example-code-review-prompt" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="getpromptresult-example-code-review-prompt"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"resultType"</span><span class="hl-0">: </span><span class="hl-2">"complete"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"description"</span><span class="hl-0">: </span><span class="hl-2">"Code review prompt"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"messages"</span><span class="hl-0">: \[</span><br /><span class="hl-0">    \{</span><br /><span class="hl-0">      </span><span class="hl-1">"role"</span><span class="hl-0">: </span><span class="hl-2">"user"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"content"</span><span class="hl-0">: \{</span><br /><span class="hl-0">        </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"text"</span><span class="hl-0">,</span><br /><span class="hl-0">        </span><span class="hl-1">"text"</span><span class="hl-0">: </span><span class="hl-2">"Please review this Python code:</span><span class="hl-4">\n</span><span class="hl-2">def hello():</span><span class="hl-4">\n</span><span class="hl-2">    print('world')"</span><br /><span class="hl-0">      }</span><br /><span class="hl-0">    }</span><br /><span class="hl-0">  ]</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="getpromptresult-_meta" data-typedoc-h="3"><span>\_meta?: MetaObject</span><a href="#getpromptresult-_meta" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#result">Result</a>.<a href="#result-_meta">\_meta</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="getpromptresult-resulttype" data-typedoc-h="3"><span>resultType: string</span><a href="#getpromptresult-resulttype" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Indicates the type of the result, which allows the client to determine
  how to parse the result object.</p> <p>Servers implementing this protocol version MUST include this field.
  For backward compatibility, when a client receives a result from a
  server implementing an earlier protocol version (which does not include <code>resultType</code>), the client MUST treat the absent field as <code>"complete"</code>.</p> </div><aside class="tsd-sources"><p>Inherited from <a href="#result">Result</a>.<a href="#result-resulttype">resultType</a></p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="getpromptresult-description" data-typedoc-h="3"><span>description?: string</span><a href="#getpromptresult-description" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>An optional description for the prompt.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="getpromptresult-messages" data-typedoc-h="3"><span>messages: PromptMessage\[]</span><a href="#getpromptresult-messages" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section>
</div>

<div class="type">
  ### `PromptMessage`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">PromptMessage</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#promptmessage-role">role</a><span class="tsd-signature-symbol">:</span> <a href="#role" class="tsd-signature-type tsd-kind-type-alias">Role</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#promptmessage-content">content</a><span class="tsd-signature-symbol">:</span> <a href="#contentblock" class="tsd-signature-type tsd-kind-type-alias">ContentBlock</a><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Describes a message returned as part of a prompt.</p> <p>This is similar to <a href="#samplingmessage" class="tsd-kind-interface">SamplingMessage</a>, but also supports the embedding of
  resources from the MCP server.</p> </div><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="promptmessage-role" data-typedoc-h="3"><span>role: Role</span><a href="#promptmessage-role" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="promptmessage-content" data-typedoc-h="3"><span>content: ContentBlock</span><a href="#promptmessage-content" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section>
</div>

## `prompts/list`

<div class="type">
  ### `ListPromptsRequest`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ListPromptsRequest</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#listpromptsrequest-jsonrpc">jsonrpc</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"2.0"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#listpromptsrequest-id">id</a><span class="tsd-signature-symbol">:</span> <a href="#requestid" class="tsd-signature-type tsd-kind-type-alias">RequestId</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#listpromptsrequest-params">params</a><span class="tsd-signature-symbol">:</span> <a href="#paginatedrequestparams" class="tsd-signature-type tsd-kind-interface">PaginatedRequestParams</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#listpromptsrequest-method">method</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"prompts/list"</span><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Sent from the client to request a list of prompts and prompt templates the server has.</p> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: List prompts request<a href="#listpromptsrequest-example-list-prompts-request" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="listpromptsrequest-example-list-prompts-request"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"jsonrpc"</span><span class="hl-0">: </span><span class="hl-2">"2.0"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"id"</span><span class="hl-0">: </span><span class="hl-2">"list-prompts-example"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"method"</span><span class="hl-0">: </span><span class="hl-2">"prompts/list"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"params"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"\_meta"</span><span class="hl-0">: \{</span><br /><span class="hl-0">      </span><span class="hl-1">"io.modelcontextprotocol/protocolVersion"</span><span class="hl-0">: </span><span class="hl-2">"2026-07-28"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"io.modelcontextprotocol/clientInfo"</span><span class="hl-0">: \{</span><br /><span class="hl-0">        </span><span class="hl-1">"name"</span><span class="hl-0">: </span><span class="hl-2">"ExampleClient"</span><span class="hl-0">,</span><br /><span class="hl-0">        </span><span class="hl-1">"version"</span><span class="hl-0">: </span><span class="hl-2">"1.0.0"</span><br /><span class="hl-0">      },</span><br /><span class="hl-0">      </span><span class="hl-1">"io.modelcontextprotocol/clientCapabilities"</span><span class="hl-0">: \{}</span><br /><span class="hl-0">    }</span><br /><span class="hl-0">  }</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="listpromptsrequest-jsonrpc" data-typedoc-h="3"><span>jsonrpc: "2.0"</span><a href="#listpromptsrequest-jsonrpc" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from PaginatedRequest.jsonrpc</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="listpromptsrequest-id" data-typedoc-h="3"><span>id: RequestId</span><a href="#listpromptsrequest-id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from PaginatedRequest.id</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="listpromptsrequest-params" data-typedoc-h="3"><span>params: PaginatedRequestParams</span><a href="#listpromptsrequest-params" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from PaginatedRequest.params</p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="listpromptsrequest-method" data-typedoc-h="3"><span>method: "prompts/list"</span><a href="#listpromptsrequest-method" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Overrides PaginatedRequest.method</p></aside></section>
</div>

<div class="type">
  ### `ListPromptsResultResponse`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ListPromptsResultResponse</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#listpromptsresultresponse-jsonrpc">jsonrpc</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"2.0"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#listpromptsresultresponse-id">id</a><span class="tsd-signature-symbol">:</span> <a href="#requestid" class="tsd-signature-type tsd-kind-type-alias">RequestId</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#listpromptsresultresponse-result">result</a><span class="tsd-signature-symbol">:</span> <a href="#listpromptsresult" class="tsd-signature-type tsd-kind-interface">ListPromptsResult</a><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>A successful response from the server for a <a href="#listpromptsrequest" class="tsd-kind-interface">prompts/list</a> request.</p> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: List prompts result response<a href="#listpromptsresultresponse-example-list-prompts-result-response" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="listpromptsresultresponse-example-list-prompts-result-response"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"jsonrpc"</span><span class="hl-0">: </span><span class="hl-2">"2.0"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"id"</span><span class="hl-0">: </span><span class="hl-2">"list-prompts-example"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"result"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"resultType"</span><span class="hl-0">: </span><span class="hl-2">"complete"</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"prompts"</span><span class="hl-0">: \[</span><br /><span class="hl-0">      \{</span><br /><span class="hl-0">        </span><span class="hl-1">"name"</span><span class="hl-0">: </span><span class="hl-2">"code\_review"</span><span class="hl-0">,</span><br /><span class="hl-0">        </span><span class="hl-1">"title"</span><span class="hl-0">: </span><span class="hl-2">"Request Code Review"</span><span class="hl-0">,</span><br /><span class="hl-0">        </span><span class="hl-1">"description"</span><span class="hl-0">: </span><span class="hl-2">"Asks the LLM to analyze code quality and suggest improvements"</span><span class="hl-0">,</span><br /><span class="hl-0">        </span><span class="hl-1">"arguments"</span><span class="hl-0">: \[</span><br /><span class="hl-0">          \{</span><br /><span class="hl-0">            </span><span class="hl-1">"name"</span><span class="hl-0">: </span><span class="hl-2">"code"</span><span class="hl-0">,</span><br /><span class="hl-0">            </span><span class="hl-1">"description"</span><span class="hl-0">: </span><span class="hl-2">"The code to review"</span><span class="hl-0">,</span><br /><span class="hl-0">            </span><span class="hl-1">"required"</span><span class="hl-0">: </span><span class="hl-5">true</span><br /><span class="hl-0">          }</span><br /><span class="hl-0">        ],</span><br /><span class="hl-0">        </span><span class="hl-1">"icons"</span><span class="hl-0">: \[</span><br /><span class="hl-0">          \{</span><br /><span class="hl-0">            </span><span class="hl-1">"src"</span><span class="hl-0">: </span><span class="hl-2">"[https://example.com/review-icon.svg](https://example.com/review-icon.svg)"</span><span class="hl-0">,</span><br /><span class="hl-0">            </span><span class="hl-1">"mimeType"</span><span class="hl-0">: </span><span class="hl-2">"image/svg+xml"</span><span class="hl-0">,</span><br /><span class="hl-0">            </span><span class="hl-1">"sizes"</span><span class="hl-0">: \[</span><span class="hl-2">"any"</span><span class="hl-0">]</span><br /><span class="hl-0">          }</span><br /><span class="hl-0">        ]</span><br /><span class="hl-0">      }</span><br /><span class="hl-0">    ],</span><br /><span class="hl-0">    </span><span class="hl-1">"nextCursor"</span><span class="hl-0">: </span><span class="hl-2">"next-page-cursor"</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"ttlMs"</span><span class="hl-0">: </span><span class="hl-3">600000</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"cacheScope"</span><span class="hl-0">: </span><span class="hl-2">"public"</span><br /><span class="hl-0">  }</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="listpromptsresultresponse-jsonrpc" data-typedoc-h="3"><span>jsonrpc: "2.0"</span><a href="#listpromptsresultresponse-jsonrpc" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#jsonrpcresultresponse">JSONRPCResultResponse</a>.<a href="#jsonrpcresultresponse-jsonrpc">jsonrpc</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="listpromptsresultresponse-id" data-typedoc-h="3"><span>id: RequestId</span><a href="#listpromptsresultresponse-id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#jsonrpcresultresponse">JSONRPCResultResponse</a>.<a href="#jsonrpcresultresponse-id">id</a></p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="listpromptsresultresponse-result" data-typedoc-h="3"><span>result: ListPromptsResult</span><a href="#listpromptsresultresponse-result" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Overrides <a href="#jsonrpcresultresponse">JSONRPCResultResponse</a>.<a href="#jsonrpcresultresponse-result">result</a></p></aside></section>
</div>

<div class="type">
  ### `ListPromptsResult`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ListPromptsResult</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#listpromptsresult-_meta">\_meta</a><span class="tsd-signature-symbol">?:</span> <a href="#metaobject" class="tsd-signature-type tsd-kind-type-alias">MetaObject</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#listpromptsresult-resulttype">resultType</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#listpromptsresult-nextcursor">nextCursor</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#listpromptsresult-ttlms">ttlMs</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#listpromptsresult-cachescope">cacheScope</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"public"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"private"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#listpromptsresult-prompts">prompts</a><span class="tsd-signature-symbol">:</span> <a href="#prompt" class="tsd-signature-type tsd-kind-interface">Prompt</a><span class="tsd-signature-symbol">\[]</span><span class="tsd-signature-symbol">;</span><br />  <span class="tsd-signature-symbol">\[</span><span class="tsd-kind-index-signature">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>The result returned by the server for a <a href="#listpromptsrequest" class="tsd-kind-interface">prompts/list</a> request.</p> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Prompts list with cursor and TTL<a href="#listpromptsresult-example-prompts-list-with-cursor-and-ttl" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="listpromptsresult-example-prompts-list-with-cursor-and-ttl"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"resultType"</span><span class="hl-0">: </span><span class="hl-2">"complete"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"prompts"</span><span class="hl-0">: \[</span><br /><span class="hl-0">    \{</span><br /><span class="hl-0">      </span><span class="hl-1">"name"</span><span class="hl-0">: </span><span class="hl-2">"code\_review"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"title"</span><span class="hl-0">: </span><span class="hl-2">"Request Code Review"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"description"</span><span class="hl-0">: </span><span class="hl-2">"Asks the LLM to analyze code quality and suggest improvements"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"arguments"</span><span class="hl-0">: \[</span><br /><span class="hl-0">        \{</span><br /><span class="hl-0">          </span><span class="hl-1">"name"</span><span class="hl-0">: </span><span class="hl-2">"code"</span><span class="hl-0">,</span><br /><span class="hl-0">          </span><span class="hl-1">"description"</span><span class="hl-0">: </span><span class="hl-2">"The code to review"</span><span class="hl-0">,</span><br /><span class="hl-0">          </span><span class="hl-1">"required"</span><span class="hl-0">: </span><span class="hl-5">true</span><br /><span class="hl-0">        }</span><br /><span class="hl-0">      ],</span><br /><span class="hl-0">      </span><span class="hl-1">"icons"</span><span class="hl-0">: \[</span><br /><span class="hl-0">        \{</span><br /><span class="hl-0">          </span><span class="hl-1">"src"</span><span class="hl-0">: </span><span class="hl-2">"[https://example.com/review-icon.svg](https://example.com/review-icon.svg)"</span><span class="hl-0">,</span><br /><span class="hl-0">          </span><span class="hl-1">"mimeType"</span><span class="hl-0">: </span><span class="hl-2">"image/svg+xml"</span><span class="hl-0">,</span><br /><span class="hl-0">          </span><span class="hl-1">"sizes"</span><span class="hl-0">: \[</span><span class="hl-2">"any"</span><span class="hl-0">]</span><br /><span class="hl-0">        }</span><br /><span class="hl-0">      ]</span><br /><span class="hl-0">    }</span><br /><span class="hl-0">  ],</span><br /><span class="hl-0">  </span><span class="hl-1">"nextCursor"</span><span class="hl-0">: </span><span class="hl-2">"next-page-cursor"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"ttlMs"</span><span class="hl-0">: </span><span class="hl-3">600000</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"cacheScope"</span><span class="hl-0">: </span><span class="hl-2">"public"</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="listpromptsresult-_meta" data-typedoc-h="3"><span>\_meta?: MetaObject</span><a href="#listpromptsresult-_meta" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from PaginatedResult.\_meta</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="listpromptsresult-resulttype" data-typedoc-h="3"><span>resultType: string</span><a href="#listpromptsresult-resulttype" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Indicates the type of the result, which allows the client to determine
  how to parse the result object.</p> <p>Servers implementing this protocol version MUST include this field.
  For backward compatibility, when a client receives a result from a
  server implementing an earlier protocol version (which does not include <code>resultType</code>), the client MUST treat the absent field as <code>"complete"</code>.</p> </div><aside class="tsd-sources"><p>Inherited from PaginatedResult.resultType</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="listpromptsresult-nextcursor" data-typedoc-h="3"><span>nextCursor?: string</span><a href="#listpromptsresult-nextcursor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>An opaque token representing the pagination position after the last returned result.
  If present, there may be more results available.</p> </div><aside class="tsd-sources"><p>Inherited from PaginatedResult.nextCursor</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="listpromptsresult-ttlms" data-typedoc-h="3"><span>ttlMs: number</span><a href="#listpromptsresult-ttlms" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>A hint from the server indicating how long (in milliseconds) the
  client MAY cache this response before re-fetching. Semantics are
  analogous to HTTP Cache-Control max-age.</p> <ul> <li>If 0, The response SHOULD be considered immediately stale,
  The client MAY re-fetch every time the result is needed.</li> <li>If positive, the client SHOULD consider the result fresh for this many
  milliseconds after receiving the response.</li> </ul> </div><aside class="tsd-sources"><p>Inherited from CacheableResult.ttlMs</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="listpromptsresult-cachescope" data-typedoc-h="3"><span>cacheScope: "public" | "private"</span><a href="#listpromptsresult-cachescope" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Indicates the intended scope of the cached response, analogous to HTTP <code>Cache-Control: public</code> vs <code>Cache-Control: private</code>.</p> <ul> <li><code>"public"</code>: Any client or intermediary (e.g., shared gateway, proxy)
  MAY cache the response and serve it to any user.</li> <li><code>"private"</code>: Only the requesting user's client MAY cache the response.
  Shared caches (e.g., multi-tenant gateways) MUST NOT serve a cached
  copy to a different user.</li> </ul> </div><aside class="tsd-sources"><p>Inherited from CacheableResult.cacheScope</p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="listpromptsresult-prompts" data-typedoc-h="3"><span>prompts: Prompt\[]</span><a href="#listpromptsresult-prompts" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section>
</div>

<div class="type">
  ### `Prompt`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">Prompt</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#prompt-icons">icons</a><span class="tsd-signature-symbol">?:</span> <a href="#icon" class="tsd-signature-type tsd-kind-interface">Icon</a><span class="tsd-signature-symbol">\[]</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#prompt-name">name</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#prompt-title">title</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#prompt-description">description</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#prompt-arguments">arguments</a><span class="tsd-signature-symbol">?:</span> <a href="#promptargument" class="tsd-signature-type tsd-kind-interface">PromptArgument</a><span class="tsd-signature-symbol">\[]</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#prompt-_meta">\_meta</a><span class="tsd-signature-symbol">?:</span> <a href="#metaobject" class="tsd-signature-type tsd-kind-type-alias">MetaObject</a><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>A prompt or prompt template that the server offers.</p> </div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="prompt-icons" data-typedoc-h="3"><span>icons?: Icon\[]</span><a href="#prompt-icons" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><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 class="tsd-sources"><p>Inherited from Icons.icons</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="prompt-name" data-typedoc-h="3"><span>name: string</span><a href="#prompt-name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><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 class="tsd-sources"><p>Inherited from BaseMetadata.name</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="prompt-title" data-typedoc-h="3"><span>title?: string</span><a href="#prompt-title" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><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 <a href="#tool" class="tsd-kind-interface">Tool</a>,
  where <code>annotations.title</code> should be given precedence over using <code>name</code>,
  if present).</p> </div><aside class="tsd-sources"><p>Inherited from BaseMetadata.title</p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="prompt-description" data-typedoc-h="3"><span>description?: string</span><a href="#prompt-description" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>An optional description of what this prompt provides</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="prompt-arguments" data-typedoc-h="3"><span>arguments?: PromptArgument\[]</span><a href="#prompt-arguments" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>A list of arguments to use for templating the prompt.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="prompt-_meta" data-typedoc-h="3"><span>\_meta?: MetaObject</span><a href="#prompt-_meta" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section>
</div>

<div class="type">
  ### `PromptArgument`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">PromptArgument</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#promptargument-name">name</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#promptargument-title">title</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#promptargument-description">description</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#promptargument-required">required</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Describes an argument that a prompt can accept.</p> </div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="promptargument-name" data-typedoc-h="3"><span>name: string</span><a href="#promptargument-name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><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 class="tsd-sources"><p>Inherited from BaseMetadata.name</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="promptargument-title" data-typedoc-h="3"><span>title?: string</span><a href="#promptargument-title" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><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 <a href="#tool" class="tsd-kind-interface">Tool</a>,
  where <code>annotations.title</code> should be given precedence over using <code>name</code>,
  if present).</p> </div><aside class="tsd-sources"><p>Inherited from BaseMetadata.title</p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="promptargument-description" data-typedoc-h="3"><span>description?: string</span><a href="#promptargument-description" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>A human-readable description of the argument.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="promptargument-required" data-typedoc-h="3"><span>required?: boolean</span><a href="#promptargument-required" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Whether this argument must be provided.</p> </div></section>
</div>

## `resources/list`

<div class="type">
  ### `ListResourcesRequest`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ListResourcesRequest</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#listresourcesrequest-jsonrpc">jsonrpc</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"2.0"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#listresourcesrequest-id">id</a><span class="tsd-signature-symbol">:</span> <a href="#requestid" class="tsd-signature-type tsd-kind-type-alias">RequestId</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#listresourcesrequest-params">params</a><span class="tsd-signature-symbol">:</span> <a href="#paginatedrequestparams" class="tsd-signature-type tsd-kind-interface">PaginatedRequestParams</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#listresourcesrequest-method">method</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"resources/list"</span><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Sent from the client to request a list of resources the server has.</p> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: List resources request<a href="#listresourcesrequest-example-list-resources-request" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="listresourcesrequest-example-list-resources-request"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"jsonrpc"</span><span class="hl-0">: </span><span class="hl-2">"2.0"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"id"</span><span class="hl-0">: </span><span class="hl-2">"list-resources-example"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"method"</span><span class="hl-0">: </span><span class="hl-2">"resources/list"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"params"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"\_meta"</span><span class="hl-0">: \{</span><br /><span class="hl-0">      </span><span class="hl-1">"io.modelcontextprotocol/protocolVersion"</span><span class="hl-0">: </span><span class="hl-2">"2026-07-28"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"io.modelcontextprotocol/clientInfo"</span><span class="hl-0">: \{</span><br /><span class="hl-0">        </span><span class="hl-1">"name"</span><span class="hl-0">: </span><span class="hl-2">"ExampleClient"</span><span class="hl-0">,</span><br /><span class="hl-0">        </span><span class="hl-1">"version"</span><span class="hl-0">: </span><span class="hl-2">"1.0.0"</span><br /><span class="hl-0">      },</span><br /><span class="hl-0">      </span><span class="hl-1">"io.modelcontextprotocol/clientCapabilities"</span><span class="hl-0">: \{}</span><br /><span class="hl-0">    }</span><br /><span class="hl-0">  }</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="listresourcesrequest-jsonrpc" data-typedoc-h="3"><span>jsonrpc: "2.0"</span><a href="#listresourcesrequest-jsonrpc" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from PaginatedRequest.jsonrpc</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="listresourcesrequest-id" data-typedoc-h="3"><span>id: RequestId</span><a href="#listresourcesrequest-id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from PaginatedRequest.id</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="listresourcesrequest-params" data-typedoc-h="3"><span>params: PaginatedRequestParams</span><a href="#listresourcesrequest-params" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from PaginatedRequest.params</p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="listresourcesrequest-method" data-typedoc-h="3"><span>method: "resources/list"</span><a href="#listresourcesrequest-method" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Overrides PaginatedRequest.method</p></aside></section>
</div>

<div class="type">
  ### `ListResourcesResultResponse`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ListResourcesResultResponse</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#listresourcesresultresponse-jsonrpc">jsonrpc</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"2.0"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#listresourcesresultresponse-id">id</a><span class="tsd-signature-symbol">:</span> <a href="#requestid" class="tsd-signature-type tsd-kind-type-alias">RequestId</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#listresourcesresultresponse-result">result</a><span class="tsd-signature-symbol">:</span> <a href="#listresourcesresult" class="tsd-signature-type tsd-kind-interface">ListResourcesResult</a><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>A successful response from the server for a <a href="#listresourcesrequest" class="tsd-kind-interface">resources/list</a> request.</p> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: List resources result response<a href="#listresourcesresultresponse-example-list-resources-result-response" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="listresourcesresultresponse-example-list-resources-result-response"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"jsonrpc"</span><span class="hl-0">: </span><span class="hl-2">"2.0"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"id"</span><span class="hl-0">: </span><span class="hl-2">"list-resources-example"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"result"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"resultType"</span><span class="hl-0">: </span><span class="hl-2">"complete"</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"resources"</span><span class="hl-0">: \[</span><br /><span class="hl-0">      \{</span><br /><span class="hl-0">        </span><span class="hl-1">"uri"</span><span class="hl-0">: </span><span class="hl-2">"file:///project/src/main.rs"</span><span class="hl-0">,</span><br /><span class="hl-0">        </span><span class="hl-1">"name"</span><span class="hl-0">: </span><span class="hl-2">"main.rs"</span><span class="hl-0">,</span><br /><span class="hl-0">        </span><span class="hl-1">"title"</span><span class="hl-0">: </span><span class="hl-2">"Rust Software Application Main File"</span><span class="hl-0">,</span><br /><span class="hl-0">        </span><span class="hl-1">"description"</span><span class="hl-0">: </span><span class="hl-2">"Primary application entry point"</span><span class="hl-0">,</span><br /><span class="hl-0">        </span><span class="hl-1">"mimeType"</span><span class="hl-0">: </span><span class="hl-2">"text/x-rust"</span><span class="hl-0">,</span><br /><span class="hl-0">        </span><span class="hl-1">"icons"</span><span class="hl-0">: \[</span><br /><span class="hl-0">          \{</span><br /><span class="hl-0">            </span><span class="hl-1">"src"</span><span class="hl-0">: </span><span class="hl-2">"[https://example.com/rust-file-icon.png](https://example.com/rust-file-icon.png)"</span><span class="hl-0">,</span><br /><span class="hl-0">            </span><span class="hl-1">"mimeType"</span><span class="hl-0">: </span><span class="hl-2">"image/png"</span><span class="hl-0">,</span><br /><span class="hl-0">            </span><span class="hl-1">"sizes"</span><span class="hl-0">: \[</span><span class="hl-2">"48x48"</span><span class="hl-0">]</span><br /><span class="hl-0">          }</span><br /><span class="hl-0">        ]</span><br /><span class="hl-0">      }</span><br /><span class="hl-0">    ],</span><br /><span class="hl-0">    </span><span class="hl-1">"nextCursor"</span><span class="hl-0">: </span><span class="hl-2">"eyJwYWdlIjogM30="</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"ttlMs"</span><span class="hl-0">: </span><span class="hl-3">600000</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"cacheScope"</span><span class="hl-0">: </span><span class="hl-2">"private"</span><br /><span class="hl-0">  }</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="listresourcesresultresponse-jsonrpc" data-typedoc-h="3"><span>jsonrpc: "2.0"</span><a href="#listresourcesresultresponse-jsonrpc" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#jsonrpcresultresponse">JSONRPCResultResponse</a>.<a href="#jsonrpcresultresponse-jsonrpc">jsonrpc</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="listresourcesresultresponse-id" data-typedoc-h="3"><span>id: RequestId</span><a href="#listresourcesresultresponse-id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#jsonrpcresultresponse">JSONRPCResultResponse</a>.<a href="#jsonrpcresultresponse-id">id</a></p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="listresourcesresultresponse-result" data-typedoc-h="3"><span>result: ListResourcesResult</span><a href="#listresourcesresultresponse-result" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Overrides <a href="#jsonrpcresultresponse">JSONRPCResultResponse</a>.<a href="#jsonrpcresultresponse-result">result</a></p></aside></section>
</div>

<div class="type">
  ### `ListResourcesResult`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ListResourcesResult</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#listresourcesresult-_meta">\_meta</a><span class="tsd-signature-symbol">?:</span> <a href="#metaobject" class="tsd-signature-type tsd-kind-type-alias">MetaObject</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#listresourcesresult-resulttype">resultType</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#listresourcesresult-nextcursor">nextCursor</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#listresourcesresult-ttlms">ttlMs</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#listresourcesresult-cachescope">cacheScope</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"public"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"private"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#listresourcesresult-resources">resources</a><span class="tsd-signature-symbol">:</span> <a href="#resource" class="tsd-signature-type tsd-kind-interface">Resource</a><span class="tsd-signature-symbol">\[]</span><span class="tsd-signature-symbol">;</span><br />  <span class="tsd-signature-symbol">\[</span><span class="tsd-kind-index-signature">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>The result returned by the server for a <a href="#listresourcesrequest" class="tsd-kind-interface">resources/list</a> request.</p> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Resources list with cursor and TTL<a href="#listresourcesresult-example-resources-list-with-cursor-and-ttl" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="listresourcesresult-example-resources-list-with-cursor-and-ttl"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"resultType"</span><span class="hl-0">: </span><span class="hl-2">"complete"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"resources"</span><span class="hl-0">: \[</span><br /><span class="hl-0">    \{</span><br /><span class="hl-0">      </span><span class="hl-1">"uri"</span><span class="hl-0">: </span><span class="hl-2">"file:///project/src/main.rs"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"name"</span><span class="hl-0">: </span><span class="hl-2">"main.rs"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"title"</span><span class="hl-0">: </span><span class="hl-2">"Rust Software Application Main File"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"description"</span><span class="hl-0">: </span><span class="hl-2">"Primary application entry point"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"mimeType"</span><span class="hl-0">: </span><span class="hl-2">"text/x-rust"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"icons"</span><span class="hl-0">: \[</span><br /><span class="hl-0">        \{</span><br /><span class="hl-0">          </span><span class="hl-1">"src"</span><span class="hl-0">: </span><span class="hl-2">"[https://example.com/rust-file-icon.png](https://example.com/rust-file-icon.png)"</span><span class="hl-0">,</span><br /><span class="hl-0">          </span><span class="hl-1">"mimeType"</span><span class="hl-0">: </span><span class="hl-2">"image/png"</span><span class="hl-0">,</span><br /><span class="hl-0">          </span><span class="hl-1">"sizes"</span><span class="hl-0">: \[</span><span class="hl-2">"48x48"</span><span class="hl-0">]</span><br /><span class="hl-0">        }</span><br /><span class="hl-0">      ]</span><br /><span class="hl-0">    }</span><br /><span class="hl-0">  ],</span><br /><span class="hl-0">  </span><span class="hl-1">"nextCursor"</span><span class="hl-0">: </span><span class="hl-2">"eyJwYWdlIjogM30="</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"ttlMs"</span><span class="hl-0">: </span><span class="hl-3">600000</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"cacheScope"</span><span class="hl-0">: </span><span class="hl-2">"private"</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="listresourcesresult-_meta" data-typedoc-h="3"><span>\_meta?: MetaObject</span><a href="#listresourcesresult-_meta" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from PaginatedResult.\_meta</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="listresourcesresult-resulttype" data-typedoc-h="3"><span>resultType: string</span><a href="#listresourcesresult-resulttype" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Indicates the type of the result, which allows the client to determine
  how to parse the result object.</p> <p>Servers implementing this protocol version MUST include this field.
  For backward compatibility, when a client receives a result from a
  server implementing an earlier protocol version (which does not include <code>resultType</code>), the client MUST treat the absent field as <code>"complete"</code>.</p> </div><aside class="tsd-sources"><p>Inherited from PaginatedResult.resultType</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="listresourcesresult-nextcursor" data-typedoc-h="3"><span>nextCursor?: string</span><a href="#listresourcesresult-nextcursor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>An opaque token representing the pagination position after the last returned result.
  If present, there may be more results available.</p> </div><aside class="tsd-sources"><p>Inherited from PaginatedResult.nextCursor</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="listresourcesresult-ttlms" data-typedoc-h="3"><span>ttlMs: number</span><a href="#listresourcesresult-ttlms" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>A hint from the server indicating how long (in milliseconds) the
  client MAY cache this response before re-fetching. Semantics are
  analogous to HTTP Cache-Control max-age.</p> <ul> <li>If 0, The response SHOULD be considered immediately stale,
  The client MAY re-fetch every time the result is needed.</li> <li>If positive, the client SHOULD consider the result fresh for this many
  milliseconds after receiving the response.</li> </ul> </div><aside class="tsd-sources"><p>Inherited from CacheableResult.ttlMs</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="listresourcesresult-cachescope" data-typedoc-h="3"><span>cacheScope: "public" | "private"</span><a href="#listresourcesresult-cachescope" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Indicates the intended scope of the cached response, analogous to HTTP <code>Cache-Control: public</code> vs <code>Cache-Control: private</code>.</p> <ul> <li><code>"public"</code>: Any client or intermediary (e.g., shared gateway, proxy)
  MAY cache the response and serve it to any user.</li> <li><code>"private"</code>: Only the requesting user's client MAY cache the response.
  Shared caches (e.g., multi-tenant gateways) MUST NOT serve a cached
  copy to a different user.</li> </ul> </div><aside class="tsd-sources"><p>Inherited from CacheableResult.cacheScope</p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="listresourcesresult-resources" data-typedoc-h="3"><span>resources: Resource\[]</span><a href="#listresourcesresult-resources" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section>
</div>

<div class="type">
  ### `Resource`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">Resource</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#resource-icons">icons</a><span class="tsd-signature-symbol">?:</span> <a href="#icon" class="tsd-signature-type tsd-kind-interface">Icon</a><span class="tsd-signature-symbol">\[]</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#resource-name">name</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#resource-title">title</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#resource-uri">uri</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#resource-description">description</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#resource-mimetype">mimeType</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#resource-annotations">annotations</a><span class="tsd-signature-symbol">?:</span> <a href="#annotations" class="tsd-signature-type tsd-kind-interface">Annotations</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#resource-size">size</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#resource-_meta">\_meta</a><span class="tsd-signature-symbol">?:</span> <a href="#metaobject" class="tsd-signature-type tsd-kind-type-alias">MetaObject</a><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>A known resource that the server is capable of reading.</p> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: File resource with annotations<a href="#resource-example-file-resource-with-annotations" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="resource-example-file-resource-with-annotations"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"uri"</span><span class="hl-0">: </span><span class="hl-2">"file:///project/README.md"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"name"</span><span class="hl-0">: </span><span class="hl-2">"README.md"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"title"</span><span class="hl-0">: </span><span class="hl-2">"Project Documentation"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"mimeType"</span><span class="hl-0">: </span><span class="hl-2">"text/markdown"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"annotations"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"audience"</span><span class="hl-0">: \[</span><span class="hl-2">"user"</span><span class="hl-0">],</span><br /><span class="hl-0">    </span><span class="hl-1">"priority"</span><span class="hl-0">: </span><span class="hl-3">0.8</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"lastModified"</span><span class="hl-0">: </span><span class="hl-2">"2025-01-12T15:00:58Z"</span><br /><span class="hl-0">  }</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="resource-icons" data-typedoc-h="3"><span>icons?: Icon\[]</span><a href="#resource-icons" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><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 class="tsd-sources"><p>Inherited from Icons.icons</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="resource-name" data-typedoc-h="3"><span>name: string</span><a href="#resource-name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><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 class="tsd-sources"><p>Inherited from BaseMetadata.name</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="resource-title" data-typedoc-h="3"><span>title?: string</span><a href="#resource-title" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><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 <a href="#tool" class="tsd-kind-interface">Tool</a>,
  where <code>annotations.title</code> should be given precedence over using <code>name</code>,
  if present).</p> </div><aside class="tsd-sources"><p>Inherited from BaseMetadata.title</p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="resource-uri" data-typedoc-h="3"><span>uri: string</span><a href="#resource-uri" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>The URI of this resource.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="resource-description" data-typedoc-h="3"><span>description?: string</span><a href="#resource-description" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><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 class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="resource-mimetype" data-typedoc-h="3"><span>mimeType?: string</span><a href="#resource-mimetype" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>The MIME type of this resource, if known.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="resource-annotations" data-typedoc-h="3"><span>annotations?: Annotations</span><a href="#resource-annotations" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Optional annotations for the client.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="resource-size" data-typedoc-h="3"><span>size?: number</span><a href="#resource-size" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><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 class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="resource-_meta" data-typedoc-h="3"><span>\_meta?: MetaObject</span><a href="#resource-_meta" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section>
</div>

## `resources/read`

<div class="type">
  ### `ReadResourceRequest`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ReadResourceRequest</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#readresourcerequest-jsonrpc">jsonrpc</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"2.0"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#readresourcerequest-id">id</a><span class="tsd-signature-symbol">:</span> <a href="#requestid" class="tsd-signature-type tsd-kind-type-alias">RequestId</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#readresourcerequest-method">method</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"resources/read"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#readresourcerequest-params">params</a><span class="tsd-signature-symbol">:</span> <a href="#readresourcerequestparams" class="tsd-signature-type tsd-kind-interface">ReadResourceRequestParams</a><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Sent from the client to the server, to read a specific resource URI.</p> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Read resource request<a href="#readresourcerequest-example-read-resource-request" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="readresourcerequest-example-read-resource-request"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"jsonrpc"</span><span class="hl-0">: </span><span class="hl-2">"2.0"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"id"</span><span class="hl-0">: </span><span class="hl-2">"read-resource-example"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"method"</span><span class="hl-0">: </span><span class="hl-2">"resources/read"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"params"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"\_meta"</span><span class="hl-0">: \{</span><br /><span class="hl-0">      </span><span class="hl-1">"io.modelcontextprotocol/protocolVersion"</span><span class="hl-0">: </span><span class="hl-2">"2026-07-28"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"io.modelcontextprotocol/clientInfo"</span><span class="hl-0">: \{</span><br /><span class="hl-0">        </span><span class="hl-1">"name"</span><span class="hl-0">: </span><span class="hl-2">"ExampleClient"</span><span class="hl-0">,</span><br /><span class="hl-0">        </span><span class="hl-1">"version"</span><span class="hl-0">: </span><span class="hl-2">"1.0.0"</span><br /><span class="hl-0">      },</span><br /><span class="hl-0">      </span><span class="hl-1">"io.modelcontextprotocol/clientCapabilities"</span><span class="hl-0">: \{}</span><br /><span class="hl-0">    },</span><br /><span class="hl-0">    </span><span class="hl-1">"uri"</span><span class="hl-0">: </span><span class="hl-2">"file:///project/src/main.rs"</span><br /><span class="hl-0">  }</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="readresourcerequest-jsonrpc" data-typedoc-h="3"><span>jsonrpc: "2.0"</span><a href="#readresourcerequest-jsonrpc" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-jsonrpc">jsonrpc</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="readresourcerequest-id" data-typedoc-h="3"><span>id: RequestId</span><a href="#readresourcerequest-id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-id">id</a></p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="readresourcerequest-method" data-typedoc-h="3"><span>method: "resources/read"</span><a href="#readresourcerequest-method" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Overrides <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-method">method</a></p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="readresourcerequest-params" data-typedoc-h="3"><span>params: ReadResourceRequestParams</span><a href="#readresourcerequest-params" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Overrides <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-params">params</a></p></aside></section>
</div>

<div class="type">
  ### `ReadResourceRequestParams`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ReadResourceRequestParams</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#readresourcerequestparams-_meta">\_meta</a><span class="tsd-signature-symbol">:</span> <a href="#requestmetaobject" class="tsd-signature-type tsd-kind-interface">RequestMetaObject</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#readresourcerequestparams-inputresponses">inputResponses</a><span class="tsd-signature-symbol">?:</span> <a href="#inputresponses" class="tsd-signature-type tsd-kind-interface">InputResponses</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#readresourcerequestparams-requeststate">requestState</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#readresourcerequestparams-uri">uri</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Parameters for a <code>resources/read</code> request.</p> </div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="readresourcerequestparams-_meta" data-typedoc-h="3"><span>\_meta: RequestMetaObject</span><a href="#readresourcerequestparams-_meta" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#inputresponserequestparams">InputResponseRequestParams</a>.<a href="#inputresponserequestparams-_meta">\_meta</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="readresourcerequestparams-inputresponses" data-typedoc-h="3"><span>inputResponses?: InputResponses</span><a href="#readresourcerequestparams-inputresponses" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#inputresponserequestparams">InputResponseRequestParams</a>.<a href="#inputresponserequestparams-inputresponses">inputResponses</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="readresourcerequestparams-requeststate" data-typedoc-h="3"><span>requestState?: string</span><a href="#readresourcerequestparams-requeststate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#inputresponserequestparams">InputResponseRequestParams</a>.<a href="#inputresponserequestparams-requeststate">requestState</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="readresourcerequestparams-uri" data-typedoc-h="3"><span>uri: string</span><a href="#readresourcerequestparams-uri" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><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 class="tsd-sources"><p>Inherited from ResourceRequestParams.uri</p></aside></section>
</div>

<div class="type">
  ### `ReadResourceResultResponse`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ReadResourceResultResponse</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#readresourceresultresponse-jsonrpc">jsonrpc</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"2.0"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#readresourceresultresponse-id">id</a><span class="tsd-signature-symbol">:</span> <a href="#requestid" class="tsd-signature-type tsd-kind-type-alias">RequestId</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#readresourceresultresponse-result">result</a><span class="tsd-signature-symbol">:</span> <a href="#inputrequiredresult" class="tsd-signature-type tsd-kind-interface">InputRequiredResult</a> <span class="tsd-signature-symbol">|</span> <a href="#readresourceresult" class="tsd-signature-type tsd-kind-interface">ReadResourceResult</a><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>A successful response from the server for a <a href="#readresourcerequest" class="tsd-kind-interface">resources/read</a> request.</p> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Read resource result response<a href="#readresourceresultresponse-example-read-resource-result-response" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="readresourceresultresponse-example-read-resource-result-response"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"jsonrpc"</span><span class="hl-0">: </span><span class="hl-2">"2.0"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"id"</span><span class="hl-0">: </span><span class="hl-2">"read-resource-example"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"result"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"resultType"</span><span class="hl-0">: </span><span class="hl-2">"complete"</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"contents"</span><span class="hl-0">: \[</span><br /><span class="hl-0">      \{</span><br /><span class="hl-0">        </span><span class="hl-1">"uri"</span><span class="hl-0">: </span><span class="hl-2">"file:///project/src/main.rs"</span><span class="hl-0">,</span><br /><span class="hl-0">        </span><span class="hl-1">"mimeType"</span><span class="hl-0">: </span><span class="hl-2">"text/x-rust"</span><span class="hl-0">,</span><br /><span class="hl-0">        </span><span class="hl-1">"text"</span><span class="hl-0">: </span><span class="hl-2">"fn main() \{</span><span class="hl-4">\n</span><span class="hl-2">    println!(</span><span class="hl-4">\\"</span><span class="hl-2">Hello world!</span><span class="hl-4">\\"</span><span class="hl-2">);</span><span class="hl-4">\n</span><span class="hl-2">}"</span><br /><span class="hl-0">      }</span><br /><span class="hl-0">    ]</span><br /><span class="hl-0">  }</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Read resource result response with TTL<a href="#readresourceresultresponse-example-read-resource-result-response-with-ttl" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="readresourceresultresponse-example-read-resource-result-response-with-ttl"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"jsonrpc"</span><span class="hl-0">: </span><span class="hl-2">"2.0"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"id"</span><span class="hl-0">: </span><span class="hl-2">"read-resource-with-ttl-example"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"result"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"resultType"</span><span class="hl-0">: </span><span class="hl-2">"complete"</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"contents"</span><span class="hl-0">: \[</span><br /><span class="hl-0">      \{</span><br /><span class="hl-0">        </span><span class="hl-1">"uri"</span><span class="hl-0">: </span><span class="hl-2">"file:///project/src/main.rs"</span><span class="hl-0">,</span><br /><span class="hl-0">        </span><span class="hl-1">"mimeType"</span><span class="hl-0">: </span><span class="hl-2">"text/x-rust"</span><span class="hl-0">,</span><br /><span class="hl-0">        </span><span class="hl-1">"text"</span><span class="hl-0">: </span><span class="hl-2">"fn main() \{</span><span class="hl-4">\n</span><span class="hl-2">    println!(</span><span class="hl-4">\\"</span><span class="hl-2">Hello world!</span><span class="hl-4">\\"</span><span class="hl-2">);</span><span class="hl-4">\n</span><span class="hl-2">}"</span><br /><span class="hl-0">      }</span><br /><span class="hl-0">    ],</span><br /><span class="hl-0">    </span><span class="hl-1">"ttlMs"</span><span class="hl-0">: </span><span class="hl-3">60000</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"cacheScope"</span><span class="hl-0">: </span><span class="hl-2">"private"</span><br /><span class="hl-0">  }</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="readresourceresultresponse-jsonrpc" data-typedoc-h="3"><span>jsonrpc: "2.0"</span><a href="#readresourceresultresponse-jsonrpc" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#jsonrpcresultresponse">JSONRPCResultResponse</a>.<a href="#jsonrpcresultresponse-jsonrpc">jsonrpc</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="readresourceresultresponse-id" data-typedoc-h="3"><span>id: RequestId</span><a href="#readresourceresultresponse-id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#jsonrpcresultresponse">JSONRPCResultResponse</a>.<a href="#jsonrpcresultresponse-id">id</a></p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="readresourceresultresponse-result" data-typedoc-h="3"><span>result: InputRequiredResult | ReadResourceResult</span><a href="#readresourceresultresponse-result" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Overrides <a href="#jsonrpcresultresponse">JSONRPCResultResponse</a>.<a href="#jsonrpcresultresponse-result">result</a></p></aside></section>
</div>

<div class="type">
  ### `ReadResourceResult`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ReadResourceResult</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#readresourceresult-_meta">\_meta</a><span class="tsd-signature-symbol">?:</span> <a href="#metaobject" class="tsd-signature-type tsd-kind-type-alias">MetaObject</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#readresourceresult-resulttype">resultType</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#readresourceresult-ttlms">ttlMs</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#readresourceresult-cachescope">cacheScope</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"public"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"private"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#readresourceresult-contents">contents</a><span class="tsd-signature-symbol">:</span> (<a href="#textresourcecontents" class="tsd-signature-type tsd-kind-interface">TextResourceContents</a> <span class="tsd-signature-symbol">|</span> <a href="#blobresourcecontents" class="tsd-signature-type tsd-kind-interface">BlobResourceContents</a>)<span class="tsd-signature-symbol">\[]</span><span class="tsd-signature-symbol">;</span><br />  <span class="tsd-signature-symbol">\[</span><span class="tsd-kind-index-signature">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>The result returned by the server for a <a href="#readresourcerequest" class="tsd-kind-interface">resources/read</a> request.</p> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: File resource contents<a href="#readresourceresult-example-file-resource-contents" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="readresourceresult-example-file-resource-contents"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"resultType"</span><span class="hl-0">: </span><span class="hl-2">"complete"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"contents"</span><span class="hl-0">: \[</span><br /><span class="hl-0">    \{</span><br /><span class="hl-0">      </span><span class="hl-1">"uri"</span><span class="hl-0">: </span><span class="hl-2">"file:///project/src/main.rs"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"mimeType"</span><span class="hl-0">: </span><span class="hl-2">"text/x-rust"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"text"</span><span class="hl-0">: </span><span class="hl-2">"fn main() \{</span><span class="hl-4">\n</span><span class="hl-2">    println!(</span><span class="hl-4">\\"</span><span class="hl-2">Hello world!</span><span class="hl-4">\\"</span><span class="hl-2">);</span><span class="hl-4">\n</span><span class="hl-2">}"</span><br /><span class="hl-0">    }</span><br /><span class="hl-0">  ],</span><br /><span class="hl-0">  </span><span class="hl-1">"ttlMs"</span><span class="hl-0">: </span><span class="hl-3">60000</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"cacheScope"</span><span class="hl-0">: </span><span class="hl-2">"private"</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="readresourceresult-_meta" data-typedoc-h="3"><span>\_meta?: MetaObject</span><a href="#readresourceresult-_meta" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from CacheableResult.\_meta</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="readresourceresult-resulttype" data-typedoc-h="3"><span>resultType: string</span><a href="#readresourceresult-resulttype" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Indicates the type of the result, which allows the client to determine
  how to parse the result object.</p> <p>Servers implementing this protocol version MUST include this field.
  For backward compatibility, when a client receives a result from a
  server implementing an earlier protocol version (which does not include <code>resultType</code>), the client MUST treat the absent field as <code>"complete"</code>.</p> </div><aside class="tsd-sources"><p>Inherited from CacheableResult.resultType</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="readresourceresult-ttlms" data-typedoc-h="3"><span>ttlMs: number</span><a href="#readresourceresult-ttlms" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>A hint from the server indicating how long (in milliseconds) the
  client MAY cache this response before re-fetching. Semantics are
  analogous to HTTP Cache-Control max-age.</p> <ul> <li>If 0, The response SHOULD be considered immediately stale,
  The client MAY re-fetch every time the result is needed.</li> <li>If positive, the client SHOULD consider the result fresh for this many
  milliseconds after receiving the response.</li> </ul> </div><aside class="tsd-sources"><p>Inherited from CacheableResult.ttlMs</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="readresourceresult-cachescope" data-typedoc-h="3"><span>cacheScope: "public" | "private"</span><a href="#readresourceresult-cachescope" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Indicates the intended scope of the cached response, analogous to HTTP <code>Cache-Control: public</code> vs <code>Cache-Control: private</code>.</p> <ul> <li><code>"public"</code>: Any client or intermediary (e.g., shared gateway, proxy)
  MAY cache the response and serve it to any user.</li> <li><code>"private"</code>: Only the requesting user's client MAY cache the response.
  Shared caches (e.g., multi-tenant gateways) MUST NOT serve a cached
  copy to a different user.</li> </ul> </div><aside class="tsd-sources"><p>Inherited from CacheableResult.cacheScope</p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="readresourceresult-contents" data-typedoc-h="3"><span>contents: (TextResourceContents | BlobResourceContents)\[]</span><a href="#readresourceresult-contents" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section>
</div>

## `resources/templates/list`

<div class="type">
  ### `ListResourceTemplatesRequest`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ListResourceTemplatesRequest</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#listresourcetemplatesrequest-jsonrpc">jsonrpc</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"2.0"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#listresourcetemplatesrequest-id">id</a><span class="tsd-signature-symbol">:</span> <a href="#requestid" class="tsd-signature-type tsd-kind-type-alias">RequestId</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#listresourcetemplatesrequest-params">params</a><span class="tsd-signature-symbol">:</span> <a href="#paginatedrequestparams" class="tsd-signature-type tsd-kind-interface">PaginatedRequestParams</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#listresourcetemplatesrequest-method">method</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"resources/templates/list"</span><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Sent from the client to request a list of resource templates the server has.</p> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: List resource templates request<a href="#listresourcetemplatesrequest-example-list-resource-templates-request" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="listresourcetemplatesrequest-example-list-resource-templates-request"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"jsonrpc"</span><span class="hl-0">: </span><span class="hl-2">"2.0"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"id"</span><span class="hl-0">: </span><span class="hl-2">"list-resource-templates-example"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"method"</span><span class="hl-0">: </span><span class="hl-2">"resources/templates/list"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"params"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"\_meta"</span><span class="hl-0">: \{</span><br /><span class="hl-0">      </span><span class="hl-1">"io.modelcontextprotocol/protocolVersion"</span><span class="hl-0">: </span><span class="hl-2">"2026-07-28"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"io.modelcontextprotocol/clientInfo"</span><span class="hl-0">: \{</span><br /><span class="hl-0">        </span><span class="hl-1">"name"</span><span class="hl-0">: </span><span class="hl-2">"ExampleClient"</span><span class="hl-0">,</span><br /><span class="hl-0">        </span><span class="hl-1">"version"</span><span class="hl-0">: </span><span class="hl-2">"1.0.0"</span><br /><span class="hl-0">      },</span><br /><span class="hl-0">      </span><span class="hl-1">"io.modelcontextprotocol/clientCapabilities"</span><span class="hl-0">: \{}</span><br /><span class="hl-0">    }</span><br /><span class="hl-0">  }</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="listresourcetemplatesrequest-jsonrpc" data-typedoc-h="3"><span>jsonrpc: "2.0"</span><a href="#listresourcetemplatesrequest-jsonrpc" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from PaginatedRequest.jsonrpc</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="listresourcetemplatesrequest-id" data-typedoc-h="3"><span>id: RequestId</span><a href="#listresourcetemplatesrequest-id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from PaginatedRequest.id</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="listresourcetemplatesrequest-params" data-typedoc-h="3"><span>params: PaginatedRequestParams</span><a href="#listresourcetemplatesrequest-params" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from PaginatedRequest.params</p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="listresourcetemplatesrequest-method" data-typedoc-h="3"><span>method: "resources/templates/list"</span><a href="#listresourcetemplatesrequest-method" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Overrides PaginatedRequest.method</p></aside></section>
</div>

<div class="type">
  ### `ListResourceTemplatesResultResponse`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ListResourceTemplatesResultResponse</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#listresourcetemplatesresultresponse-jsonrpc">jsonrpc</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"2.0"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#listresourcetemplatesresultresponse-id">id</a><span class="tsd-signature-symbol">:</span> <a href="#requestid" class="tsd-signature-type tsd-kind-type-alias">RequestId</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#listresourcetemplatesresultresponse-result">result</a><span class="tsd-signature-symbol">:</span> <a href="#listresourcetemplatesresult" class="tsd-signature-type tsd-kind-interface">ListResourceTemplatesResult</a><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>A successful response from the server for a <a href="#listresourcetemplatesrequest" class="tsd-kind-interface">resources/templates/list</a> request.</p> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: List resource templates result response<a href="#listresourcetemplatesresultresponse-example-list-resource-templates-result-response" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="listresourcetemplatesresultresponse-example-list-resource-templates-result-response"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"jsonrpc"</span><span class="hl-0">: </span><span class="hl-2">"2.0"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"id"</span><span class="hl-0">: </span><span class="hl-2">"list-resource-templates-example"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"result"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"resultType"</span><span class="hl-0">: </span><span class="hl-2">"complete"</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"resourceTemplates"</span><span class="hl-0">: \[</span><br /><span class="hl-0">      \{</span><br /><span class="hl-0">        </span><span class="hl-1">"uriTemplate"</span><span class="hl-0">: </span><span class="hl-2">"file:///\{path}"</span><span class="hl-0">,</span><br /><span class="hl-0">        </span><span class="hl-1">"name"</span><span class="hl-0">: </span><span class="hl-2">"Project Files"</span><span class="hl-0">,</span><br /><span class="hl-0">        </span><span class="hl-1">"title"</span><span class="hl-0">: </span><span class="hl-2">"Project Files"</span><span class="hl-0">,</span><br /><span class="hl-0">        </span><span class="hl-1">"description"</span><span class="hl-0">: </span><span class="hl-2">"Access files in the project directory"</span><span class="hl-0">,</span><br /><span class="hl-0">        </span><span class="hl-1">"mimeType"</span><span class="hl-0">: </span><span class="hl-2">"application/octet-stream"</span><span class="hl-0">,</span><br /><span class="hl-0">        </span><span class="hl-1">"icons"</span><span class="hl-0">: \[</span><br /><span class="hl-0">          \{</span><br /><span class="hl-0">            </span><span class="hl-1">"src"</span><span class="hl-0">: </span><span class="hl-2">"[https://example.com/folder-icon.png](https://example.com/folder-icon.png)"</span><span class="hl-0">,</span><br /><span class="hl-0">            </span><span class="hl-1">"mimeType"</span><span class="hl-0">: </span><span class="hl-2">"image/png"</span><span class="hl-0">,</span><br /><span class="hl-0">            </span><span class="hl-1">"sizes"</span><span class="hl-0">: \[</span><span class="hl-2">"48x48"</span><span class="hl-0">]</span><br /><span class="hl-0">          }</span><br /><span class="hl-0">        ]</span><br /><span class="hl-0">      }</span><br /><span class="hl-0">    ],</span><br /><span class="hl-0">    </span><span class="hl-1">"ttlMs"</span><span class="hl-0">: </span><span class="hl-3">3600000</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"cacheScope"</span><span class="hl-0">: </span><span class="hl-2">"public"</span><br /><span class="hl-0">  }</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="listresourcetemplatesresultresponse-jsonrpc" data-typedoc-h="3"><span>jsonrpc: "2.0"</span><a href="#listresourcetemplatesresultresponse-jsonrpc" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#jsonrpcresultresponse">JSONRPCResultResponse</a>.<a href="#jsonrpcresultresponse-jsonrpc">jsonrpc</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="listresourcetemplatesresultresponse-id" data-typedoc-h="3"><span>id: RequestId</span><a href="#listresourcetemplatesresultresponse-id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#jsonrpcresultresponse">JSONRPCResultResponse</a>.<a href="#jsonrpcresultresponse-id">id</a></p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="listresourcetemplatesresultresponse-result" data-typedoc-h="3"><span>result: ListResourceTemplatesResult</span><a href="#listresourcetemplatesresultresponse-result" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Overrides <a href="#jsonrpcresultresponse">JSONRPCResultResponse</a>.<a href="#jsonrpcresultresponse-result">result</a></p></aside></section>
</div>

<div class="type">
  ### `ListResourceTemplatesResult`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ListResourceTemplatesResult</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#listresourcetemplatesresult-_meta">\_meta</a><span class="tsd-signature-symbol">?:</span> <a href="#metaobject" class="tsd-signature-type tsd-kind-type-alias">MetaObject</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#listresourcetemplatesresult-resulttype">resultType</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#listresourcetemplatesresult-nextcursor">nextCursor</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#listresourcetemplatesresult-ttlms">ttlMs</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#listresourcetemplatesresult-cachescope">cacheScope</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"public"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"private"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#listresourcetemplatesresult-resourcetemplates">resourceTemplates</a><span class="tsd-signature-symbol">:</span> <a href="#resourcetemplate" class="tsd-signature-type tsd-kind-interface">ResourceTemplate</a><span class="tsd-signature-symbol">\[]</span><span class="tsd-signature-symbol">;</span><br />  <span class="tsd-signature-symbol">\[</span><span class="tsd-kind-index-signature">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>The result returned by the server for a <a href="#listresourcetemplatesrequest" class="tsd-kind-interface">resources/templates/list</a> request.</p> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Resource templates list with cursor and TTL<a href="#listresourcetemplatesresult-example-resource-templates-list-with-cursor-and-ttl" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="listresourcetemplatesresult-example-resource-templates-list-with-cursor-and-ttl"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"resultType"</span><span class="hl-0">: </span><span class="hl-2">"complete"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"resourceTemplates"</span><span class="hl-0">: \[</span><br /><span class="hl-0">    \{</span><br /><span class="hl-0">      </span><span class="hl-1">"uriTemplate"</span><span class="hl-0">: </span><span class="hl-2">"file:///\{path}"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"name"</span><span class="hl-0">: </span><span class="hl-2">"Project Files"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"title"</span><span class="hl-0">: </span><span class="hl-2">"📁 Project Files"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"description"</span><span class="hl-0">: </span><span class="hl-2">"Access files in the project directory"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"mimeType"</span><span class="hl-0">: </span><span class="hl-2">"application/octet-stream"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"icons"</span><span class="hl-0">: \[</span><br /><span class="hl-0">        \{</span><br /><span class="hl-0">          </span><span class="hl-1">"src"</span><span class="hl-0">: </span><span class="hl-2">"[https://example.com/folder-icon.png](https://example.com/folder-icon.png)"</span><span class="hl-0">,</span><br /><span class="hl-0">          </span><span class="hl-1">"mimeType"</span><span class="hl-0">: </span><span class="hl-2">"image/png"</span><span class="hl-0">,</span><br /><span class="hl-0">          </span><span class="hl-1">"sizes"</span><span class="hl-0">: \[</span><span class="hl-2">"48x48"</span><span class="hl-0">]</span><br /><span class="hl-0">        }</span><br /><span class="hl-0">      ]</span><br /><span class="hl-0">    }</span><br /><span class="hl-0">  ],</span><br /><span class="hl-0">  </span><span class="hl-1">"nextCursor"</span><span class="hl-0">: </span><span class="hl-2">"next-page-cursor"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"ttlMs"</span><span class="hl-0">: </span><span class="hl-3">3600000</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"cacheScope"</span><span class="hl-0">: </span><span class="hl-2">"public"</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="listresourcetemplatesresult-_meta" data-typedoc-h="3"><span>\_meta?: MetaObject</span><a href="#listresourcetemplatesresult-_meta" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from PaginatedResult.\_meta</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="listresourcetemplatesresult-resulttype" data-typedoc-h="3"><span>resultType: string</span><a href="#listresourcetemplatesresult-resulttype" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Indicates the type of the result, which allows the client to determine
  how to parse the result object.</p> <p>Servers implementing this protocol version MUST include this field.
  For backward compatibility, when a client receives a result from a
  server implementing an earlier protocol version (which does not include <code>resultType</code>), the client MUST treat the absent field as <code>"complete"</code>.</p> </div><aside class="tsd-sources"><p>Inherited from PaginatedResult.resultType</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="listresourcetemplatesresult-nextcursor" data-typedoc-h="3"><span>nextCursor?: string</span><a href="#listresourcetemplatesresult-nextcursor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>An opaque token representing the pagination position after the last returned result.
  If present, there may be more results available.</p> </div><aside class="tsd-sources"><p>Inherited from PaginatedResult.nextCursor</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="listresourcetemplatesresult-ttlms" data-typedoc-h="3"><span>ttlMs: number</span><a href="#listresourcetemplatesresult-ttlms" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>A hint from the server indicating how long (in milliseconds) the
  client MAY cache this response before re-fetching. Semantics are
  analogous to HTTP Cache-Control max-age.</p> <ul> <li>If 0, The response SHOULD be considered immediately stale,
  The client MAY re-fetch every time the result is needed.</li> <li>If positive, the client SHOULD consider the result fresh for this many
  milliseconds after receiving the response.</li> </ul> </div><aside class="tsd-sources"><p>Inherited from CacheableResult.ttlMs</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="listresourcetemplatesresult-cachescope" data-typedoc-h="3"><span>cacheScope: "public" | "private"</span><a href="#listresourcetemplatesresult-cachescope" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Indicates the intended scope of the cached response, analogous to HTTP <code>Cache-Control: public</code> vs <code>Cache-Control: private</code>.</p> <ul> <li><code>"public"</code>: Any client or intermediary (e.g., shared gateway, proxy)
  MAY cache the response and serve it to any user.</li> <li><code>"private"</code>: Only the requesting user's client MAY cache the response.
  Shared caches (e.g., multi-tenant gateways) MUST NOT serve a cached
  copy to a different user.</li> </ul> </div><aside class="tsd-sources"><p>Inherited from CacheableResult.cacheScope</p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="listresourcetemplatesresult-resourcetemplates" data-typedoc-h="3"><span>resourceTemplates: ResourceTemplate\[]</span><a href="#listresourcetemplatesresult-resourcetemplates" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section>
</div>

<div class="type">
  ### `ResourceTemplate`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ResourceTemplate</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#resourcetemplate-icons">icons</a><span class="tsd-signature-symbol">?:</span> <a href="#icon" class="tsd-signature-type tsd-kind-interface">Icon</a><span class="tsd-signature-symbol">\[]</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#resourcetemplate-name">name</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#resourcetemplate-title">title</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#resourcetemplate-uritemplate">uriTemplate</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#resourcetemplate-description">description</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#resourcetemplate-mimetype">mimeType</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#resourcetemplate-annotations">annotations</a><span class="tsd-signature-symbol">?:</span> <a href="#annotations" class="tsd-signature-type tsd-kind-interface">Annotations</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#resourcetemplate-_meta">\_meta</a><span class="tsd-signature-symbol">?:</span> <a href="#metaobject" class="tsd-signature-type tsd-kind-type-alias">MetaObject</a><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>A template description for resources available on the server.</p> </div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="resourcetemplate-icons" data-typedoc-h="3"><span>icons?: Icon\[]</span><a href="#resourcetemplate-icons" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><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 class="tsd-sources"><p>Inherited from Icons.icons</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="resourcetemplate-name" data-typedoc-h="3"><span>name: string</span><a href="#resourcetemplate-name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><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 class="tsd-sources"><p>Inherited from BaseMetadata.name</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="resourcetemplate-title" data-typedoc-h="3"><span>title?: string</span><a href="#resourcetemplate-title" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><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 <a href="#tool" class="tsd-kind-interface">Tool</a>,
  where <code>annotations.title</code> should be given precedence over using <code>name</code>,
  if present).</p> </div><aside class="tsd-sources"><p>Inherited from BaseMetadata.title</p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="resourcetemplate-uritemplate" data-typedoc-h="3"><span>uriTemplate: string</span><a href="#resourcetemplate-uritemplate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>A URI template (according to RFC 6570) that can be used to construct resource URIs.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="resourcetemplate-description" data-typedoc-h="3"><span>description?: string</span><a href="#resourcetemplate-description" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><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 class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="resourcetemplate-mimetype" data-typedoc-h="3"><span>mimeType?: string</span><a href="#resourcetemplate-mimetype" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><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 class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="resourcetemplate-annotations" data-typedoc-h="3"><span>annotations?: Annotations</span><a href="#resourcetemplate-annotations" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Optional annotations for the client.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="resourcetemplate-_meta" data-typedoc-h="3"><span>\_meta?: MetaObject</span><a href="#resourcetemplate-_meta" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section>
</div>

## `roots/list`

<div class="type">
  ### `ListRootsRequest`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ListRootsRequest</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#listrootsrequest-method">method</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"roots/list"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#listrootsrequest-params">params</a><span class="tsd-signature-symbol">?:</span> <a href="#requestparams" class="tsd-signature-type tsd-kind-interface">RequestParams</a><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><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><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: List roots request<a href="#listrootsrequest-example-list-roots-request" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="listrootsrequest-example-list-roots-request"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"id"</span><span class="hl-0">: </span><span class="hl-2">"list-roots-example"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"method"</span><span class="hl-0">: </span><span class="hl-2">"roots/list"</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details><div class="tsd-tag-deprecated"><div class="tsd-anchor-link" data-typedoc-h="4">Deprecated</div><p>Deprecated as of protocol version 2026-07-28 (SEP-2577).
  Remains in the specification for at least twelve months; see the
  deprecated features registry.</p> </div></div><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="listrootsrequest-method" data-typedoc-h="3"><span class="deprecated">method: "roots/list"</span><a href="#listrootsrequest-method" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="listrootsrequest-params" data-typedoc-h="3"><span class="deprecated">params?: RequestParams</span><a href="#listrootsrequest-params" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section>
</div>

<div class="type">
  ### `ListRootsResult`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ListRootsResult</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#listrootsresult-roots">roots</a><span class="tsd-signature-symbol">:</span> <a href="#root" class="tsd-signature-type tsd-kind-interface">Root</a><span class="tsd-signature-symbol">\[]</span><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>The result returned by the client for a <a href="#listrootsrequest" class="tsd-kind-interface">roots/list</a> request.
  This result contains an array of <a href="#root" class="tsd-kind-interface">Root</a> objects, each representing a root directory
  or file that the server can operate on.</p> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Single root directory<a href="#listrootsresult-example-single-root-directory" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="listrootsresult-example-single-root-directory"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"roots"</span><span class="hl-0">: \[</span><br /><span class="hl-0">    \{</span><br /><span class="hl-0">      </span><span class="hl-1">"uri"</span><span class="hl-0">: </span><span class="hl-2">"file:///home/user/projects/myproject"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"name"</span><span class="hl-0">: </span><span class="hl-2">"My Project"</span><br /><span class="hl-0">    }</span><br /><span class="hl-0">  ]</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Multiple root directories<a href="#listrootsresult-example-multiple-root-directories" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="listrootsresult-example-multiple-root-directories"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"roots"</span><span class="hl-0">: \[</span><br /><span class="hl-0">    \{</span><br /><span class="hl-0">      </span><span class="hl-1">"uri"</span><span class="hl-0">: </span><span class="hl-2">"file:///home/user/repos/frontend"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"name"</span><span class="hl-0">: </span><span class="hl-2">"Frontend Repository"</span><br /><span class="hl-0">    },</span><br /><span class="hl-0">    \{</span><br /><span class="hl-0">      </span><span class="hl-1">"uri"</span><span class="hl-0">: </span><span class="hl-2">"file:///home/user/repos/backend"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"name"</span><span class="hl-0">: </span><span class="hl-2">"Backend Repository"</span><br /><span class="hl-0">    }</span><br /><span class="hl-0">  ]</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details><div class="tsd-tag-deprecated"><div class="tsd-anchor-link" data-typedoc-h="4">Deprecated</div><p>Deprecated as of protocol version 2026-07-28 (SEP-2577).
  Remains in the specification for at least twelve months; see the
  deprecated features registry.</p> </div></div><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="listrootsresult-roots" data-typedoc-h="3"><span class="deprecated">roots: Root\[]</span><a href="#listrootsresult-roots" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section>
</div>

<div class="type">
  ### `Root`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">Root</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#root-uri">uri</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#root-name">name</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#root-_meta">\_meta</a><span class="tsd-signature-symbol">?:</span> <a href="#metaobject" class="tsd-signature-type tsd-kind-type-alias">MetaObject</a><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Represents a root directory or file that the server can operate on.</p> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Project directory root<a href="#root-example-project-directory-root" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="root-example-project-directory-root"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"uri"</span><span class="hl-0">: </span><span class="hl-2">"file:///home/user/projects/myproject"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"name"</span><span class="hl-0">: </span><span class="hl-2">"My Project"</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details><div class="tsd-tag-deprecated"><div class="tsd-anchor-link" data-typedoc-h="4">Deprecated</div><p>Deprecated as of protocol version 2026-07-28 (SEP-2577).
  Remains in the specification for at least twelve months; see the
  deprecated features registry.</p> </div></div><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="root-uri" data-typedoc-h="3"><span class="deprecated">uri: string</span><a href="#root-uri" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>The URI identifying the root. This <em>must</em> start with <code>file://</code> for now.
  This restriction may be relaxed in future versions of the protocol to allow
  other URI schemes.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="root-name" data-typedoc-h="3"><span class="deprecated">name?: string</span><a href="#root-name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><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 class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="root-_meta" data-typedoc-h="3"><span class="deprecated">\_meta?: MetaObject</span><a href="#root-_meta" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section>
</div>

## `sampling/createMessage`

<div class="type">
  ### `CreateMessageRequest`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">CreateMessageRequest</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#createmessagerequest-method">method</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"sampling/createMessage"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#createmessagerequest-params">params</a><span class="tsd-signature-symbol">:</span> <a href="#createmessagerequestparams" class="tsd-signature-type tsd-kind-interface">CreateMessageRequestParams</a><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><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><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Sampling request<a href="#createmessagerequest-example-sampling-request" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="createmessagerequest-example-sampling-request"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"method"</span><span class="hl-0">: </span><span class="hl-2">"sampling/createMessage"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"params"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"messages"</span><span class="hl-0">: \[</span><br /><span class="hl-0">      \{</span><br /><span class="hl-0">        </span><span class="hl-1">"role"</span><span class="hl-0">: </span><span class="hl-2">"user"</span><span class="hl-0">,</span><br /><span class="hl-0">        </span><span class="hl-1">"content"</span><span class="hl-0">: \{</span><br /><span class="hl-0">          </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"text"</span><span class="hl-0">,</span><br /><span class="hl-0">          </span><span class="hl-1">"text"</span><span class="hl-0">: </span><span class="hl-2">"What is the capital of France?"</span><br /><span class="hl-0">        }</span><br /><span class="hl-0">      }</span><br /><span class="hl-0">    ],</span><br /><span class="hl-0">    </span><span class="hl-1">"modelPreferences"</span><span class="hl-0">: \{</span><br /><span class="hl-0">      </span><span class="hl-1">"hints"</span><span class="hl-0">: \[</span><br /><span class="hl-0">        \{</span><br /><span class="hl-0">          </span><span class="hl-1">"name"</span><span class="hl-0">: </span><span class="hl-2">"claude-3-sonnet"</span><br /><span class="hl-0">        }</span><br /><span class="hl-0">      ],</span><br /><span class="hl-0">      </span><span class="hl-1">"intelligencePriority"</span><span class="hl-0">: </span><span class="hl-3">0.8</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"speedPriority"</span><span class="hl-0">: </span><span class="hl-3">0.5</span><br /><span class="hl-0">    },</span><br /><span class="hl-0">    </span><span class="hl-1">"systemPrompt"</span><span class="hl-0">: </span><span class="hl-2">"You are a helpful assistant."</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"maxTokens"</span><span class="hl-0">: </span><span class="hl-3">100</span><br /><span class="hl-0">  }</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details><div class="tsd-tag-deprecated"><div class="tsd-anchor-link" data-typedoc-h="4">Deprecated</div><p>Deprecated as of protocol version 2026-07-28 (SEP-2577).
  Remains in the specification for at least twelve months; see the
  deprecated features registry.</p> </div></div><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="createmessagerequest-method" data-typedoc-h="3"><span class="deprecated">method: "sampling/createMessage"</span><a href="#createmessagerequest-method" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="createmessagerequest-params" data-typedoc-h="3"><span class="deprecated">params: CreateMessageRequestParams</span><a href="#createmessagerequest-params" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section>
</div>

<div class="type">
  ### `CreateMessageRequestParams`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">CreateMessageRequestParams</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#createmessagerequestparams-messages">messages</a><span class="tsd-signature-symbol">:</span> <a href="#samplingmessage" class="tsd-signature-type tsd-kind-interface">SamplingMessage</a><span class="tsd-signature-symbol">\[]</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#createmessagerequestparams-modelpreferences">modelPreferences</a><span class="tsd-signature-symbol">?:</span> <a href="#modelpreferences" class="tsd-signature-type tsd-kind-interface">ModelPreferences</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#createmessagerequestparams-systemprompt">systemPrompt</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#createmessagerequestparams-includecontext">includeContext</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"none"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"thisServer"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"allServers"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#createmessagerequestparams-temperature">temperature</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#createmessagerequestparams-maxtokens">maxTokens</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#createmessagerequestparams-stopsequences">stopSequences</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">\[]</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#createmessagerequestparams-metadata">metadata</a><span class="tsd-signature-symbol">?:</span> <a href="#jsonobject" class="tsd-signature-type tsd-kind-type-alias">JSONObject</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#createmessagerequestparams-tools">tools</a><span class="tsd-signature-symbol">?:</span> <a href="#tool" class="tsd-signature-type tsd-kind-interface">Tool</a><span class="tsd-signature-symbol">\[]</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#createmessagerequestparams-toolchoice">toolChoice</a><span class="tsd-signature-symbol">?:</span> <a href="#toolchoice" class="tsd-signature-type tsd-kind-interface">ToolChoice</a><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Parameters for a <code>sampling/createMessage</code> request.</p> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Basic request<a href="#createmessagerequestparams-example-basic-request" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="createmessagerequestparams-example-basic-request"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"messages"</span><span class="hl-0">: \[</span><br /><span class="hl-0">    \{</span><br /><span class="hl-0">      </span><span class="hl-1">"role"</span><span class="hl-0">: </span><span class="hl-2">"user"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"content"</span><span class="hl-0">: \{</span><br /><span class="hl-0">        </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"text"</span><span class="hl-0">,</span><br /><span class="hl-0">        </span><span class="hl-1">"text"</span><span class="hl-0">: </span><span class="hl-2">"What is the capital of France?"</span><br /><span class="hl-0">      }</span><br /><span class="hl-0">    }</span><br /><span class="hl-0">  ],</span><br /><span class="hl-0">  </span><span class="hl-1">"modelPreferences"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"hints"</span><span class="hl-0">: \[</span><br /><span class="hl-0">      \{</span><br /><span class="hl-0">        </span><span class="hl-1">"name"</span><span class="hl-0">: </span><span class="hl-2">"claude-3-sonnet"</span><br /><span class="hl-0">      }</span><br /><span class="hl-0">    ],</span><br /><span class="hl-0">    </span><span class="hl-1">"intelligencePriority"</span><span class="hl-0">: </span><span class="hl-3">0.8</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"speedPriority"</span><span class="hl-0">: </span><span class="hl-3">0.5</span><br /><span class="hl-0">  },</span><br /><span class="hl-0">  </span><span class="hl-1">"systemPrompt"</span><span class="hl-0">: </span><span class="hl-2">"You are a helpful assistant."</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"maxTokens"</span><span class="hl-0">: </span><span class="hl-3">100</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Request with tools<a href="#createmessagerequestparams-example-request-with-tools" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="createmessagerequestparams-example-request-with-tools"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"messages"</span><span class="hl-0">: \[</span><br /><span class="hl-0">    \{</span><br /><span class="hl-0">      </span><span class="hl-1">"role"</span><span class="hl-0">: </span><span class="hl-2">"user"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"content"</span><span class="hl-0">: \{</span><br /><span class="hl-0">        </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"text"</span><span class="hl-0">,</span><br /><span class="hl-0">        </span><span class="hl-1">"text"</span><span class="hl-0">: </span><span class="hl-2">"What's the weather like in Paris and London?"</span><br /><span class="hl-0">      }</span><br /><span class="hl-0">    }</span><br /><span class="hl-0">  ],</span><br /><span class="hl-0">  </span><span class="hl-1">"tools"</span><span class="hl-0">: \[</span><br /><span class="hl-0">    \{</span><br /><span class="hl-0">      </span><span class="hl-1">"name"</span><span class="hl-0">: </span><span class="hl-2">"get\_weather"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"description"</span><span class="hl-0">: </span><span class="hl-2">"Get current weather for a city"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"inputSchema"</span><span class="hl-0">: \{</span><br /><span class="hl-0">        </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"object"</span><span class="hl-0">,</span><br /><span class="hl-0">        </span><span class="hl-1">"properties"</span><span class="hl-0">: \{</span><br /><span class="hl-0">          </span><span class="hl-1">"city"</span><span class="hl-0">: \{</span><br /><span class="hl-0">            </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"string"</span><span class="hl-0">,</span><br /><span class="hl-0">            </span><span class="hl-1">"description"</span><span class="hl-0">: </span><span class="hl-2">"City name"</span><br /><span class="hl-0">          }</span><br /><span class="hl-0">        },</span><br /><span class="hl-0">        </span><span class="hl-1">"required"</span><span class="hl-0">: \[</span><span class="hl-2">"city"</span><span class="hl-0">]</span><br /><span class="hl-0">      }</span><br /><span class="hl-0">    }</span><br /><span class="hl-0">  ],</span><br /><span class="hl-0">  </span><span class="hl-1">"toolChoice"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"mode"</span><span class="hl-0">: </span><span class="hl-2">"auto"</span><br /><span class="hl-0">  },</span><br /><span class="hl-0">  </span><span class="hl-1">"maxTokens"</span><span class="hl-0">: </span><span class="hl-3">1000</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Follow-up request with tool results<a href="#createmessagerequestparams-example-follow-up-request-with-tool-results" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="createmessagerequestparams-example-follow-up-request-with-tool-results"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"messages"</span><span class="hl-0">: \[</span><br /><span class="hl-0">    \{</span><br /><span class="hl-0">      </span><span class="hl-1">"role"</span><span class="hl-0">: </span><span class="hl-2">"user"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"content"</span><span class="hl-0">: \{</span><br /><span class="hl-0">        </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"text"</span><span class="hl-0">,</span><br /><span class="hl-0">        </span><span class="hl-1">"text"</span><span class="hl-0">: </span><span class="hl-2">"What's the weather like in Paris and London?"</span><br /><span class="hl-0">      }</span><br /><span class="hl-0">    },</span><br /><span class="hl-0">    \{</span><br /><span class="hl-0">      </span><span class="hl-1">"role"</span><span class="hl-0">: </span><span class="hl-2">"assistant"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"content"</span><span class="hl-0">: \[</span><br /><span class="hl-0">        \{</span><br /><span class="hl-0">          </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"tool\_use"</span><span class="hl-0">,</span><br /><span class="hl-0">          </span><span class="hl-1">"id"</span><span class="hl-0">: </span><span class="hl-2">"call\_abc123"</span><span class="hl-0">,</span><br /><span class="hl-0">          </span><span class="hl-1">"name"</span><span class="hl-0">: </span><span class="hl-2">"get\_weather"</span><span class="hl-0">,</span><br /><span class="hl-0">          </span><span class="hl-1">"input"</span><span class="hl-0">: \{ </span><span class="hl-1">"city"</span><span class="hl-0">: </span><span class="hl-2">"Paris"</span><span class="hl-0"> }</span><br /><span class="hl-0">        },</span><br /><span class="hl-0">        \{</span><br /><span class="hl-0">          </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"tool\_use"</span><span class="hl-0">,</span><br /><span class="hl-0">          </span><span class="hl-1">"id"</span><span class="hl-0">: </span><span class="hl-2">"call\_def456"</span><span class="hl-0">,</span><br /><span class="hl-0">          </span><span class="hl-1">"name"</span><span class="hl-0">: </span><span class="hl-2">"get\_weather"</span><span class="hl-0">,</span><br /><span class="hl-0">          </span><span class="hl-1">"input"</span><span class="hl-0">: \{ </span><span class="hl-1">"city"</span><span class="hl-0">: </span><span class="hl-2">"London"</span><span class="hl-0"> }</span><br /><span class="hl-0">        }</span><br /><span class="hl-0">      ]</span><br /><span class="hl-0">    },</span><br /><span class="hl-0">    \{</span><br /><span class="hl-0">      </span><span class="hl-1">"role"</span><span class="hl-0">: </span><span class="hl-2">"user"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"content"</span><span class="hl-0">: \[</span><br /><span class="hl-0">        \{</span><br /><span class="hl-0">          </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"tool\_result"</span><span class="hl-0">,</span><br /><span class="hl-0">          </span><span class="hl-1">"toolUseId"</span><span class="hl-0">: </span><span class="hl-2">"call\_abc123"</span><span class="hl-0">,</span><br /><span class="hl-0">          </span><span class="hl-1">"content"</span><span class="hl-0">: \[</span><br /><span class="hl-0">            \{</span><br /><span class="hl-0">              </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"text"</span><span class="hl-0">,</span><br /><span class="hl-0">              </span><span class="hl-1">"text"</span><span class="hl-0">: </span><span class="hl-2">"Weather in Paris: 18°C, partly cloudy"</span><br /><span class="hl-0">            }</span><br /><span class="hl-0">          ]</span><br /><span class="hl-0">        },</span><br /><span class="hl-0">        \{</span><br /><span class="hl-0">          </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"tool\_result"</span><span class="hl-0">,</span><br /><span class="hl-0">          </span><span class="hl-1">"toolUseId"</span><span class="hl-0">: </span><span class="hl-2">"call\_def456"</span><span class="hl-0">,</span><br /><span class="hl-0">          </span><span class="hl-1">"content"</span><span class="hl-0">: \[</span><br /><span class="hl-0">            \{</span><br /><span class="hl-0">              </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"text"</span><span class="hl-0">,</span><br /><span class="hl-0">              </span><span class="hl-1">"text"</span><span class="hl-0">: </span><span class="hl-2">"Weather in London: 15°C, rainy"</span><br /><span class="hl-0">            }</span><br /><span class="hl-0">          ]</span><br /><span class="hl-0">        }</span><br /><span class="hl-0">      ]</span><br /><span class="hl-0">    }</span><br /><span class="hl-0">  ],</span><br /><span class="hl-0">  </span><span class="hl-1">"tools"</span><span class="hl-0">: \[</span><br /><span class="hl-0">    \{</span><br /><span class="hl-0">      </span><span class="hl-1">"name"</span><span class="hl-0">: </span><span class="hl-2">"get\_weather"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"description"</span><span class="hl-0">: </span><span class="hl-2">"Get current weather for a city"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"inputSchema"</span><span class="hl-0">: \{</span><br /><span class="hl-0">        </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"object"</span><span class="hl-0">,</span><br /><span class="hl-0">        </span><span class="hl-1">"properties"</span><span class="hl-0">: \{</span><br /><span class="hl-0">          </span><span class="hl-1">"city"</span><span class="hl-0">: \{ </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"string"</span><span class="hl-0"> }</span><br /><span class="hl-0">        },</span><br /><span class="hl-0">        </span><span class="hl-1">"required"</span><span class="hl-0">: \[</span><span class="hl-2">"city"</span><span class="hl-0">]</span><br /><span class="hl-0">      }</span><br /><span class="hl-0">    }</span><br /><span class="hl-0">  ],</span><br /><span class="hl-0">  </span><span class="hl-1">"maxTokens"</span><span class="hl-0">: </span><span class="hl-3">1000</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details><div class="tsd-tag-deprecated"><div class="tsd-anchor-link" data-typedoc-h="4">Deprecated</div><p>Deprecated as of protocol version 2026-07-28 (SEP-2577).
  Remains in the specification for at least twelve months; see the
  deprecated features registry.</p> </div></div><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="createmessagerequestparams-messages" data-typedoc-h="3"><span class="deprecated">messages: SamplingMessage\[]</span><a href="#createmessagerequestparams-messages" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="createmessagerequestparams-modelpreferences" data-typedoc-h="3"><span class="deprecated">modelPreferences?: ModelPreferences</span><a href="#createmessagerequestparams-modelpreferences" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>The server's preferences for which model to select. The client MAY ignore these preferences.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="createmessagerequestparams-systemprompt" data-typedoc-h="3"><span class="deprecated">systemPrompt?: string</span><a href="#createmessagerequestparams-systemprompt" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>An optional system prompt the server wants to use for sampling. The client MAY modify or omit this prompt.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="createmessagerequestparams-includecontext" data-typedoc-h="3"><span class="deprecated">includeContext?: "none" | "thisServer" | "allServers"</span><a href="#createmessagerequestparams-includecontext" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><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 <code>"none"</code>. The values <code>"thisServer"</code> and <code>"allServers"</code> are deprecated (SEP-2596): servers SHOULD
  omit this field or use <code>"none"</code>, and SHOULD only use the deprecated values if the client declares <a href="#clientcapabilities-sampling" class="tsd-kind-property">ClientCapabilities.sampling.context</a>.</p> </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><div class="tsd-anchor-link" data-typedoc-h="4">Deprecated</div><p>The <code>"thisServer"</code> and <code>"allServers"</code> values are deprecated as of protocol version 2025-11-25
  (SEP-2596) and will be removed no later than the Sampling feature itself (SEP-2577). Omit this field or use <code>"none"</code>.</p> </div></div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="createmessagerequestparams-temperature" data-typedoc-h="3"><span class="deprecated">temperature?: number</span><a href="#createmessagerequestparams-temperature" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="createmessagerequestparams-maxtokens" data-typedoc-h="3"><span class="deprecated">maxTokens: number</span><a href="#createmessagerequestparams-maxtokens" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><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 class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="createmessagerequestparams-stopsequences" data-typedoc-h="3"><span class="deprecated">stopSequences?: string\[]</span><a href="#createmessagerequestparams-stopsequences" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="createmessagerequestparams-metadata" data-typedoc-h="3"><span class="deprecated">metadata?: JSONObject</span><a href="#createmessagerequestparams-metadata" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Optional metadata to pass through to the LLM provider. The format of this metadata is provider-specific.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="createmessagerequestparams-tools" data-typedoc-h="3"><span class="deprecated">tools?: Tool\[]</span><a href="#createmessagerequestparams-tools" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Tools that the model may use during generation.
  The client MUST return an error if this field is provided but <a href="#clientcapabilities-sampling" class="tsd-kind-property">ClientCapabilities.sampling.tools</a> is not declared.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="createmessagerequestparams-toolchoice" data-typedoc-h="3"><span class="deprecated">toolChoice?: ToolChoice</span><a href="#createmessagerequestparams-toolchoice" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Controls how the model uses tools.
  The client MUST return an error if this field is provided but <a href="#clientcapabilities-sampling" class="tsd-kind-property">ClientCapabilities.sampling.tools</a> is not declared.
  Default is <code>\{ mode: "auto" }</code>.</p> </div></section>
</div>

<div class="type">
  ### `CreateMessageResult`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">CreateMessageResult</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#createmessageresult-model">model</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#createmessageresult-stopreason">stopReason</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#createmessageresult-role">role</a><span class="tsd-signature-symbol">:</span> <a href="#role" class="tsd-signature-type tsd-kind-type-alias">Role</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#createmessageresult-content">content</a><span class="tsd-signature-symbol">:</span> <a href="#samplingmessagecontentblock" class="tsd-signature-type tsd-kind-type-alias">SamplingMessageContentBlock</a> <span class="tsd-signature-symbol">|</span> <a href="#samplingmessagecontentblock" class="tsd-signature-type tsd-kind-type-alias">SamplingMessageContentBlock</a><span class="tsd-signature-symbol">\[]</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#createmessageresult-_meta">\_meta</a><span class="tsd-signature-symbol">?:</span> <a href="#metaobject" class="tsd-signature-type tsd-kind-type-alias">MetaObject</a><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>The result returned by the client for a <a href="#createmessagerequest" class="tsd-kind-interface">sampling/createMessage</a> request.
  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><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Text response<a href="#createmessageresult-example-text-response" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="createmessageresult-example-text-response"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"role"</span><span class="hl-0">: </span><span class="hl-2">"assistant"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"content"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"text"</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"text"</span><span class="hl-0">: </span><span class="hl-2">"The capital of France is Paris."</span><br /><span class="hl-0">  },</span><br /><span class="hl-0">  </span><span class="hl-1">"model"</span><span class="hl-0">: </span><span class="hl-2">"claude-3-sonnet-20240307"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"stopReason"</span><span class="hl-0">: </span><span class="hl-2">"endTurn"</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Tool use response<a href="#createmessageresult-example-tool-use-response" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="createmessageresult-example-tool-use-response"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"role"</span><span class="hl-0">: </span><span class="hl-2">"assistant"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"content"</span><span class="hl-0">: \[</span><br /><span class="hl-0">    \{</span><br /><span class="hl-0">      </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"tool\_use"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"id"</span><span class="hl-0">: </span><span class="hl-2">"call\_abc123"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"name"</span><span class="hl-0">: </span><span class="hl-2">"get\_weather"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"input"</span><span class="hl-0">: \{</span><br /><span class="hl-0">        </span><span class="hl-1">"city"</span><span class="hl-0">: </span><span class="hl-2">"Paris"</span><br /><span class="hl-0">      }</span><br /><span class="hl-0">    },</span><br /><span class="hl-0">    \{</span><br /><span class="hl-0">      </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"tool\_use"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"id"</span><span class="hl-0">: </span><span class="hl-2">"call\_def456"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"name"</span><span class="hl-0">: </span><span class="hl-2">"get\_weather"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"input"</span><span class="hl-0">: \{</span><br /><span class="hl-0">        </span><span class="hl-1">"city"</span><span class="hl-0">: </span><span class="hl-2">"London"</span><br /><span class="hl-0">      }</span><br /><span class="hl-0">    }</span><br /><span class="hl-0">  ],</span><br /><span class="hl-0">  </span><span class="hl-1">"model"</span><span class="hl-0">: </span><span class="hl-2">"claude-3-sonnet-20240307"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"stopReason"</span><span class="hl-0">: </span><span class="hl-2">"toolUse"</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Final response after tool use<a href="#createmessageresult-example-final-response-after-tool-use" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="createmessageresult-example-final-response-after-tool-use"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"role"</span><span class="hl-0">: </span><span class="hl-2">"assistant"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"content"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"text"</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"text"</span><span class="hl-0">: </span><span class="hl-2">"Based on the current weather data:</span><span class="hl-4">\n\n</span><span class="hl-2">- \*\*Paris\*\*: 18°C and partly cloudy - quite pleasant!</span><span class="hl-4">\n</span><span class="hl-2">- \*\*London\*\*: 15°C and rainy - you'll want an umbrella.</span><span class="hl-4">\n\n</span><span class="hl-2">Paris has slightly warmer and drier conditions today."</span><br /><span class="hl-0">  },</span><br /><span class="hl-0">  </span><span class="hl-1">"model"</span><span class="hl-0">: </span><span class="hl-2">"claude-3-sonnet-20240307"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"stopReason"</span><span class="hl-0">: </span><span class="hl-2">"endTurn"</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details><div class="tsd-tag-deprecated"><div class="tsd-anchor-link" data-typedoc-h="4">Deprecated</div><p>Deprecated as of protocol version 2026-07-28 (SEP-2577).
  Remains in the specification for at least twelve months; see the
  deprecated features registry.</p> </div></div><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="createmessageresult-model" data-typedoc-h="3"><span class="deprecated">model: string</span><a href="#createmessageresult-model" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>The name of the model that generated the message.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="createmessageresult-stopreason" data-typedoc-h="3"><span class="deprecated">stopReason?: string</span><a href="#createmessageresult-stopreason" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>The reason why sampling stopped, if known.</p> <p>Standard values:</p> <ul> <li><code>"endTurn"</code>: Natural end of the assistant's turn</li> <li><code>"stopSequence"</code>: A stop sequence was encountered</li> <li><code>"maxTokens"</code>: Maximum token limit was reached</li> <li><code>"toolUse"</code>: 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 class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="createmessageresult-role" data-typedoc-h="3"><span class="deprecated">role: Role</span><a href="#createmessageresult-role" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#samplingmessage">SamplingMessage</a>.<a href="#samplingmessage-role">role</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="createmessageresult-content" data-typedoc-h="3"><span class="deprecated">content: SamplingMessageContentBlock | SamplingMessageContentBlock\[]</span><a href="#createmessageresult-content" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#samplingmessage">SamplingMessage</a>.<a href="#samplingmessage-content">content</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="createmessageresult-_meta" data-typedoc-h="3"><span class="deprecated">\_meta?: MetaObject</span><a href="#createmessageresult-_meta" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#samplingmessage">SamplingMessage</a>.<a href="#samplingmessage-_meta">\_meta</a></p></aside></section>
</div>

<div class="type">
  ### `ModelHint`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ModelHint</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#modelhint-name">name</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><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><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><div class="tsd-anchor-link" data-typedoc-h="4">Deprecated</div><p>Deprecated as of protocol version 2026-07-28 (SEP-2577).
  Remains in the specification for at least twelve months; see the
  deprecated features registry.</p> </div></div><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="modelhint-name" data-typedoc-h="3"><span class="deprecated">name?: string</span><a href="#modelhint-name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><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 class="type">
  ### `ModelPreferences`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ModelPreferences</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#modelpreferences-hints">hints</a><span class="tsd-signature-symbol">?:</span> <a href="#modelhint" class="tsd-signature-type tsd-kind-interface">ModelHint</a><span class="tsd-signature-symbol">\[]</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#modelpreferences-costpriority">costPriority</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#modelpreferences-speedpriority">speedPriority</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#modelpreferences-intelligencepriority">intelligencePriority</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><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><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: With hints and priorities<a href="#modelpreferences-example-with-hints-and-priorities" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="modelpreferences-example-with-hints-and-priorities"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"hints"</span><span class="hl-0">: \[</span><br /><span class="hl-0">    \{ </span><span class="hl-1">"name"</span><span class="hl-0">: </span><span class="hl-2">"claude-3-sonnet"</span><span class="hl-0"> },</span><br /><span class="hl-0">    \{ </span><span class="hl-1">"name"</span><span class="hl-0">: </span><span class="hl-2">"claude"</span><span class="hl-0"> }</span><br /><span class="hl-0">  ],</span><br /><span class="hl-0">  </span><span class="hl-1">"costPriority"</span><span class="hl-0">: </span><span class="hl-3">0.3</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"speedPriority"</span><span class="hl-0">: </span><span class="hl-3">0.8</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"intelligencePriority"</span><span class="hl-0">: </span><span class="hl-3">0.5</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details><div class="tsd-tag-deprecated"><div class="tsd-anchor-link" data-typedoc-h="4">Deprecated</div><p>Deprecated as of protocol version 2026-07-28 (SEP-2577).
  Remains in the specification for at least twelve months; see the
  deprecated features registry.</p> </div></div><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="modelpreferences-hints" data-typedoc-h="3"><span class="deprecated">hints?: ModelHint\[]</span><a href="#modelpreferences-hints" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><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 class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="modelpreferences-costpriority" data-typedoc-h="3"><span class="deprecated">costPriority?: number</span><a href="#modelpreferences-costpriority" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><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 class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="modelpreferences-speedpriority" data-typedoc-h="3"><span class="deprecated">speedPriority?: number</span><a href="#modelpreferences-speedpriority" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><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 class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="modelpreferences-intelligencepriority" data-typedoc-h="3"><span class="deprecated">intelligencePriority?: number</span><a href="#modelpreferences-intelligencepriority" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><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 class="type">
  ### `SamplingMessage`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">SamplingMessage</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#samplingmessage-role">role</a><span class="tsd-signature-symbol">:</span> <a href="#role" class="tsd-signature-type tsd-kind-type-alias">Role</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#samplingmessage-content">content</a><span class="tsd-signature-symbol">:</span> <a href="#samplingmessagecontentblock" class="tsd-signature-type tsd-kind-type-alias">SamplingMessageContentBlock</a> <span class="tsd-signature-symbol">|</span> <a href="#samplingmessagecontentblock" class="tsd-signature-type tsd-kind-type-alias">SamplingMessageContentBlock</a><span class="tsd-signature-symbol">\[]</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#samplingmessage-_meta">\_meta</a><span class="tsd-signature-symbol">?:</span> <a href="#metaobject" class="tsd-signature-type tsd-kind-type-alias">MetaObject</a><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Describes a message issued to or received from an LLM API.</p> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Single content block<a href="#samplingmessage-example-single-content-block" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="samplingmessage-example-single-content-block"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"role"</span><span class="hl-0">: </span><span class="hl-2">"user"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"content"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"text"</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"text"</span><span class="hl-0">: </span><span class="hl-2">"What is the capital of France?"</span><br /><span class="hl-0">  }</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Multiple content blocks<a href="#samplingmessage-example-multiple-content-blocks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="samplingmessage-example-multiple-content-blocks"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"role"</span><span class="hl-0">: </span><span class="hl-2">"user"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"content"</span><span class="hl-0">: \[</span><br /><span class="hl-0">    \{</span><br /><span class="hl-0">      </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"tool\_result"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"toolUseId"</span><span class="hl-0">: </span><span class="hl-2">"call\_123"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"content"</span><span class="hl-0">: \[\{ </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"text"</span><span class="hl-0">, </span><span class="hl-1">"text"</span><span class="hl-0">: </span><span class="hl-2">"Result 1"</span><span class="hl-0"> }]</span><br /><span class="hl-0">    },</span><br /><span class="hl-0">    \{</span><br /><span class="hl-0">      </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"tool\_result"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"toolUseId"</span><span class="hl-0">: </span><span class="hl-2">"call\_456"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"content"</span><span class="hl-0">: \[\{ </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"text"</span><span class="hl-0">, </span><span class="hl-1">"text"</span><span class="hl-0">: </span><span class="hl-2">"Result 2"</span><span class="hl-0"> }]</span><br /><span class="hl-0">    }</span><br /><span class="hl-0">  ]</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details><div class="tsd-tag-deprecated"><div class="tsd-anchor-link" data-typedoc-h="4">Deprecated</div><p>Deprecated as of protocol version 2026-07-28 (SEP-2577).
  Remains in the specification for at least twelve months; see the
  deprecated features registry.</p> </div></div><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="samplingmessage-role" data-typedoc-h="3"><span class="deprecated">role: Role</span><a href="#samplingmessage-role" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="samplingmessage-content" data-typedoc-h="3"><span class="deprecated">content: SamplingMessageContentBlock | SamplingMessageContentBlock\[]</span><a href="#samplingmessage-content" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="samplingmessage-_meta" data-typedoc-h="3"><span class="deprecated">\_meta?: MetaObject</span><a href="#samplingmessage-_meta" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section>
</div>

<div class="type">
  ### `SamplingMessageContentBlock`

  <div class="tsd-signature"><span class="tsd-kind-type-alias">SamplingMessageContentBlock</span><span class="tsd-signature-symbol">:</span><br />  <span class="tsd-signature-symbol">|</span> <a href="#textcontent" class="tsd-signature-type tsd-kind-interface">TextContent</a><br />  <span class="tsd-signature-symbol">|</span> <a href="#imagecontent" class="tsd-signature-type tsd-kind-interface">ImageContent</a><br />  <span class="tsd-signature-symbol">|</span> <a href="#audiocontent" class="tsd-signature-type tsd-kind-interface">AudioContent</a><br />  <span class="tsd-signature-symbol">|</span> <a href="#toolusecontent" class="tsd-signature-type tsd-kind-interface">ToolUseContent</a><br />  <span class="tsd-signature-symbol">|</span> <a href="#toolresultcontent" class="tsd-signature-type tsd-kind-interface">ToolResultContent</a></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><div class="tsd-anchor-link" data-typedoc-h="4">Deprecated</div><p>Deprecated as of protocol version 2026-07-28 (SEP-2577).
  Remains in the specification for at least twelve months; see the
  deprecated features registry.</p> </div></div>
</div>

<div class="type">
  ### `ToolChoice`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ToolChoice</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#toolchoice-mode">mode</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"none"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"required"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"auto"</span><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Controls tool selection behavior for sampling requests.</p> </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><div class="tsd-anchor-link" data-typedoc-h="4">Deprecated</div><p>Deprecated as of protocol version 2026-07-28 (SEP-2577).
  Remains in the specification for at least twelve months; see the
  deprecated features registry.</p> </div></div><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="toolchoice-mode" data-typedoc-h="3"><span class="deprecated">mode?: "none" | "required" | "auto"</span><a href="#toolchoice-mode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Controls the tool use ability of the model:</p> <ul> <li><code>"auto"</code>: Model decides whether to use tools (default)</li> <li><code>"required"</code>: Model MUST use at least one tool before completing</li> <li><code>"none"</code>: Model MUST NOT use any tools</li> </ul> </div></section>
</div>

<div class="type">
  ### `ToolResultContent`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ToolResultContent</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#toolresultcontent-type">type</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"tool\_result"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#toolresultcontent-tooluseid">toolUseId</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#toolresultcontent-content">content</a><span class="tsd-signature-symbol">:</span> <a href="#contentblock" class="tsd-signature-type tsd-kind-type-alias">ContentBlock</a><span class="tsd-signature-symbol">\[]</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#toolresultcontent-structuredcontent">structuredContent</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#toolresultcontent-iserror">isError</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#toolresultcontent-_meta">\_meta</a><span class="tsd-signature-symbol">?:</span> <a href="#metaobject" class="tsd-signature-type tsd-kind-type-alias">MetaObject</a><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>The result of a tool use, provided by the user back to the assistant.</p> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: \`get\_weather\` tool result<a href="#toolresultcontent-example-get_weather-tool-result" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="toolresultcontent-example-get_weather-tool-result"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"tool\_result"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"toolUseId"</span><span class="hl-0">: </span><span class="hl-2">"call\_abc123"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"content"</span><span class="hl-0">: \[</span><br /><span class="hl-0">    \{</span><br /><span class="hl-0">      </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"text"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"text"</span><span class="hl-0">: </span><span class="hl-2">"Weather in Paris: 18°C, partly cloudy"</span><br /><span class="hl-0">    }</span><br /><span class="hl-0">  ]</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details><div class="tsd-tag-deprecated"><div class="tsd-anchor-link" data-typedoc-h="4">Deprecated</div><p>Deprecated as of protocol version 2026-07-28 (SEP-2577).
  Remains in the specification for at least twelve months; see the
  deprecated features registry.</p> </div></div><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="toolresultcontent-type" data-typedoc-h="3"><span class="deprecated">type: "tool\_result"</span><a href="#toolresultcontent-type" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="toolresultcontent-tooluseid" data-typedoc-h="3"><span class="deprecated">toolUseId: string</span><a href="#toolresultcontent-tooluseid" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>The ID of the tool use this result corresponds to.</p> <p>This MUST match the ID from a previous <a href="#toolusecontent" class="tsd-kind-interface">ToolUseContent</a>.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="toolresultcontent-content" data-typedoc-h="3"><span class="deprecated">content: ContentBlock\[]</span><a href="#toolresultcontent-content" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>The unstructured result content of the tool use.</p> <p>This has the same format as <a href="#calltoolresult-content" class="tsd-kind-property">CallToolResult.content</a> and can include text, images,
  audio, resource links, and embedded resources.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="toolresultcontent-structuredcontent" data-typedoc-h="3"><span class="deprecated">structuredContent?: unknown</span><a href="#toolresultcontent-structuredcontent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>An optional structured result value.</p> <p>This can be any JSON value (object, array, string, number, boolean, or null).
  If the tool defined an <a href="#tool-outputschema" class="tsd-kind-property">Tool.outputSchema</a>, this SHOULD conform to that schema.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="toolresultcontent-iserror" data-typedoc-h="3"><span class="deprecated">isError?: boolean</span><a href="#toolresultcontent-iserror" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><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 class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="toolresultcontent-_meta" data-typedoc-h="3"><span class="deprecated">\_meta?: MetaObject</span><a href="#toolresultcontent-_meta" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><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> </div></section>
</div>

<div class="type">
  ### `ToolUseContent`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ToolUseContent</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#toolusecontent-type">type</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"tool\_use"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#toolusecontent-id">id</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#toolusecontent-name">name</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#toolusecontent-input">input</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">\{</span> <span class="tsd-signature-symbol">\[</span><span class="tsd-kind-index-signature">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <span class="tsd-signature-type">unknown</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#toolusecontent-_meta">\_meta</a><span class="tsd-signature-symbol">?:</span> <a href="#metaobject" class="tsd-signature-type tsd-kind-type-alias">MetaObject</a><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>A request from the assistant to call a tool.</p> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: \`get\_weather\` tool use<a href="#toolusecontent-example-get_weather-tool-use" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="toolusecontent-example-get_weather-tool-use"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"tool\_use"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"id"</span><span class="hl-0">: </span><span class="hl-2">"call\_abc123"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"name"</span><span class="hl-0">: </span><span class="hl-2">"get\_weather"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"input"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"city"</span><span class="hl-0">: </span><span class="hl-2">"Paris"</span><br /><span class="hl-0">  }</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details><div class="tsd-tag-deprecated"><div class="tsd-anchor-link" data-typedoc-h="4">Deprecated</div><p>Deprecated as of protocol version 2026-07-28 (SEP-2577).
  Remains in the specification for at least twelve months; see the
  deprecated features registry.</p> </div></div><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="toolusecontent-type" data-typedoc-h="3"><span class="deprecated">type: "tool\_use"</span><a href="#toolusecontent-type" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="toolusecontent-id" data-typedoc-h="3"><span class="deprecated">id: string</span><a href="#toolusecontent-id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><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 class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="toolusecontent-name" data-typedoc-h="3"><span class="deprecated">name: string</span><a href="#toolusecontent-name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>The name of the tool to call.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="toolusecontent-input" data-typedoc-h="3"><span class="deprecated">input: \{ \[key: string]: unknown }</span><a href="#toolusecontent-input" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>The arguments to pass to the tool, conforming to the tool's input schema.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="toolusecontent-_meta" data-typedoc-h="3"><span class="deprecated">\_meta?: MetaObject</span><a href="#toolusecontent-_meta" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><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> </div></section>
</div>

## `server/discover`

<div class="type">
  ### `DiscoverRequest`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">DiscoverRequest</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#discoverrequest-jsonrpc">jsonrpc</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"2.0"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#discoverrequest-id">id</a><span class="tsd-signature-symbol">:</span> <a href="#requestid" class="tsd-signature-type tsd-kind-type-alias">RequestId</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#discoverrequest-method">method</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"server/discover"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#discoverrequest-params">params</a><span class="tsd-signature-symbol">:</span> <a href="#requestparams" class="tsd-signature-type tsd-kind-interface">RequestParams</a><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>A request from the client asking the server to advertise its supported
  protocol versions, capabilities, and other metadata. Servers <strong>MUST</strong>
  implement <code>server/discover</code>. Clients <strong>MAY</strong> call it but are not required
  to — version negotiation can also happen inline via per-request <code>\_meta</code>.</p> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Discover request<a href="#discoverrequest-example-discover-request" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="discoverrequest-example-discover-request"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"jsonrpc"</span><span class="hl-0">: </span><span class="hl-2">"2.0"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"id"</span><span class="hl-0">: </span><span class="hl-2">"discover-1"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"method"</span><span class="hl-0">: </span><span class="hl-2">"server/discover"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"params"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"\_meta"</span><span class="hl-0">: \{</span><br /><span class="hl-0">      </span><span class="hl-1">"io.modelcontextprotocol/protocolVersion"</span><span class="hl-0">: </span><span class="hl-2">"2026-07-28"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"io.modelcontextprotocol/clientInfo"</span><span class="hl-0">: \{</span><br /><span class="hl-0">        </span><span class="hl-1">"name"</span><span class="hl-0">: </span><span class="hl-2">"ExampleClient"</span><span class="hl-0">,</span><br /><span class="hl-0">        </span><span class="hl-1">"version"</span><span class="hl-0">: </span><span class="hl-2">"1.0.0"</span><br /><span class="hl-0">      },</span><br /><span class="hl-0">      </span><span class="hl-1">"io.modelcontextprotocol/clientCapabilities"</span><span class="hl-0">: \{}</span><br /><span class="hl-0">    }</span><br /><span class="hl-0">  }</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="discoverrequest-jsonrpc" data-typedoc-h="3"><span>jsonrpc: "2.0"</span><a href="#discoverrequest-jsonrpc" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-jsonrpc">jsonrpc</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="discoverrequest-id" data-typedoc-h="3"><span>id: RequestId</span><a href="#discoverrequest-id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-id">id</a></p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="discoverrequest-method" data-typedoc-h="3"><span>method: "server/discover"</span><a href="#discoverrequest-method" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Overrides <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-method">method</a></p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="discoverrequest-params" data-typedoc-h="3"><span>params: RequestParams</span><a href="#discoverrequest-params" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Overrides <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-params">params</a></p></aside></section>
</div>

<div class="type">
  ### `DiscoverResultResponse`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">DiscoverResultResponse</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#discoverresultresponse-jsonrpc">jsonrpc</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"2.0"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#discoverresultresponse-id">id</a><span class="tsd-signature-symbol">:</span> <a href="#requestid" class="tsd-signature-type tsd-kind-type-alias">RequestId</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#discoverresultresponse-result">result</a><span class="tsd-signature-symbol">:</span> <a href="#discoverresult" class="tsd-signature-type tsd-kind-interface">DiscoverResult</a><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>A successful response from the server for a <a href="#discoverrequest" class="tsd-kind-interface">server/discover</a> request.</p> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Discover result response<a href="#discoverresultresponse-example-discover-result-response" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="discoverresultresponse-example-discover-result-response"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"jsonrpc"</span><span class="hl-0">: </span><span class="hl-2">"2.0"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"id"</span><span class="hl-0">: </span><span class="hl-2">"discover-1"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"result"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"resultType"</span><span class="hl-0">: </span><span class="hl-2">"complete"</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"supportedVersions"</span><span class="hl-0">: \[</span><span class="hl-2">"2026-07-28"</span><span class="hl-0">],</span><br /><span class="hl-0">    </span><span class="hl-1">"capabilities"</span><span class="hl-0">: \{</span><br /><span class="hl-0">      </span><span class="hl-1">"tools"</span><span class="hl-0">: \{},</span><br /><span class="hl-0">      </span><span class="hl-1">"resources"</span><span class="hl-0">: \{}</span><br /><span class="hl-0">    },</span><br /><span class="hl-0">    </span><span class="hl-1">"serverInfo"</span><span class="hl-0">: \{</span><br /><span class="hl-0">      </span><span class="hl-1">"name"</span><span class="hl-0">: </span><span class="hl-2">"ExampleServer"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"version"</span><span class="hl-0">: </span><span class="hl-2">"1.0.0"</span><br /><span class="hl-0">    },</span><br /><span class="hl-0">    </span><span class="hl-1">"ttlMs"</span><span class="hl-0">: </span><span class="hl-3">3600000</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"cacheScope"</span><span class="hl-0">: </span><span class="hl-2">"public"</span><br /><span class="hl-0">  }</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="discoverresultresponse-jsonrpc" data-typedoc-h="3"><span>jsonrpc: "2.0"</span><a href="#discoverresultresponse-jsonrpc" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#jsonrpcresultresponse">JSONRPCResultResponse</a>.<a href="#jsonrpcresultresponse-jsonrpc">jsonrpc</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="discoverresultresponse-id" data-typedoc-h="3"><span>id: RequestId</span><a href="#discoverresultresponse-id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#jsonrpcresultresponse">JSONRPCResultResponse</a>.<a href="#jsonrpcresultresponse-id">id</a></p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="discoverresultresponse-result" data-typedoc-h="3"><span>result: DiscoverResult</span><a href="#discoverresultresponse-result" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Overrides <a href="#jsonrpcresultresponse">JSONRPCResultResponse</a>.<a href="#jsonrpcresultresponse-result">result</a></p></aside></section>
</div>

<div class="type">
  ### `DiscoverResult`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">DiscoverResult</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#discoverresult-_meta">\_meta</a><span class="tsd-signature-symbol">?:</span> <a href="#metaobject" class="tsd-signature-type tsd-kind-type-alias">MetaObject</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#discoverresult-resulttype">resultType</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#discoverresult-supportedversions">supportedVersions</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">\[]</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#discoverresult-capabilities">capabilities</a><span class="tsd-signature-symbol">:</span> <a href="#servercapabilities" class="tsd-signature-type tsd-kind-interface">ServerCapabilities</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#discoverresult-serverinfo">serverInfo</a><span class="tsd-signature-symbol">:</span> <a href="#implementation" class="tsd-signature-type tsd-kind-interface">Implementation</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#discoverresult-instructions">instructions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#discoverresult-ttlms">ttlMs</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#discoverresult-cachescope">cacheScope</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"public"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"private"</span><span class="tsd-signature-symbol">;</span><br />  <span class="tsd-signature-symbol">\[</span><span class="tsd-kind-index-signature">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>The result returned by the server for a <a href="#discoverrequest" class="tsd-kind-interface">server/discover</a> request.</p> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Server capabilities discovery<a href="#discoverresult-example-server-capabilities-discovery" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="discoverresult-example-server-capabilities-discovery"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"resultType"</span><span class="hl-0">: </span><span class="hl-2">"complete"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"supportedVersions"</span><span class="hl-0">: \[</span><span class="hl-2">"2026-07-28"</span><span class="hl-0">],</span><br /><span class="hl-0">  </span><span class="hl-1">"capabilities"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"tools"</span><span class="hl-0">: \{},</span><br /><span class="hl-0">    </span><span class="hl-1">"resources"</span><span class="hl-0">: \{}</span><br /><span class="hl-0">  },</span><br /><span class="hl-0">  </span><span class="hl-1">"serverInfo"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"name"</span><span class="hl-0">: </span><span class="hl-2">"ExampleServer"</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"version"</span><span class="hl-0">: </span><span class="hl-2">"1.0.0"</span><br /><span class="hl-0">  },</span><br /><span class="hl-0">  </span><span class="hl-1">"instructions"</span><span class="hl-0">: </span><span class="hl-2">"This server provides weather and resource utilities. Prefer \`get\_weather\` for forecast lookups."</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"ttlMs"</span><span class="hl-0">: </span><span class="hl-3">3600000</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"cacheScope"</span><span class="hl-0">: </span><span class="hl-2">"public"</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="discoverresult-_meta" data-typedoc-h="3"><span>\_meta?: MetaObject</span><a href="#discoverresult-_meta" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from CacheableResult.\_meta</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="discoverresult-resulttype" data-typedoc-h="3"><span>resultType: string</span><a href="#discoverresult-resulttype" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Indicates the type of the result, which allows the client to determine
  how to parse the result object.</p> <p>Servers implementing this protocol version MUST include this field.
  For backward compatibility, when a client receives a result from a
  server implementing an earlier protocol version (which does not include <code>resultType</code>), the client MUST treat the absent field as <code>"complete"</code>.</p> </div><aside class="tsd-sources"><p>Inherited from CacheableResult.resultType</p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="discoverresult-supportedversions" data-typedoc-h="3"><span>supportedVersions: string\[]</span><a href="#discoverresult-supportedversions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>MCP Protocol Versions this server supports. The client should choose a
  version from this list for use in subsequent requests.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="discoverresult-capabilities" data-typedoc-h="3"><span>capabilities: ServerCapabilities</span><a href="#discoverresult-capabilities" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>The capabilities of the server.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="discoverresult-serverinfo" data-typedoc-h="3"><span>serverInfo: Implementation</span><a href="#discoverresult-serverinfo" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Information about the server software implementation.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="discoverresult-instructions" data-typedoc-h="3"><span>instructions?: string</span><a href="#discoverresult-instructions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Natural-language guidance describing the server and its features.</p> <p>This can be used by clients to improve an LLM's understanding of
  available tools (e.g., by including it in a system prompt). It should
  focus on information that helps the model use the server effectively
  and should not duplicate information already in tool descriptions.</p> </div></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="discoverresult-ttlms" data-typedoc-h="3"><span>ttlMs: number</span><a href="#discoverresult-ttlms" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>A hint from the server indicating how long (in milliseconds) the
  client MAY cache this response before re-fetching. Semantics are
  analogous to HTTP Cache-Control max-age.</p> <ul> <li>If 0, The response SHOULD be considered immediately stale,
  The client MAY re-fetch every time the result is needed.</li> <li>If positive, the client SHOULD consider the result fresh for this many
  milliseconds after receiving the response.</li> </ul> </div><aside class="tsd-sources"><p>Inherited from CacheableResult.ttlMs</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="discoverresult-cachescope" data-typedoc-h="3"><span>cacheScope: "public" | "private"</span><a href="#discoverresult-cachescope" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Indicates the intended scope of the cached response, analogous to HTTP <code>Cache-Control: public</code> vs <code>Cache-Control: private</code>.</p> <ul> <li><code>"public"</code>: Any client or intermediary (e.g., shared gateway, proxy)
  MAY cache the response and serve it to any user.</li> <li><code>"private"</code>: Only the requesting user's client MAY cache the response.
  Shared caches (e.g., multi-tenant gateways) MUST NOT serve a cached
  copy to a different user.</li> </ul> </div><aside class="tsd-sources"><p>Inherited from CacheableResult.cacheScope</p></aside></section>
</div>

<div class="type">
  ### `ClientCapabilities`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ClientCapabilities</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#clientcapabilities-experimental">experimental</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">\{</span> <span class="tsd-signature-symbol">\[</span><span class="tsd-kind-index-signature">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <a href="#jsonobject" class="tsd-signature-type tsd-kind-type-alias">JSONObject</a> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#clientcapabilities-roots">roots</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">\{}</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#clientcapabilities-sampling">sampling</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">\{</span> <span class="tsd-kind-property">context</span><span class="tsd-signature-symbol">?:</span> <a href="#jsonobject" class="tsd-signature-type tsd-kind-type-alias">JSONObject</a><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">tools</span><span class="tsd-signature-symbol">?:</span> <a href="#jsonobject" class="tsd-signature-type tsd-kind-type-alias">JSONObject</a> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#clientcapabilities-elicitation">elicitation</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">\{</span> <span class="tsd-kind-property">form</span><span class="tsd-signature-symbol">?:</span> <a href="#jsonobject" class="tsd-signature-type tsd-kind-type-alias">JSONObject</a><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">url</span><span class="tsd-signature-symbol">?:</span> <a href="#jsonobject" class="tsd-signature-type tsd-kind-type-alias">JSONObject</a> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#clientcapabilities-extensions">extensions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">\{</span> <span class="tsd-signature-symbol">\[</span><span class="tsd-kind-index-signature">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <a href="#jsonobject" class="tsd-signature-type tsd-kind-type-alias">JSONObject</a> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><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 class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="clientcapabilities-experimental" data-typedoc-h="3"><span>experimental?: \{ \[key: string]: JSONObject }</span><a href="#clientcapabilities-experimental" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Experimental, non-standard capabilities that the client supports.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="clientcapabilities-roots" data-typedoc-h="3"><span class="deprecated">roots?: \{}</span><a href="#clientcapabilities-roots" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Present if the client supports listing roots.</p> </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><div class="tsd-anchor-link" data-typedoc-h="4">Deprecated</div><p>Deprecated as of protocol version 2026-07-28 (SEP-2577).
  Remains in the specification for at least twelve months; see the
  deprecated features registry.</p> </div><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Roots — minimum baseline support<a href="#clientcapabilities-example-roots-minimum-baseline-support" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="clientcapabilities-example-roots-minimum-baseline-support"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"roots"</span><span class="hl-0">: \{}</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="clientcapabilities-sampling" data-typedoc-h="3"><span class="deprecated">sampling?: \{ context?: JSONObject; tools?: JSONObject }</span><a href="#clientcapabilities-sampling" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Present if the client supports sampling from an LLM.</p> </div><div class="tsd-type-declaration"><div data-typedoc-h="4">Type Declaration</div><ul class="tsd-parameters"><li class="tsd-parameter"><div data-typedoc-h="5"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">context</span><span class="tsd-signature-symbol">?: </span><a href="#jsonobject" class="tsd-signature-type tsd-kind-type-alias">JSONObject</a></div><div class="tsd-comment tsd-typography"><p>Whether the client supports context inclusion via <code>includeContext</code> parameter.
  If not declared, servers SHOULD only use <code>includeContext: "none"</code> (or omit it).</p> </div></li><li class="tsd-parameter"><div data-typedoc-h="5"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">tools</span><span class="tsd-signature-symbol">?: </span><a href="#jsonobject" class="tsd-signature-type tsd-kind-type-alias">JSONObject</a></div><div class="tsd-comment tsd-typography"><p>Whether the client supports tool use via <code>tools</code> and <code>toolChoice</code> parameters.</p> </div></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><div class="tsd-anchor-link" data-typedoc-h="4">Deprecated</div><p>Deprecated as of protocol version 2026-07-28 (SEP-2577).
  Remains in the specification for at least twelve months; see the
  deprecated features registry.</p> </div><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Sampling — minimum baseline support<a href="#clientcapabilities-example-sampling-minimum-baseline-support" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="clientcapabilities-example-sampling-minimum-baseline-support"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"sampling"</span><span class="hl-0">: \{}</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Sampling — tool use support<a href="#clientcapabilities-example-sampling-tool-use-support" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="clientcapabilities-example-sampling-tool-use-support"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"sampling"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"tools"</span><span class="hl-0">: \{}</span><br /><span class="hl-0">  }</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Sampling — context inclusion support (deprecated)<a href="#clientcapabilities-example-sampling-context-inclusion-support-deprecated" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="clientcapabilities-example-sampling-context-inclusion-support-deprecated"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"sampling"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"context"</span><span class="hl-0">: \{}</span><br /><span class="hl-0">  }</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="clientcapabilities-elicitation" data-typedoc-h="3"><span>elicitation?: \{ form?: JSONObject; url?: JSONObject }</span><a href="#clientcapabilities-elicitation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Present if the client supports elicitation from the server.</p> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Elicitation — form and URL mode support<a href="#clientcapabilities-example-elicitation-form-and-url-mode-support" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="clientcapabilities-example-elicitation-form-and-url-mode-support"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"elicitation"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"form"</span><span class="hl-0">: \{},</span><br /><span class="hl-0">    </span><span class="hl-1">"url"</span><span class="hl-0">: \{}</span><br /><span class="hl-0">  }</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Elicitation — form mode only (implicit)<a href="#clientcapabilities-example-elicitation-form-mode-only-implicit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="clientcapabilities-example-elicitation-form-mode-only-implicit"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"elicitation"</span><span class="hl-0">: \{}</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="clientcapabilities-extensions" data-typedoc-h="3"><span>extensions?: \{ \[key: string]: JSONObject }</span><a href="#clientcapabilities-extensions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Optional MCP extensions that the client supports. Keys are extension identifiers
  (e.g., "io.modelcontextprotocol/oauth-client-credentials"), and values are
  per-extension settings objects. An empty object indicates support with no settings.</p> <p>Keys MUST follow the <a href="#metaobject" class="tsd-kind-type-alias"><code>\_meta</code> key naming rules</a>, with a
  mandatory prefix.</p> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Extensions — MCP Apps (UI) extension with MIME type support<a href="#clientcapabilities-example-extensions-mcp-apps-ui-extension-with-mime-type-support" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="clientcapabilities-example-extensions-mcp-apps-ui-extension-with-mime-type-support"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"extensions"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"io.modelcontextprotocol/ui"</span><span class="hl-0">: \{</span><br /><span class="hl-0">      </span><span class="hl-1">"mimeTypes"</span><span class="hl-0">: \[</span><span class="hl-2">"text/html;profile=mcp-app"</span><span class="hl-0">]</span><br /><span class="hl-0">    }</span><br /><span class="hl-0">  }</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div></section>
</div>

<div class="type">
  ### `Implementation`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">Implementation</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#implementation-icons">icons</a><span class="tsd-signature-symbol">?:</span> <a href="#icon" class="tsd-signature-type tsd-kind-interface">Icon</a><span class="tsd-signature-symbol">\[]</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#implementation-name">name</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#implementation-title">title</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#implementation-version">version</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#implementation-description">description</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#implementation-websiteurl">websiteUrl</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Describes the MCP implementation.</p> </div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="implementation-icons" data-typedoc-h="3"><span>icons?: Icon\[]</span><a href="#implementation-icons" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><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 class="tsd-sources"><p>Inherited from Icons.icons</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="implementation-name" data-typedoc-h="3"><span>name: string</span><a href="#implementation-name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><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 class="tsd-sources"><p>Inherited from BaseMetadata.name</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="implementation-title" data-typedoc-h="3"><span>title?: string</span><a href="#implementation-title" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><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 <a href="#tool" class="tsd-kind-interface">Tool</a>,
  where <code>annotations.title</code> should be given precedence over using <code>name</code>,
  if present).</p> </div><aside class="tsd-sources"><p>Inherited from BaseMetadata.title</p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="implementation-version" data-typedoc-h="3"><span>version: string</span><a href="#implementation-version" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>The version of this implementation.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="implementation-description" data-typedoc-h="3"><span>description?: string</span><a href="#implementation-description" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><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 class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="implementation-websiteurl" data-typedoc-h="3"><span>websiteUrl?: string</span><a href="#implementation-websiteurl" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>An optional URL of the website for this implementation.</p> </div></section>
</div>

<div class="type">
  ### `ServerCapabilities`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ServerCapabilities</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#servercapabilities-experimental">experimental</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">\{</span> <span class="tsd-signature-symbol">\[</span><span class="tsd-kind-index-signature">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <a href="#jsonobject" class="tsd-signature-type tsd-kind-type-alias">JSONObject</a> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#servercapabilities-logging">logging</a><span class="tsd-signature-symbol">?:</span> <a href="#jsonobject" class="tsd-signature-type tsd-kind-type-alias">JSONObject</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#servercapabilities-completions">completions</a><span class="tsd-signature-symbol">?:</span> <a href="#jsonobject" class="tsd-signature-type tsd-kind-type-alias">JSONObject</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#servercapabilities-prompts">prompts</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">\{</span> <span class="tsd-kind-property">listChanged</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#servercapabilities-resources">resources</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">\{</span> <span class="tsd-kind-property">subscribe</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">listChanged</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#servercapabilities-tools">tools</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">\{</span> <span class="tsd-kind-property">listChanged</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#servercapabilities-extensions">extensions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">\{</span> <span class="tsd-signature-symbol">\[</span><span class="tsd-kind-index-signature">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <a href="#jsonobject" class="tsd-signature-type tsd-kind-type-alias">JSONObject</a> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><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 class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="servercapabilities-experimental" data-typedoc-h="3"><span>experimental?: \{ \[key: string]: JSONObject }</span><a href="#servercapabilities-experimental" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Experimental, non-standard capabilities that the server supports.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="servercapabilities-logging" data-typedoc-h="3"><span class="deprecated">logging?: JSONObject</span><a href="#servercapabilities-logging" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Present if the server supports sending log messages to the client.</p> </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><div class="tsd-anchor-link" data-typedoc-h="4">Deprecated</div><p>Deprecated as of protocol version 2026-07-28 (SEP-2577).
  Remains in the specification for at least twelve months; see the
  deprecated features registry.</p> </div><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Logging — minimum baseline support<a href="#servercapabilities-example-logging-minimum-baseline-support" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="servercapabilities-example-logging-minimum-baseline-support"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"logging"</span><span class="hl-0">: \{}</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="servercapabilities-completions" data-typedoc-h="3"><span>completions?: JSONObject</span><a href="#servercapabilities-completions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Present if the server supports argument autocompletion suggestions.</p> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Completions — minimum baseline support<a href="#servercapabilities-example-completions-minimum-baseline-support" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="servercapabilities-example-completions-minimum-baseline-support"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"completions"</span><span class="hl-0">: \{}</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="servercapabilities-prompts" data-typedoc-h="3"><span>prompts?: \{ listChanged?: boolean }</span><a href="#servercapabilities-prompts" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Present if the server offers any prompt templates.</p> </div><div class="tsd-type-declaration"><div data-typedoc-h="4">Type Declaration</div><ul class="tsd-parameters"><li class="tsd-parameter"><div data-typedoc-h="5"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">listChanged</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Whether this server supports notifications for changes to the prompt list.</p> </div></li></ul></div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Prompts — minimum baseline support<a href="#servercapabilities-example-prompts-minimum-baseline-support" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="servercapabilities-example-prompts-minimum-baseline-support"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"prompts"</span><span class="hl-0">: \{}</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Prompts — list changed notifications<a href="#servercapabilities-example-prompts-list-changed-notifications" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="servercapabilities-example-prompts-list-changed-notifications"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"prompts"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"listChanged"</span><span class="hl-0">: </span><span class="hl-5">true</span><br /><span class="hl-0">  }</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="servercapabilities-resources" data-typedoc-h="3"><span>resources?: \{ subscribe?: boolean; listChanged?: boolean }</span><a href="#servercapabilities-resources" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Present if the server offers any resources to read.</p> </div><div class="tsd-type-declaration"><div data-typedoc-h="4">Type Declaration</div><ul class="tsd-parameters"><li class="tsd-parameter"><div data-typedoc-h="5"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">subscribe</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Whether this server supports subscribing to resource updates.</p> </div></li><li class="tsd-parameter"><div data-typedoc-h="5"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">listChanged</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Whether this server supports notifications for changes to the resource list.</p> </div></li></ul></div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Resources — minimum baseline support<a href="#servercapabilities-example-resources-minimum-baseline-support" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="servercapabilities-example-resources-minimum-baseline-support"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"resources"</span><span class="hl-0">: \{}</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Resources — subscription to individual resource updates (only)<a href="#servercapabilities-example-resources-subscription-to-individual-resource-updates-only" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="servercapabilities-example-resources-subscription-to-individual-resource-updates-only"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"resources"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"subscribe"</span><span class="hl-0">: </span><span class="hl-5">true</span><br /><span class="hl-0">  }</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Resources — list changed notifications (only)<a href="#servercapabilities-example-resources-list-changed-notifications-only" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="servercapabilities-example-resources-list-changed-notifications-only"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"resources"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"listChanged"</span><span class="hl-0">: </span><span class="hl-5">true</span><br /><span class="hl-0">  }</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Resources — all notifications<a href="#servercapabilities-example-resources-all-notifications" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="servercapabilities-example-resources-all-notifications"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"resources"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"subscribe"</span><span class="hl-0">: </span><span class="hl-5">true</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"listChanged"</span><span class="hl-0">: </span><span class="hl-5">true</span><br /><span class="hl-0">  }</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="servercapabilities-tools" data-typedoc-h="3"><span>tools?: \{ listChanged?: boolean }</span><a href="#servercapabilities-tools" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Present if the server offers any tools to call.</p> </div><div class="tsd-type-declaration"><div data-typedoc-h="4">Type Declaration</div><ul class="tsd-parameters"><li class="tsd-parameter"><div data-typedoc-h="5"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">listChanged</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Whether this server supports notifications for changes to the tool list.</p> </div></li></ul></div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Tools — minimum baseline support<a href="#servercapabilities-example-tools-minimum-baseline-support" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="servercapabilities-example-tools-minimum-baseline-support"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"tools"</span><span class="hl-0">: \{}</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Tools — list changed notifications<a href="#servercapabilities-example-tools-list-changed-notifications" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="servercapabilities-example-tools-list-changed-notifications"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"tools"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"listChanged"</span><span class="hl-0">: </span><span class="hl-5">true</span><br /><span class="hl-0">  }</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="servercapabilities-extensions" data-typedoc-h="3"><span>extensions?: \{ \[key: string]: JSONObject }</span><a href="#servercapabilities-extensions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Optional MCP extensions that the server supports. Keys are extension identifiers
  (e.g., "io.modelcontextprotocol/tasks"), and values are per-extension settings
  objects. An empty object indicates support with no settings.</p> <p>Keys MUST follow the <a href="#metaobject" class="tsd-kind-type-alias"><code>\_meta</code> key naming rules</a>, with a
  mandatory prefix.</p> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Extensions — Tasks extension support<a href="#servercapabilities-example-extensions-tasks-extension-support" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="servercapabilities-example-extensions-tasks-extension-support"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"extensions"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"io.modelcontextprotocol/tasks"</span><span class="hl-0">: \{}</span><br /><span class="hl-0">  }</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div></section>
</div>

## `subscriptions/listen`

<div class="type">
  ### `SubscriptionsListenRequest`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">SubscriptionsListenRequest</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#subscriptionslistenrequest-jsonrpc">jsonrpc</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"2.0"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#subscriptionslistenrequest-id">id</a><span class="tsd-signature-symbol">:</span> <a href="#requestid" class="tsd-signature-type tsd-kind-type-alias">RequestId</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#subscriptionslistenrequest-method">method</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"subscriptions/listen"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#subscriptionslistenrequest-params">params</a><span class="tsd-signature-symbol">:</span> <a href="#subscriptionslistenrequestparams" class="tsd-signature-type tsd-kind-interface">SubscriptionsListenRequestParams</a><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Sent from the client to open a long-lived channel for receiving notifications
  outside the context of a specific request. Replaces the previous HTTP GET
  endpoint and ensures consistent behavior between HTTP and STDIO.</p> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Listen for tools and resource list changes<a href="#subscriptionslistenrequest-example-listen-for-tools-and-resource-list-changes" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="subscriptionslistenrequest-example-listen-for-tools-and-resource-list-changes"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"jsonrpc"</span><span class="hl-0">: </span><span class="hl-2">"2.0"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"id"</span><span class="hl-0">: </span><span class="hl-2">"listen-1"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"method"</span><span class="hl-0">: </span><span class="hl-2">"subscriptions/listen"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"params"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"\_meta"</span><span class="hl-0">: \{</span><br /><span class="hl-0">      </span><span class="hl-1">"io.modelcontextprotocol/protocolVersion"</span><span class="hl-0">: </span><span class="hl-2">"2026-07-28"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"io.modelcontextprotocol/clientInfo"</span><span class="hl-0">: \{</span><br /><span class="hl-0">        </span><span class="hl-1">"name"</span><span class="hl-0">: </span><span class="hl-2">"ExampleClient"</span><span class="hl-0">,</span><br /><span class="hl-0">        </span><span class="hl-1">"version"</span><span class="hl-0">: </span><span class="hl-2">"1.0.0"</span><br /><span class="hl-0">      },</span><br /><span class="hl-0">      </span><span class="hl-1">"io.modelcontextprotocol/clientCapabilities"</span><span class="hl-0">: \{}</span><br /><span class="hl-0">    },</span><br /><span class="hl-0">    </span><span class="hl-1">"notifications"</span><span class="hl-0">: \{</span><br /><span class="hl-0">      </span><span class="hl-1">"toolsListChanged"</span><span class="hl-0">: </span><span class="hl-5">true</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"resourceSubscriptions"</span><span class="hl-0">: \[</span><span class="hl-2">"file:///project/config.json"</span><span class="hl-0">]</span><br /><span class="hl-0">    }</span><br /><span class="hl-0">  }</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="subscriptionslistenrequest-jsonrpc" data-typedoc-h="3"><span>jsonrpc: "2.0"</span><a href="#subscriptionslistenrequest-jsonrpc" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-jsonrpc">jsonrpc</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="subscriptionslistenrequest-id" data-typedoc-h="3"><span>id: RequestId</span><a href="#subscriptionslistenrequest-id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-id">id</a></p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="subscriptionslistenrequest-method" data-typedoc-h="3"><span>method: "subscriptions/listen"</span><a href="#subscriptionslistenrequest-method" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Overrides <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-method">method</a></p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="subscriptionslistenrequest-params" data-typedoc-h="3"><span>params: SubscriptionsListenRequestParams</span><a href="#subscriptionslistenrequest-params" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Overrides <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-params">params</a></p></aside></section>
</div>

<div class="type">
  ### `SubscriptionsListenRequestParams`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">SubscriptionsListenRequestParams</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#subscriptionslistenrequestparams-_meta">\_meta</a><span class="tsd-signature-symbol">:</span> <a href="#requestmetaobject" class="tsd-signature-type tsd-kind-interface">RequestMetaObject</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#subscriptionslistenrequestparams-notifications">notifications</a><span class="tsd-signature-symbol">:</span> <a href="#subscriptionfilter" class="tsd-signature-type tsd-kind-interface">SubscriptionFilter</a><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Parameters for a <a href="#subscriptionslistenrequest" class="tsd-kind-interface">subscriptions/listen</a> request.</p> </div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="subscriptionslistenrequestparams-_meta" data-typedoc-h="3"><span>\_meta: RequestMetaObject</span><a href="#subscriptionslistenrequestparams-_meta" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#requestparams">RequestParams</a>.<a href="#requestparams-_meta">\_meta</a></p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="subscriptionslistenrequestparams-notifications" data-typedoc-h="3"><span>notifications: SubscriptionFilter</span><a href="#subscriptionslistenrequestparams-notifications" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>The notifications the client opts in to on this stream. The server <strong>MUST NOT</strong> send notification types the client has not explicitly
  requested.</p> </div></section>
</div>

<div class="type">
  ### `SubscriptionFilter`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">SubscriptionFilter</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#subscriptionfilter-toolslistchanged">toolsListChanged</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#subscriptionfilter-promptslistchanged">promptsListChanged</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#subscriptionfilter-resourceslistchanged">resourcesListChanged</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#subscriptionfilter-resourcesubscriptions">resourceSubscriptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">\[]</span><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>The set of notification types a client may opt in to on a <a href="#subscriptionslistenrequest" class="tsd-kind-interface">subscriptions/listen</a> request.</p> <p>Each notification type is <strong>opt-in</strong>; the server <strong>MUST NOT</strong> send
  notification types the client has not explicitly requested here.</p> </div><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="subscriptionfilter-toolslistchanged" data-typedoc-h="3"><span>toolsListChanged?: boolean</span><a href="#subscriptionfilter-toolslistchanged" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>If true, receive <a href="#toollistchangednotification" class="tsd-kind-interface">notifications/tools/list\_changed</a>.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="subscriptionfilter-promptslistchanged" data-typedoc-h="3"><span>promptsListChanged?: boolean</span><a href="#subscriptionfilter-promptslistchanged" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>If true, receive <a href="#promptlistchangednotification" class="tsd-kind-interface">notifications/prompts/list\_changed</a>.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="subscriptionfilter-resourceslistchanged" data-typedoc-h="3"><span>resourcesListChanged?: boolean</span><a href="#subscriptionfilter-resourceslistchanged" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>If true, receive <a href="#resourcelistchangednotification" class="tsd-kind-interface">notifications/resources/list\_changed</a>.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="subscriptionfilter-resourcesubscriptions" data-typedoc-h="3"><span>resourceSubscriptions?: string\[]</span><a href="#subscriptionfilter-resourcesubscriptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Subscribe to <a href="#resourceupdatednotification" class="tsd-kind-interface">notifications/resources/updated</a> for these resource URIs.
  Replaces the former <code>resources/subscribe</code> RPC.</p> </div></section>
</div>

## `tools/call`

<div class="type">
  ### `CallToolRequest`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">CallToolRequest</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#calltoolrequest-jsonrpc">jsonrpc</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"2.0"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#calltoolrequest-id">id</a><span class="tsd-signature-symbol">:</span> <a href="#requestid" class="tsd-signature-type tsd-kind-type-alias">RequestId</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#calltoolrequest-method">method</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"tools/call"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#calltoolrequest-params">params</a><span class="tsd-signature-symbol">:</span> <a href="#calltoolrequestparams" class="tsd-signature-type tsd-kind-interface">CallToolRequestParams</a><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Used by the client to invoke a tool provided by the server.</p> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Call tool request<a href="#calltoolrequest-example-call-tool-request" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="calltoolrequest-example-call-tool-request"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"jsonrpc"</span><span class="hl-0">: </span><span class="hl-2">"2.0"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"id"</span><span class="hl-0">: </span><span class="hl-2">"call-tool-example"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"method"</span><span class="hl-0">: </span><span class="hl-2">"tools/call"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"params"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"\_meta"</span><span class="hl-0">: \{</span><br /><span class="hl-0">      </span><span class="hl-1">"io.modelcontextprotocol/protocolVersion"</span><span class="hl-0">: </span><span class="hl-2">"2026-07-28"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"io.modelcontextprotocol/clientInfo"</span><span class="hl-0">: \{</span><br /><span class="hl-0">        </span><span class="hl-1">"name"</span><span class="hl-0">: </span><span class="hl-2">"ExampleClient"</span><span class="hl-0">,</span><br /><span class="hl-0">        </span><span class="hl-1">"version"</span><span class="hl-0">: </span><span class="hl-2">"1.0.0"</span><br /><span class="hl-0">      },</span><br /><span class="hl-0">      </span><span class="hl-1">"io.modelcontextprotocol/clientCapabilities"</span><span class="hl-0">: \{}</span><br /><span class="hl-0">    },</span><br /><span class="hl-0">    </span><span class="hl-1">"name"</span><span class="hl-0">: </span><span class="hl-2">"get\_weather"</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"arguments"</span><span class="hl-0">: \{</span><br /><span class="hl-0">      </span><span class="hl-1">"location"</span><span class="hl-0">: </span><span class="hl-2">"New York"</span><br /><span class="hl-0">    }</span><br /><span class="hl-0">  }</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="calltoolrequest-jsonrpc" data-typedoc-h="3"><span>jsonrpc: "2.0"</span><a href="#calltoolrequest-jsonrpc" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-jsonrpc">jsonrpc</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="calltoolrequest-id" data-typedoc-h="3"><span>id: RequestId</span><a href="#calltoolrequest-id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-id">id</a></p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="calltoolrequest-method" data-typedoc-h="3"><span>method: "tools/call"</span><a href="#calltoolrequest-method" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Overrides <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-method">method</a></p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="calltoolrequest-params" data-typedoc-h="3"><span>params: CallToolRequestParams</span><a href="#calltoolrequest-params" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Overrides <a href="#jsonrpcrequest">JSONRPCRequest</a>.<a href="#jsonrpcrequest-params">params</a></p></aside></section>
</div>

<div class="type">
  ### `CallToolRequestParams`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">CallToolRequestParams</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#calltoolrequestparams-_meta">\_meta</a><span class="tsd-signature-symbol">:</span> <a href="#requestmetaobject" class="tsd-signature-type tsd-kind-interface">RequestMetaObject</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#calltoolrequestparams-inputresponses">inputResponses</a><span class="tsd-signature-symbol">?:</span> <a href="#inputresponses" class="tsd-signature-type tsd-kind-interface">InputResponses</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#calltoolrequestparams-requeststate">requestState</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#calltoolrequestparams-name">name</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#calltoolrequestparams-arguments">arguments</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">\{</span> <span class="tsd-signature-symbol">\[</span><span class="tsd-kind-index-signature">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <span class="tsd-signature-type">unknown</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Parameters for a <code>tools/call</code> request.</p> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: \`get\_weather\` tool call params<a href="#calltoolrequestparams-example-get_weather-tool-call-params" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="calltoolrequestparams-example-get_weather-tool-call-params"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"\_meta"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"io.modelcontextprotocol/protocolVersion"</span><span class="hl-0">: </span><span class="hl-2">"2026-07-28"</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"io.modelcontextprotocol/clientInfo"</span><span class="hl-0">: \{</span><br /><span class="hl-0">      </span><span class="hl-1">"name"</span><span class="hl-0">: </span><span class="hl-2">"ExampleClient"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"version"</span><span class="hl-0">: </span><span class="hl-2">"1.0.0"</span><br /><span class="hl-0">    },</span><br /><span class="hl-0">    </span><span class="hl-1">"io.modelcontextprotocol/clientCapabilities"</span><span class="hl-0">: \{}</span><br /><span class="hl-0">  },</span><br /><span class="hl-0">  </span><span class="hl-1">"name"</span><span class="hl-0">: </span><span class="hl-2">"get\_weather"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"arguments"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"location"</span><span class="hl-0">: </span><span class="hl-2">"New York"</span><br /><span class="hl-0">  }</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Tool call params with progress token<a href="#calltoolrequestparams-example-tool-call-params-with-progress-token" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="calltoolrequestparams-example-tool-call-params-with-progress-token"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"\_meta"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"io.modelcontextprotocol/protocolVersion"</span><span class="hl-0">: </span><span class="hl-2">"2026-07-28"</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"io.modelcontextprotocol/clientInfo"</span><span class="hl-0">: \{</span><br /><span class="hl-0">      </span><span class="hl-1">"name"</span><span class="hl-0">: </span><span class="hl-2">"ExampleClient"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"version"</span><span class="hl-0">: </span><span class="hl-2">"1.0.0"</span><br /><span class="hl-0">    },</span><br /><span class="hl-0">    </span><span class="hl-1">"io.modelcontextprotocol/clientCapabilities"</span><span class="hl-0">: \{},</span><br /><span class="hl-0">    </span><span class="hl-1">"progressToken"</span><span class="hl-0">: </span><span class="hl-2">"oivaizmir"</span><br /><span class="hl-0">  },</span><br /><span class="hl-0">  </span><span class="hl-1">"name"</span><span class="hl-0">: </span><span class="hl-2">"build\_simulation"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"arguments"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"city"</span><span class="hl-0">: </span><span class="hl-2">"Micropolis"</span><br /><span class="hl-0">  }</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="calltoolrequestparams-_meta" data-typedoc-h="3"><span>\_meta: RequestMetaObject</span><a href="#calltoolrequestparams-_meta" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#inputresponserequestparams">InputResponseRequestParams</a>.<a href="#inputresponserequestparams-_meta">\_meta</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="calltoolrequestparams-inputresponses" data-typedoc-h="3"><span>inputResponses?: InputResponses</span><a href="#calltoolrequestparams-inputresponses" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#inputresponserequestparams">InputResponseRequestParams</a>.<a href="#inputresponserequestparams-inputresponses">inputResponses</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="calltoolrequestparams-requeststate" data-typedoc-h="3"><span>requestState?: string</span><a href="#calltoolrequestparams-requeststate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#inputresponserequestparams">InputResponseRequestParams</a>.<a href="#inputresponserequestparams-requeststate">requestState</a></p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="calltoolrequestparams-name" data-typedoc-h="3"><span>name: string</span><a href="#calltoolrequestparams-name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>The name of the tool.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="calltoolrequestparams-arguments" data-typedoc-h="3"><span>arguments?: \{ \[key: string]: unknown }</span><a href="#calltoolrequestparams-arguments" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Arguments to use for the tool call.</p> </div></section>
</div>

<div class="type">
  ### `CallToolResultResponse`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">CallToolResultResponse</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#calltoolresultresponse-jsonrpc">jsonrpc</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"2.0"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#calltoolresultresponse-id">id</a><span class="tsd-signature-symbol">:</span> <a href="#requestid" class="tsd-signature-type tsd-kind-type-alias">RequestId</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#calltoolresultresponse-result">result</a><span class="tsd-signature-symbol">:</span> <a href="#inputrequiredresult" class="tsd-signature-type tsd-kind-interface">InputRequiredResult</a> <span class="tsd-signature-symbol">|</span> <a href="#calltoolresult" class="tsd-signature-type tsd-kind-interface">CallToolResult</a><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>A successful response from the server for a <a href="#calltoolrequest" class="tsd-kind-interface">tools/call</a> request.</p> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Call tool result response<a href="#calltoolresultresponse-example-call-tool-result-response" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="calltoolresultresponse-example-call-tool-result-response"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"jsonrpc"</span><span class="hl-0">: </span><span class="hl-2">"2.0"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"id"</span><span class="hl-0">: </span><span class="hl-2">"call-tool-example"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"result"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"resultType"</span><span class="hl-0">: </span><span class="hl-2">"complete"</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"content"</span><span class="hl-0">: \[</span><br /><span class="hl-0">      \{</span><br /><span class="hl-0">        </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"text"</span><span class="hl-0">,</span><br /><span class="hl-0">        </span><span class="hl-1">"text"</span><span class="hl-0">: </span><span class="hl-2">"Current weather in New York:</span><span class="hl-4">\n</span><span class="hl-2">Temperature: 72°F</span><span class="hl-4">\n</span><span class="hl-2">Conditions: Partly cloudy"</span><br /><span class="hl-0">      }</span><br /><span class="hl-0">    ],</span><br /><span class="hl-0">    </span><span class="hl-1">"isError"</span><span class="hl-0">: </span><span class="hl-5">false</span><br /><span class="hl-0">  }</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="calltoolresultresponse-jsonrpc" data-typedoc-h="3"><span>jsonrpc: "2.0"</span><a href="#calltoolresultresponse-jsonrpc" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#jsonrpcresultresponse">JSONRPCResultResponse</a>.<a href="#jsonrpcresultresponse-jsonrpc">jsonrpc</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="calltoolresultresponse-id" data-typedoc-h="3"><span>id: RequestId</span><a href="#calltoolresultresponse-id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#jsonrpcresultresponse">JSONRPCResultResponse</a>.<a href="#jsonrpcresultresponse-id">id</a></p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="calltoolresultresponse-result" data-typedoc-h="3"><span>result: InputRequiredResult | CallToolResult</span><a href="#calltoolresultresponse-result" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Overrides <a href="#jsonrpcresultresponse">JSONRPCResultResponse</a>.<a href="#jsonrpcresultresponse-result">result</a></p></aside></section>
</div>

<div class="type">
  ### `CallToolResult`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">CallToolResult</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#calltoolresult-_meta">\_meta</a><span class="tsd-signature-symbol">?:</span> <a href="#metaobject" class="tsd-signature-type tsd-kind-type-alias">MetaObject</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#calltoolresult-resulttype">resultType</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#calltoolresult-content">content</a><span class="tsd-signature-symbol">:</span> <a href="#contentblock" class="tsd-signature-type tsd-kind-type-alias">ContentBlock</a><span class="tsd-signature-symbol">\[]</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#calltoolresult-structuredcontent">structuredContent</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#calltoolresult-iserror">isError</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br />  <span class="tsd-signature-symbol">\[</span><span class="tsd-kind-index-signature">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>The result returned by the server for a <a href="#calltoolrequest" class="tsd-kind-interface">tools/call</a> request.</p> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Result with unstructured text<a href="#calltoolresult-example-result-with-unstructured-text" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="calltoolresult-example-result-with-unstructured-text"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"resultType"</span><span class="hl-0">: </span><span class="hl-2">"complete"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"content"</span><span class="hl-0">: \[</span><br /><span class="hl-0">    \{</span><br /><span class="hl-0">      </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"text"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"text"</span><span class="hl-0">: </span><span class="hl-2">"Current weather in New York:</span><span class="hl-4">\n</span><span class="hl-2">Temperature: 72°F</span><span class="hl-4">\n</span><span class="hl-2">Conditions: Partly cloudy"</span><br /><span class="hl-0">    }</span><br /><span class="hl-0">  ],</span><br /><span class="hl-0">  </span><span class="hl-1">"isError"</span><span class="hl-0">: </span><span class="hl-5">false</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Result with structured content<a href="#calltoolresult-example-result-with-structured-content" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="calltoolresult-example-result-with-structured-content"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"resultType"</span><span class="hl-0">: </span><span class="hl-2">"complete"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"content"</span><span class="hl-0">: \[</span><br /><span class="hl-0">    \{</span><br /><span class="hl-0">      </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"text"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"text"</span><span class="hl-0">: </span><span class="hl-2">"\{</span><span class="hl-4">\\"</span><span class="hl-2">temperature</span><span class="hl-4">\\"</span><span class="hl-2">: 22.5, </span><span class="hl-4">\\"</span><span class="hl-2">conditions</span><span class="hl-4">\\"</span><span class="hl-2">: </span><span class="hl-4">\\"</span><span class="hl-2">Partly cloudy</span><span class="hl-4">\\"</span><span class="hl-2">, </span><span class="hl-4">\\"</span><span class="hl-2">humidity</span><span class="hl-4">\\"</span><span class="hl-2">: 65}"</span><br /><span class="hl-0">    }</span><br /><span class="hl-0">  ],</span><br /><span class="hl-0">  </span><span class="hl-1">"structuredContent"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"temperature"</span><span class="hl-0">: </span><span class="hl-3">22.5</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"conditions"</span><span class="hl-0">: </span><span class="hl-2">"Partly cloudy"</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"humidity"</span><span class="hl-0">: </span><span class="hl-3">65</span><br /><span class="hl-0">  }</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Invalid tool input error<a href="#calltoolresult-example-invalid-tool-input-error" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="calltoolresult-example-invalid-tool-input-error"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"resultType"</span><span class="hl-0">: </span><span class="hl-2">"complete"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"content"</span><span class="hl-0">: \[</span><br /><span class="hl-0">    \{</span><br /><span class="hl-0">      </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"text"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"text"</span><span class="hl-0">: </span><span class="hl-2">"Invalid departure date: must be in the future. Current date is 08/08/2025."</span><br /><span class="hl-0">    }</span><br /><span class="hl-0">  ],</span><br /><span class="hl-0">  </span><span class="hl-1">"isError"</span><span class="hl-0">: </span><span class="hl-5">true</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="calltoolresult-_meta" data-typedoc-h="3"><span>\_meta?: MetaObject</span><a href="#calltoolresult-_meta" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#result">Result</a>.<a href="#result-_meta">\_meta</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="calltoolresult-resulttype" data-typedoc-h="3"><span>resultType: string</span><a href="#calltoolresult-resulttype" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Indicates the type of the result, which allows the client to determine
  how to parse the result object.</p> <p>Servers implementing this protocol version MUST include this field.
  For backward compatibility, when a client receives a result from a
  server implementing an earlier protocol version (which does not include <code>resultType</code>), the client MUST treat the absent field as <code>"complete"</code>.</p> </div><aside class="tsd-sources"><p>Inherited from <a href="#result">Result</a>.<a href="#result-resulttype">resultType</a></p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="calltoolresult-content" data-typedoc-h="3"><span>content: ContentBlock\[]</span><a href="#calltoolresult-content" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>A list of content objects that represent the unstructured result of the tool call.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="calltoolresult-structuredcontent" data-typedoc-h="3"><span>structuredContent?: unknown</span><a href="#calltoolresult-structuredcontent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>An optional JSON value that represents the structured result of the tool call.</p> <p>This can be any JSON value (object, array, string, number, boolean, or null)
  that conforms to the tool's outputSchema if one is defined.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="calltoolresult-iserror" data-typedoc-h="3"><span>isError?: boolean</span><a href="#calltoolresult-iserror" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><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 class="type">
  ### `ListToolsRequest`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ListToolsRequest</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#listtoolsrequest-jsonrpc">jsonrpc</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"2.0"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#listtoolsrequest-id">id</a><span class="tsd-signature-symbol">:</span> <a href="#requestid" class="tsd-signature-type tsd-kind-type-alias">RequestId</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#listtoolsrequest-params">params</a><span class="tsd-signature-symbol">:</span> <a href="#paginatedrequestparams" class="tsd-signature-type tsd-kind-interface">PaginatedRequestParams</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#listtoolsrequest-method">method</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"tools/list"</span><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Sent from the client to request a list of tools the server has.</p> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: List tools request<a href="#listtoolsrequest-example-list-tools-request" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="listtoolsrequest-example-list-tools-request"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"jsonrpc"</span><span class="hl-0">: </span><span class="hl-2">"2.0"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"id"</span><span class="hl-0">: </span><span class="hl-2">"list-tools-example"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"method"</span><span class="hl-0">: </span><span class="hl-2">"tools/list"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"params"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"\_meta"</span><span class="hl-0">: \{</span><br /><span class="hl-0">      </span><span class="hl-1">"io.modelcontextprotocol/protocolVersion"</span><span class="hl-0">: </span><span class="hl-2">"2026-07-28"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"io.modelcontextprotocol/clientInfo"</span><span class="hl-0">: \{</span><br /><span class="hl-0">        </span><span class="hl-1">"name"</span><span class="hl-0">: </span><span class="hl-2">"ExampleClient"</span><span class="hl-0">,</span><br /><span class="hl-0">        </span><span class="hl-1">"version"</span><span class="hl-0">: </span><span class="hl-2">"1.0.0"</span><br /><span class="hl-0">      },</span><br /><span class="hl-0">      </span><span class="hl-1">"io.modelcontextprotocol/clientCapabilities"</span><span class="hl-0">: \{}</span><br /><span class="hl-0">    }</span><br /><span class="hl-0">  }</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="listtoolsrequest-jsonrpc" data-typedoc-h="3"><span>jsonrpc: "2.0"</span><a href="#listtoolsrequest-jsonrpc" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from PaginatedRequest.jsonrpc</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="listtoolsrequest-id" data-typedoc-h="3"><span>id: RequestId</span><a href="#listtoolsrequest-id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from PaginatedRequest.id</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="listtoolsrequest-params" data-typedoc-h="3"><span>params: PaginatedRequestParams</span><a href="#listtoolsrequest-params" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from PaginatedRequest.params</p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="listtoolsrequest-method" data-typedoc-h="3"><span>method: "tools/list"</span><a href="#listtoolsrequest-method" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Overrides PaginatedRequest.method</p></aside></section>
</div>

<div class="type">
  ### `ListToolsResultResponse`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ListToolsResultResponse</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#listtoolsresultresponse-jsonrpc">jsonrpc</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"2.0"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#listtoolsresultresponse-id">id</a><span class="tsd-signature-symbol">:</span> <a href="#requestid" class="tsd-signature-type tsd-kind-type-alias">RequestId</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#listtoolsresultresponse-result">result</a><span class="tsd-signature-symbol">:</span> <a href="#listtoolsresult" class="tsd-signature-type tsd-kind-interface">ListToolsResult</a><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>A successful response from the server for a <a href="#listtoolsrequest" class="tsd-kind-interface">tools/list</a> request.</p> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: List tools result response<a href="#listtoolsresultresponse-example-list-tools-result-response" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="listtoolsresultresponse-example-list-tools-result-response"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"jsonrpc"</span><span class="hl-0">: </span><span class="hl-2">"2.0"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"id"</span><span class="hl-0">: </span><span class="hl-2">"list-tools-example"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"result"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"resultType"</span><span class="hl-0">: </span><span class="hl-2">"complete"</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"tools"</span><span class="hl-0">: \[</span><br /><span class="hl-0">      \{</span><br /><span class="hl-0">        </span><span class="hl-1">"name"</span><span class="hl-0">: </span><span class="hl-2">"get\_weather"</span><span class="hl-0">,</span><br /><span class="hl-0">        </span><span class="hl-1">"title"</span><span class="hl-0">: </span><span class="hl-2">"Weather Information Provider"</span><span class="hl-0">,</span><br /><span class="hl-0">        </span><span class="hl-1">"description"</span><span class="hl-0">: </span><span class="hl-2">"Get current weather information for a location"</span><span class="hl-0">,</span><br /><span class="hl-0">        </span><span class="hl-1">"inputSchema"</span><span class="hl-0">: \{</span><br /><span class="hl-0">          </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"object"</span><span class="hl-0">,</span><br /><span class="hl-0">          </span><span class="hl-1">"properties"</span><span class="hl-0">: \{</span><br /><span class="hl-0">            </span><span class="hl-1">"location"</span><span class="hl-0">: \{</span><br /><span class="hl-0">              </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"string"</span><span class="hl-0">,</span><br /><span class="hl-0">              </span><span class="hl-1">"description"</span><span class="hl-0">: </span><span class="hl-2">"City name or zip code"</span><br /><span class="hl-0">            }</span><br /><span class="hl-0">          },</span><br /><span class="hl-0">          </span><span class="hl-1">"required"</span><span class="hl-0">: \[</span><span class="hl-2">"location"</span><span class="hl-0">]</span><br /><span class="hl-0">        },</span><br /><span class="hl-0">        </span><span class="hl-1">"icons"</span><span class="hl-0">: \[</span><br /><span class="hl-0">          \{</span><br /><span class="hl-0">            </span><span class="hl-1">"src"</span><span class="hl-0">: </span><span class="hl-2">"[https://example.com/weather-icon.png](https://example.com/weather-icon.png)"</span><span class="hl-0">,</span><br /><span class="hl-0">            </span><span class="hl-1">"mimeType"</span><span class="hl-0">: </span><span class="hl-2">"image/png"</span><span class="hl-0">,</span><br /><span class="hl-0">            </span><span class="hl-1">"sizes"</span><span class="hl-0">: \[</span><span class="hl-2">"48x48"</span><span class="hl-0">]</span><br /><span class="hl-0">          }</span><br /><span class="hl-0">        ]</span><br /><span class="hl-0">      }</span><br /><span class="hl-0">    ],</span><br /><span class="hl-0">    </span><span class="hl-1">"nextCursor"</span><span class="hl-0">: </span><span class="hl-2">"next-page-cursor"</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"ttlMs"</span><span class="hl-0">: </span><span class="hl-3">3600000</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"cacheScope"</span><span class="hl-0">: </span><span class="hl-2">"public"</span><br /><span class="hl-0">  }</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="listtoolsresultresponse-jsonrpc" data-typedoc-h="3"><span>jsonrpc: "2.0"</span><a href="#listtoolsresultresponse-jsonrpc" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#jsonrpcresultresponse">JSONRPCResultResponse</a>.<a href="#jsonrpcresultresponse-jsonrpc">jsonrpc</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="listtoolsresultresponse-id" data-typedoc-h="3"><span>id: RequestId</span><a href="#listtoolsresultresponse-id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from <a href="#jsonrpcresultresponse">JSONRPCResultResponse</a>.<a href="#jsonrpcresultresponse-id">id</a></p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="listtoolsresultresponse-result" data-typedoc-h="3"><span>result: ListToolsResult</span><a href="#listtoolsresultresponse-result" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Overrides <a href="#jsonrpcresultresponse">JSONRPCResultResponse</a>.<a href="#jsonrpcresultresponse-result">result</a></p></aside></section>
</div>

<div class="type">
  ### `ListToolsResult`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ListToolsResult</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#listtoolsresult-_meta">\_meta</a><span class="tsd-signature-symbol">?:</span> <a href="#metaobject" class="tsd-signature-type tsd-kind-type-alias">MetaObject</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#listtoolsresult-resulttype">resultType</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#listtoolsresult-nextcursor">nextCursor</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#listtoolsresult-ttlms">ttlMs</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#listtoolsresult-cachescope">cacheScope</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"public"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"private"</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#listtoolsresult-tools">tools</a><span class="tsd-signature-symbol">:</span> <a href="#tool" class="tsd-signature-type tsd-kind-interface">Tool</a><span class="tsd-signature-symbol">\[]</span><span class="tsd-signature-symbol">;</span><br />  <span class="tsd-signature-symbol">\[</span><span class="tsd-kind-index-signature">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>The result returned by the server for a <a href="#listtoolsrequest" class="tsd-kind-interface">tools/list</a> request.</p> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: Tools list with cursor and TTL<a href="#listtoolsresult-example-tools-list-with-cursor-and-ttl" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="listtoolsresult-example-tools-list-with-cursor-and-ttl"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"resultType"</span><span class="hl-0">: </span><span class="hl-2">"complete"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"tools"</span><span class="hl-0">: \[</span><br /><span class="hl-0">    \{</span><br /><span class="hl-0">      </span><span class="hl-1">"name"</span><span class="hl-0">: </span><span class="hl-2">"get\_weather"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"title"</span><span class="hl-0">: </span><span class="hl-2">"Weather Information Provider"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"description"</span><span class="hl-0">: </span><span class="hl-2">"Get current weather information for a location"</span><span class="hl-0">,</span><br /><span class="hl-0">      </span><span class="hl-1">"inputSchema"</span><span class="hl-0">: \{</span><br /><span class="hl-0">        </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"object"</span><span class="hl-0">,</span><br /><span class="hl-0">        </span><span class="hl-1">"properties"</span><span class="hl-0">: \{</span><br /><span class="hl-0">          </span><span class="hl-1">"location"</span><span class="hl-0">: \{</span><br /><span class="hl-0">            </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"string"</span><span class="hl-0">,</span><br /><span class="hl-0">            </span><span class="hl-1">"description"</span><span class="hl-0">: </span><span class="hl-2">"City name or zip code"</span><br /><span class="hl-0">          }</span><br /><span class="hl-0">        },</span><br /><span class="hl-0">        </span><span class="hl-1">"required"</span><span class="hl-0">: \[</span><span class="hl-2">"location"</span><span class="hl-0">]</span><br /><span class="hl-0">      },</span><br /><span class="hl-0">      </span><span class="hl-1">"icons"</span><span class="hl-0">: \[</span><br /><span class="hl-0">        \{</span><br /><span class="hl-0">          </span><span class="hl-1">"src"</span><span class="hl-0">: </span><span class="hl-2">"[https://example.com/weather-icon.png](https://example.com/weather-icon.png)"</span><span class="hl-0">,</span><br /><span class="hl-0">          </span><span class="hl-1">"mimeType"</span><span class="hl-0">: </span><span class="hl-2">"image/png"</span><span class="hl-0">,</span><br /><span class="hl-0">          </span><span class="hl-1">"sizes"</span><span class="hl-0">: \[</span><span class="hl-2">"48x48"</span><span class="hl-0">]</span><br /><span class="hl-0">        }</span><br /><span class="hl-0">      ]</span><br /><span class="hl-0">    }</span><br /><span class="hl-0">  ],</span><br /><span class="hl-0">  </span><span class="hl-1">"nextCursor"</span><span class="hl-0">: </span><span class="hl-2">"next-page-cursor"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"ttlMs"</span><span class="hl-0">: </span><span class="hl-3">300000</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"cacheScope"</span><span class="hl-0">: </span><span class="hl-2">"public"</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="listtoolsresult-_meta" data-typedoc-h="3"><span>\_meta?: MetaObject</span><a href="#listtoolsresult-_meta" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><aside class="tsd-sources"><p>Inherited from PaginatedResult.\_meta</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="listtoolsresult-resulttype" data-typedoc-h="3"><span>resultType: string</span><a href="#listtoolsresult-resulttype" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Indicates the type of the result, which allows the client to determine
  how to parse the result object.</p> <p>Servers implementing this protocol version MUST include this field.
  For backward compatibility, when a client receives a result from a
  server implementing an earlier protocol version (which does not include <code>resultType</code>), the client MUST treat the absent field as <code>"complete"</code>.</p> </div><aside class="tsd-sources"><p>Inherited from PaginatedResult.resultType</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="listtoolsresult-nextcursor" data-typedoc-h="3"><span>nextCursor?: string</span><a href="#listtoolsresult-nextcursor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>An opaque token representing the pagination position after the last returned result.
  If present, there may be more results available.</p> </div><aside class="tsd-sources"><p>Inherited from PaginatedResult.nextCursor</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="listtoolsresult-ttlms" data-typedoc-h="3"><span>ttlMs: number</span><a href="#listtoolsresult-ttlms" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>A hint from the server indicating how long (in milliseconds) the
  client MAY cache this response before re-fetching. Semantics are
  analogous to HTTP Cache-Control max-age.</p> <ul> <li>If 0, The response SHOULD be considered immediately stale,
  The client MAY re-fetch every time the result is needed.</li> <li>If positive, the client SHOULD consider the result fresh for this many
  milliseconds after receiving the response.</li> </ul> </div><aside class="tsd-sources"><p>Inherited from CacheableResult.ttlMs</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="listtoolsresult-cachescope" data-typedoc-h="3"><span>cacheScope: "public" | "private"</span><a href="#listtoolsresult-cachescope" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Indicates the intended scope of the cached response, analogous to HTTP <code>Cache-Control: public</code> vs <code>Cache-Control: private</code>.</p> <ul> <li><code>"public"</code>: Any client or intermediary (e.g., shared gateway, proxy)
  MAY cache the response and serve it to any user.</li> <li><code>"private"</code>: Only the requesting user's client MAY cache the response.
  Shared caches (e.g., multi-tenant gateways) MUST NOT serve a cached
  copy to a different user.</li> </ul> </div><aside class="tsd-sources"><p>Inherited from CacheableResult.cacheScope</p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="listtoolsresult-tools" data-typedoc-h="3"><span>tools: Tool\[]</span><a href="#listtoolsresult-tools" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section>
</div>

<div class="type">
  ### `Tool`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">Tool</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#tool-icons">icons</a><span class="tsd-signature-symbol">?:</span> <a href="#icon" class="tsd-signature-type tsd-kind-interface">Icon</a><span class="tsd-signature-symbol">\[]</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#tool-name">name</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#tool-title">title</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#tool-description">description</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#tool-inputschema">inputSchema</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">\{</span> <span class="tsd-kind-property">\$schema</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"object"</span><span class="tsd-signature-symbol">;</span> <span class="tsd-signature-symbol">\[</span><span class="tsd-kind-index-signature">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <span class="tsd-signature-type">unknown</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#tool-outputschema">outputSchema</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">\{</span> <span class="tsd-kind-property">\$schema</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span> <span class="tsd-signature-symbol">\[</span><span class="tsd-kind-index-signature">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <span class="tsd-signature-type">unknown</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#tool-annotations">annotations</a><span class="tsd-signature-symbol">?:</span> <a href="#toolannotations" class="tsd-signature-type tsd-kind-interface">ToolAnnotations</a><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#tool-_meta">\_meta</a><span class="tsd-signature-symbol">?:</span> <a href="#metaobject" class="tsd-signature-type tsd-kind-type-alias">MetaObject</a><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Definition for a tool the client can call.</p> </div><div class="tsd-comment tsd-typography"><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: With default 2020-12 input schema<a href="#tool-example-with-default-2020-12-input-schema" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="tool-example-with-default-2020-12-input-schema"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"name"</span><span class="hl-0">: </span><span class="hl-2">"calculate\_sum"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"description"</span><span class="hl-0">: </span><span class="hl-2">"Add two numbers"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"inputSchema"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"object"</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"properties"</span><span class="hl-0">: \{</span><br /><span class="hl-0">      </span><span class="hl-1">"a"</span><span class="hl-0">: \{ </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"number"</span><span class="hl-0"> },</span><br /><span class="hl-0">      </span><span class="hl-1">"b"</span><span class="hl-0">: \{ </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"number"</span><span class="hl-0"> }</span><br /><span class="hl-0">    },</span><br /><span class="hl-0">    </span><span class="hl-1">"required"</span><span class="hl-0">: \[</span><span class="hl-2">"a"</span><span class="hl-0">, </span><span class="hl-2">"b"</span><span class="hl-0">]</span><br /><span class="hl-0">  }</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: With explicit draft-07 input schema<a href="#tool-example-with-explicit-draft-07-input-schema" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="tool-example-with-explicit-draft-07-input-schema"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"name"</span><span class="hl-0">: </span><span class="hl-2">"calculate\_sum"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"description"</span><span class="hl-0">: </span><span class="hl-2">"Add two numbers"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"inputSchema"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"\$schema"</span><span class="hl-0">: </span><span class="hl-2">"[http://json-schema.org/draft-07/schema#](http://json-schema.org/draft-07/schema#)"</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"object"</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"properties"</span><span class="hl-0">: \{</span><br /><span class="hl-0">      </span><span class="hl-1">"a"</span><span class="hl-0">: \{ </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"number"</span><span class="hl-0"> },</span><br /><span class="hl-0">      </span><span class="hl-1">"b"</span><span class="hl-0">: \{ </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"number"</span><span class="hl-0"> }</span><br /><span class="hl-0">    },</span><br /><span class="hl-0">    </span><span class="hl-1">"required"</span><span class="hl-0">: \[</span><span class="hl-2">"a"</span><span class="hl-0">, </span><span class="hl-2">"b"</span><span class="hl-0">]</span><br /><span class="hl-0">  }</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: With no parameters<a href="#tool-example-with-no-parameters" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="tool-example-with-no-parameters"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"name"</span><span class="hl-0">: </span><span class="hl-2">"get\_current\_time"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"description"</span><span class="hl-0">: </span><span class="hl-2">"Returns the current server time"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"inputSchema"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"object"</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"additionalProperties"</span><span class="hl-0">: </span><span class="hl-5">false</span><br /><span class="hl-0">  }</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details><details class="tsd-tag-example"><summary class="tsd-anchor-link">Example: With output schema for structured content<a href="#tool-example-with-output-schema-for-structured-content" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></summary><pre id="tool-example-with-output-schema-for-structured-content"><code class="json"><span class="hl-0">\{</span><br /><span class="hl-0">  </span><span class="hl-1">"name"</span><span class="hl-0">: </span><span class="hl-2">"get\_weather\_data"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"title"</span><span class="hl-0">: </span><span class="hl-2">"Weather Data Retriever"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"description"</span><span class="hl-0">: </span><span class="hl-2">"Get current weather data for a location"</span><span class="hl-0">,</span><br /><span class="hl-0">  </span><span class="hl-1">"inputSchema"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"object"</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"properties"</span><span class="hl-0">: \{</span><br /><span class="hl-0">      </span><span class="hl-1">"location"</span><span class="hl-0">: \{</span><br /><span class="hl-0">        </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"string"</span><span class="hl-0">,</span><br /><span class="hl-0">        </span><span class="hl-1">"description"</span><span class="hl-0">: </span><span class="hl-2">"City name or zip code"</span><br /><span class="hl-0">      }</span><br /><span class="hl-0">    },</span><br /><span class="hl-0">    </span><span class="hl-1">"required"</span><span class="hl-0">: \[</span><span class="hl-2">"location"</span><span class="hl-0">]</span><br /><span class="hl-0">  },</span><br /><span class="hl-0">  </span><span class="hl-1">"outputSchema"</span><span class="hl-0">: \{</span><br /><span class="hl-0">    </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"object"</span><span class="hl-0">,</span><br /><span class="hl-0">    </span><span class="hl-1">"properties"</span><span class="hl-0">: \{</span><br /><span class="hl-0">      </span><span class="hl-1">"temperature"</span><span class="hl-0">: \{</span><br /><span class="hl-0">        </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"number"</span><span class="hl-0">,</span><br /><span class="hl-0">        </span><span class="hl-1">"description"</span><span class="hl-0">: </span><span class="hl-2">"Temperature in celsius"</span><br /><span class="hl-0">      },</span><br /><span class="hl-0">      </span><span class="hl-1">"conditions"</span><span class="hl-0">: \{</span><br /><span class="hl-0">        </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"string"</span><span class="hl-0">,</span><br /><span class="hl-0">        </span><span class="hl-1">"description"</span><span class="hl-0">: </span><span class="hl-2">"Weather conditions description"</span><br /><span class="hl-0">      },</span><br /><span class="hl-0">      </span><span class="hl-1">"humidity"</span><span class="hl-0">: \{</span><br /><span class="hl-0">        </span><span class="hl-1">"type"</span><span class="hl-0">: </span><span class="hl-2">"number"</span><span class="hl-0">,</span><br /><span class="hl-0">        </span><span class="hl-1">"description"</span><span class="hl-0">: </span><span class="hl-2">"Humidity percentage"</span><br /><span class="hl-0">      }</span><br /><span class="hl-0">    },</span><br /><span class="hl-0">    </span><span class="hl-1">"required"</span><span class="hl-0">: \[</span><span class="hl-2">"temperature"</span><span class="hl-0">, </span><span class="hl-2">"conditions"</span><span class="hl-0">, </span><span class="hl-2">"humidity"</span><span class="hl-0">]</span><br /><span class="hl-0">  }</span><br /><span class="hl-0">}</span> </code><button type="button">Copy</button></pre> </details></div><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="tool-icons" data-typedoc-h="3"><span>icons?: Icon\[]</span><a href="#tool-icons" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><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 class="tsd-sources"><p>Inherited from Icons.icons</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="tool-name" data-typedoc-h="3"><span>name: string</span><a href="#tool-name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><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 class="tsd-sources"><p>Inherited from BaseMetadata.name</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><div class="tsd-anchor-link" id="tool-title" data-typedoc-h="3"><span>title?: string</span><a href="#tool-title" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><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 <a href="#" class="tsd-kind-interface">Tool</a>,
  where <code>annotations.title</code> should be given precedence over using <code>name</code>,
  if present).</p> </div><aside class="tsd-sources"><p>Inherited from BaseMetadata.title</p></aside></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="tool-description" data-typedoc-h="3"><span>description?: string</span><a href="#tool-description" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><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 class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="tool-inputschema" data-typedoc-h="3"><span>inputSchema: \{ \$schema?: string; type: "object"; \[key: string]: unknown }</span><a href="#tool-inputschema" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>A JSON Schema object defining the expected parameters for the tool.</p> <p>Tool arguments are always JSON objects, so <code>type: "object"</code> is required at the root.
  Beyond that, any JSON Schema 2020-12 keyword may appear alongside <code>type</code> — including
  composition keywords (<code>oneOf</code>, <code>anyOf</code>, <code>allOf</code>, <code>not</code>), conditional keywords
  (<code>if</code>/<code>then</code>/<code>else</code>), reference keywords (<code>\$ref</code>, <code>\$defs</code>, <code>\$anchor</code>), and any other
  standard validation or annotation keywords.</p> <p>Defaults to JSON Schema 2020-12 when no explicit <code>\$schema</code> is provided.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="tool-outputschema" data-typedoc-h="3"><span>outputSchema?: \{ \$schema?: string; \[key: string]: unknown }</span><a href="#tool-outputschema" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>An optional JSON Schema object defining the structure of the tool's output returned in
  the structuredContent field of a <a href="#calltoolresult" class="tsd-kind-interface">CallToolResult</a>. This can be any valid JSON Schema 2020-12.</p> <p>Defaults to JSON Schema 2020-12 when no explicit <code>\$schema</code> is provided.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="tool-annotations" data-typedoc-h="3"><span>annotations?: ToolAnnotations</span><a href="#tool-annotations" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>Optional additional tool information.</p> <p>Display name precedence order is: <code>title</code>, <code>annotations.title</code>, then <code>name</code>.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="tool-_meta" data-typedoc-h="3"><span>\_meta?: MetaObject</span><a href="#tool-_meta" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div></section>
</div>

<div class="type">
  ### `ToolAnnotations`

  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ToolAnnotations</span> <span class="tsd-signature-symbol">\{</span><br />  <a class="tsd-kind-property" href="#toolannotations-title">title</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#toolannotations-readonlyhint">readOnlyHint</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#toolannotations-destructivehint">destructiveHint</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#toolannotations-idempotenthint">idempotentHint</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br />  <a class="tsd-kind-property" href="#toolannotations-openworldhint">openWorldHint</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br /><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Additional properties describing a <a href="#tool" class="tsd-kind-interface">Tool</a> to clients.</p> <p>NOTE: all properties in <code>ToolAnnotations</code> 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 <code>ToolAnnotations</code>
  received from untrusted servers.</p> </div><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="toolannotations-title" data-typedoc-h="3"><span>title?: string</span><a href="#toolannotations-title" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>A human-readable title for the tool.</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="toolannotations-readonlyhint" data-typedoc-h="3"><span>readOnlyHint?: boolean</span><a href="#toolannotations-readonlyhint" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><p>If true, the tool does not modify its environment.</p> <p>Default: false</p> </div></section><section class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="toolannotations-destructivehint" data-typedoc-h="3"><span>destructiveHint?: boolean</span><a href="#toolannotations-destructivehint" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><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 class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="toolannotations-idempotenthint" data-typedoc-h="3"><span>idempotentHint?: boolean</span><a href="#toolannotations-idempotenthint" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><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 class="tsd-panel tsd-member"><div class="tsd-anchor-link" id="toolannotations-openworldhint" data-typedoc-h="3"><span>openWorldHint?: boolean</span><a href="#toolannotations-openworldhint" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor" /></svg></a></div><div class="tsd-comment tsd-typography"><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>
