@chilkat/react-native 11.6.1

package/src/specs/Mcp.nitro.ts

@@ -0,0 +1,491 @@
+// Generated by ReactNativeNs.RnGenerator -- do not edit.
+import type { HybridObject } from 'react-native-nitro-modules'
+import type { JsonObject } from './JsonObject.nitro'
+import type { Socket } from './Socket.nitro'
+
+/**
+ * A client for the Model Context Protocol (MCP).
+ *
+ * `Mcp` connects to an MCP server and gives an application access to the
+ * server's **tools**, **resources**, and **prompts**
+ * over a single, unified API.  MCP is an open protocol that standardizes how applications
+ * supply context and callable tools to AI models.
+ *
+ * **Connect & handshake**
+ *
+ * {@link Mcp.connect} opens a Streamable HTTP session and performs
+ * the MCP `initialize` handshake, negotiating the protocol version and
+ * establishing a session id.
+ *
+ * **Tools**
+ *
+ * List the server's tools with {@link Mcp.listTools} and invoke
+ * them with {@link Mcp.callTool}.
+ *
+ * **Resources & prompts**
+ *
+ * Read resources with {@link Mcp.listResources} and
+ * {@link Mcp.readResource}, and fetch prompts with
+ * {@link Mcp.listPrompts} and
+ * {@link Mcp.getPrompt}.
+ *
+ * **Use with Chilkat.Ai**
+ *
+ * Pass a connected `Mcp` to `Chilkat.Ai.UseMcp` to register the
+ * server's tools with an AI model.  During a conversation the model's tool calls are
+ * routed to the MCP server automatically.
+ *
+ * **Transport:** This class uses the MCP `Streamable HTTP` transport
+ * (protocol version `2025-06-18`).  A server response may arrive as a single JSON
+ * object or as a Server-Sent-Events stream; both are handled transparently.  The stdio
+ * transport is not supported.
+ *
+ * **Authentication:** If the MCP server requires authorization, set the
+ * {@link Mcp.authToken} property before calling
+ * {@link Mcp.connect}.  Chilkat then sends it as an
+ * `Authorization: Bearer <token>` header on every request.  Leave it
+ * unset for servers that do not require authentication.
+ *
+ * **Pagination:** When a server has more items than fit in a single response,
+ * the `tools/list`, `resources/list`, and `prompts/list`
+ * results include a `nextCursor` string.  In this release the list methods
+ * return the first page only and do not accept a cursor argument, so `nextCursor`
+ * is informational.
+ *
+ * Each `Mcp` instance owns a native Chilkat object. It is released when the JavaScript object is
+ * garbage collected, or immediately by `dispose()`; any use after `dispose()` throws.
+ * Create one with `new Mcp()`.
+ *
+ * Methods that can take a while (network, files, compression, key generation) also have an
+ * `...Async` form returning a `Promise`; it runs on a native worker thread so the UI keeps
+ * rendering. While such a call is pending, every other call on this object throws, except
+ * {@link Mcp.abort} and assigning {@link Mcp.onPercentDone} / {@link Mcp.onProgressInfo}.
+ */
+export interface Mcp extends HybridObject<{ ios: 'c++', android: 'c++' }> {
+  // ---- Properties ----
+
+  /**
+   * Provides HTML-formatted information about the last called method or property. If a method call
+   * fails or behaves unexpectedly, check this property for details. Note that information is
+   * available regardless of the method call's success.
+   *
+   * This property is read-only.
+   */
+  readonly lastErrorHtml: string
+
+  /**
+   * Provides plain text information about the last called method or property. If a method call
+   * fails or behaves unexpectedly, check this property for details. Note that information is
+   * available regardless of the method call's success.
+   *
+   * This property is read-only.
+   */
+  readonly lastErrorText: string
+
+  /**
+   * Provides XML-formatted information about the last called method or property. If a method call
+   * fails or behaves unexpectedly, check this property for details. Note that information is
+   * available regardless of the method call's success.
+   *
+   * This property is read-only.
+   */
+  readonly lastErrorXml: string
+
+  /**
+   * Version of the component/library, such as "10.1.0"
+   *
+   * This property is read-only.
+   */
+  readonly version: string
+
+  /**
+   * If set to a file path, this property logs the LastErrorText of each Chilkat method or property
+   * call to the specified file. This logging helps identify the context and history of Chilkat
+   * calls leading up to any crash or hang, aiding in debugging.
+   *
+   * Enabling the VerboseLogging property provides more detailed information.
+   *
+   * This property is mainly used for debugging rare instances where a Chilkat method call causes a
+   * hang or crash, which should generally not happen.
+   *
+   * Possible causes of hangs include:
+   *
+   * - A timeout property set to 0, indicating an infinite timeout.
+   *
+   * - A hang occurring within an event callback in the application code.
+   *
+   * - An internal bug in the Chilkat code causing the hang.
+   */
+  debugLogFilePath: string
+
+  /**
+   * If set to `true`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may
+   * contain more verbose information. The default value is `false`. Verbose logging should only be
+   * used for debugging. The potentially large quantity of logged information may adversely affect
+   * peformance.
+   */
+  verboseLogging: boolean
+
+  /**
+   * Indicates the success or failure of the most recent method call: `true` means success, `false`
+   * means failure. This property remains unchanged by property setters or getters. This method is
+   * present to address challenges in checking for null or Nothing returns in certain programming
+   * languages. Note: This property does not apply to methods that return integer values or to
+   * boolean-returning methods where the boolean does not indicate success or failure.
+   */
+  lastMethodSuccess: boolean
+
+  /**
+   * An optional bearer token for authenticating to the MCP server. When set, it is sent as an
+   * `Authorization: Bearer <token>` header on every request. The default is the empty string.
+   */
+  authToken: string
+
+  /**
+   * Read-only. The `Mcp-Session-Id` assigned by the server during the {@link Mcp.connect}
+   * handshake, or the empty string if the server is stateless. Chilkat automatically includes this
+   * session id on all subsequent requests.
+   *
+   * This property is read-only.
+   */
+  readonly sessionId: string
+
+  /**
+   * The MCP protocol version. May be set before {@link Mcp.connect} to request a specific version;
+   * after {@link Mcp.connect} it reflects the version negotiated with the server and is sent in the
+   * `MCP-Protocol-Version` header of each request. The default is `2025-06-18`.
+   */
+  protocolVersion: string
+
+  /**
+   * Read-only. The server name reported in the `initialize` result, available after {@link
+   * Mcp.connect}.
+   *
+   * This property is read-only.
+   */
+  readonly serverName: string
+
+  /**
+   * Read-only. The server version reported in the `initialize` result, available after {@link
+   * Mcp.connect}.
+   *
+   * This property is read-only.
+   */
+  readonly serverVersion: string
+
+  /**
+   * Read-only. Optional usage instructions provided by the server in the `initialize` result (may
+   * be the empty string), available after {@link Mcp.connect}.
+   *
+   * This property is read-only.
+   */
+  readonly serverInstructions: string
+
+  /**
+   * Read-only. `true` after a successful {@link Mcp.connect} (the `initialize` handshake
+   * completed).
+   *
+   * This property is read-only.
+   */
+  readonly connected: boolean
+
+  /**
+   * The maximum amount of time, in milliseconds, to wait for additional incoming data when
+   * receiving a response has paused. This is not a total timeout. The default value is `180000`
+   * (180 seconds).
+   */
+  idleTimeoutMs: number
+
+  /**
+   * The maximum amount of time, in milliseconds, to wait to establish the TCP/TLS connection to the
+   * MCP server. The default value is `30000` (30 seconds).
+   */
+  connectTimeoutMs: number
+
+  /**
+   * The interval in milliseconds between each `AbortCheck` event callback, which enables an
+   * application to abort a method before it completes. **By default, HeartbeatMs is **`0`**,
+   * meaning no AbortCheck event callbacks fire.**
+   */
+  heartbeatMs: number
+
+  // ---- Methods ----
+
+  /**
+   * Connects to the MCP (Model Context Protocol) server at the Streamable HTTP endpoint URL in
+   * `url` (for example `https://example.com/mcp`) and performs the MCP `initialize` handshake.
+   *
+   * On success, the {@link Mcp.sessionId}, {@link Mcp.protocolVersion}, {@link Mcp.serverName},
+   * {@link Mcp.serverVersion}, and {@link Mcp.serverInstructions} properties are populated, and
+   * {@link Mcp.connected} becomes `true`.
+   *
+   * If an {@link Mcp.authToken} is set, it is sent as a bearer token on the request. The URL must
+   * begin with `http://` or `https://`; the host, port, and path are taken from it. Only the
+   * Streamable HTTP transport is supported; the stdio transport is not.
+   *
+   * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
+   * {@link Mcp.connectAsync}.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Mcp.lastErrorText}.
+   */
+  connect(url: string): void
+
+  /**
+   * Asynchronous form of {@link Mcp.connect}: the same call on a native worker thread,
+   * settling on the JavaScript thread. While it is pending, other calls on this object throw,
+   * except {@link Mcp.abort} (which cancels it) and the {@link Mcp.onPercentDone} /
+   * {@link Mcp.onProgressInfo} callbacks, which report progress while it runs.
+   *
+   * The promise rejects with an Error if the call fails; the full log is in
+   * {@link Mcp.lastErrorText}.
+   */
+  connectAsync(url: string): Promise<void>
+
+  /**
+   * Explicitly terminates the MCP session by sending an HTTP `DELETE` with the `Mcp-Session-Id`
+   * header, then releases the connection. It is safe to call this method when not connected (it
+   * simply releases any transport). A server that does not permit client-terminated sessions
+   * responds with HTTP `405`, which is not treated as an error.
+   *
+   * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
+   * {@link Mcp.closeAsync}.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Mcp.lastErrorText}.
+   */
+  close(): void
+
+  /**
+   * Asynchronous form of {@link Mcp.close}: the same call on a native worker thread,
+   * settling on the JavaScript thread. While it is pending, other calls on this object throw,
+   * except {@link Mcp.abort} (which cancels it) and the {@link Mcp.onPercentDone} /
+   * {@link Mcp.onProgressInfo} callbacks, which report progress while it runs.
+   *
+   * The promise rejects with an Error if the call fails; the full log is in
+   * {@link Mcp.lastErrorText}.
+   */
+  closeAsync(): Promise<void>
+
+  /**
+   * Calls the MCP `tools/list` method. On success, the server's result object is placed in `json`,
+   * containing a `tools` array in which each tool has a `name`, a `description`, and an
+   * `inputSchema` (a JSON Schema describing the tool's arguments), and possibly a `nextCursor` for
+   * pagination.
+   *
+   * {@link Mcp.connect} must be called first.
+   *
+   * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
+   * {@link Mcp.listToolsAsync}.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Mcp.lastErrorText}.
+   */
+  listTools(json: JsonObject): void
+
+  /**
+   * Asynchronous form of {@link Mcp.listTools}: the same call on a native worker thread,
+   * settling on the JavaScript thread. While it is pending, other calls on this object throw,
+   * except {@link Mcp.abort} (which cancels it) and the {@link Mcp.onPercentDone} /
+   * {@link Mcp.onProgressInfo} callbacks, which report progress while it runs.
+   *
+   * The promise rejects with an Error if the call fails; the full log is in
+   * {@link Mcp.lastErrorText}.
+   */
+  listToolsAsync(json: JsonObject): Promise<void>
+
+  /**
+   * Calls the MCP `tools/call` method for the tool named `name`, passing the JSON arguments object
+   * in `argsJson`. The members of `argsJson` are the tool's input arguments and should match the
+   * tool's `inputSchema` as returned by {@link Mcp.listTools}. For example, a weather tool might be
+   * called with the arguments `{ "location": "Boston, MA", "units": "fahrenheit" }`. Pass an empty
+   * JSON object (not a null) for a tool that takes no arguments.
+   *
+   * On success, the tool result is placed in `resultJson`. It contains a `content` array, an
+   * `isError` boolean, and optionally a `structuredContent` object. Each element of the `content`
+   * array has a `type` (`"text"`, `"image"`, `"audio"`, or `"resource"`); for a `"text"` element
+   * the value is in its `text` member. A typical result looks like:
+   *
+   * ```
+   * {
+   *   "content": [ { "type": "text", "text": "The weather in Boston is 72F and sunny." } ],
+   *   "isError": false
+   * }
+   * ```
+   *
+   * Thus the text of the first content item is at JSON path `content[0].text`.
+   *
+   * **Note:** A tool that executes but reports a failure returns `true` here with `isError` set to
+   * `true` in `resultJson` (the failure message is typically carried in the `content` array). The
+   * return value is `false` only for transport- or protocol-level failures.
+   *
+   * {@link Mcp.connect} must be called first.
+   *
+   * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
+   * {@link Mcp.callToolAsync}.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Mcp.lastErrorText}.
+   */
+  callTool(name: string, argsJson: JsonObject, resultJson: JsonObject): void
+
+  /**
+   * Asynchronous form of {@link Mcp.callTool}: the same call on a native worker thread,
+   * settling on the JavaScript thread. While it is pending, other calls on this object throw,
+   * except {@link Mcp.abort} (which cancels it) and the {@link Mcp.onPercentDone} /
+   * {@link Mcp.onProgressInfo} callbacks, which report progress while it runs.
+   *
+   * The promise rejects with an Error if the call fails; the full log is in
+   * {@link Mcp.lastErrorText}.
+   */
+  callToolAsync(name: string, argsJson: JsonObject, resultJson: JsonObject): Promise<void>
+
+  /**
+   * Calls the MCP `resources/list` method. On success, the server's result object is placed in
+   * `json`, containing a `resources` array in which each resource has a `uri`, a `name`, and
+   * optionally a `description` and `mimeType`, and possibly a `nextCursor` for pagination.
+   *
+   * {@link Mcp.connect} must be called first.
+   *
+   * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
+   * {@link Mcp.listResourcesAsync}.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Mcp.lastErrorText}.
+   */
+  listResources(json: JsonObject): void
+
+  /**
+   * Asynchronous form of {@link Mcp.listResources}: the same call on a native worker thread,
+   * settling on the JavaScript thread. While it is pending, other calls on this object throw,
+   * except {@link Mcp.abort} (which cancels it) and the {@link Mcp.onPercentDone} /
+   * {@link Mcp.onProgressInfo} callbacks, which report progress while it runs.
+   *
+   * The promise rejects with an Error if the call fails; the full log is in
+   * {@link Mcp.lastErrorText}.
+   */
+  listResourcesAsync(json: JsonObject): Promise<void>
+
+  /**
+   * Calls the MCP `resources/read` method for the resource identified by the URI in `uri`. On
+   * success, the result is placed in `json`, containing a `contents` array whose entries carry a
+   * `uri`, a `mimeType`, and either `text` (for text resources) or `blob` (base64 for binary
+   * resources).
+   *
+   * {@link Mcp.connect} must be called first.
+   *
+   * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
+   * {@link Mcp.readResourceAsync}.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Mcp.lastErrorText}.
+   */
+  readResource(uri: string, json: JsonObject): void
+
+  /**
+   * Asynchronous form of {@link Mcp.readResource}: the same call on a native worker thread,
+   * settling on the JavaScript thread. While it is pending, other calls on this object throw,
+   * except {@link Mcp.abort} (which cancels it) and the {@link Mcp.onPercentDone} /
+   * {@link Mcp.onProgressInfo} callbacks, which report progress while it runs.
+   *
+   * The promise rejects with an Error if the call fails; the full log is in
+   * {@link Mcp.lastErrorText}.
+   */
+  readResourceAsync(uri: string, json: JsonObject): Promise<void>
+
+  /**
+   * Calls the MCP `prompts/list` method. On success, the server's result object is placed in
+   * `json`, containing a `prompts` array in which each prompt has a `name`, optionally a
+   * `description`, and an `arguments` array, and possibly a `nextCursor` for pagination.
+   *
+   * {@link Mcp.connect} must be called first.
+   *
+   * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
+   * {@link Mcp.listPromptsAsync}.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Mcp.lastErrorText}.
+   */
+  listPrompts(json: JsonObject): void
+
+  /**
+   * Asynchronous form of {@link Mcp.listPrompts}: the same call on a native worker thread,
+   * settling on the JavaScript thread. While it is pending, other calls on this object throw,
+   * except {@link Mcp.abort} (which cancels it) and the {@link Mcp.onPercentDone} /
+   * {@link Mcp.onProgressInfo} callbacks, which report progress while it runs.
+   *
+   * The promise rejects with an Error if the call fails; the full log is in
+   * {@link Mcp.lastErrorText}.
+   */
+  listPromptsAsync(json: JsonObject): Promise<void>
+
+  /**
+   * Calls the MCP `prompts/get` method for the prompt named `name`, passing the JSON arguments
+   * object in `argsJson` (pass an empty object for a prompt that takes no arguments). On success,
+   * the result is placed in `json`, consisting of an optional `description` and a `messages` array
+   * in which each message has a `role` and `content`.
+   *
+   * {@link Mcp.connect} must be called first.
+   *
+   * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
+   * {@link Mcp.getPromptAsync}.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Mcp.lastErrorText}.
+   */
+  getPrompt(name: string, argsJson: JsonObject, json: JsonObject): void
+
+  /**
+   * Asynchronous form of {@link Mcp.getPrompt}: the same call on a native worker thread,
+   * settling on the JavaScript thread. While it is pending, other calls on this object throw,
+   * except {@link Mcp.abort} (which cancels it) and the {@link Mcp.onPercentDone} /
+   * {@link Mcp.onProgressInfo} callbacks, which report progress while it runs.
+   *
+   * The promise rejects with an Error if the call fails; the full log is in
+   * {@link Mcp.lastErrorText}.
+   */
+  getPromptAsync(name: string, argsJson: JsonObject, json: JsonObject): Promise<void>
+
+  /**
+   * Copies connection settings, including HTTP proxy, SOCKS proxy, bind (network interface) IP
+   * address, and TLS options, from `sock`. This is optional; if not used, default settings apply.
+   * Call this method before {@link Mcp.connect}.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Mcp.lastErrorText}.
+   */
+  setConnectionSettings(sock: Socket): void
+
+  /**
+   * Returns, in `json`, the complete JSON-RPC response envelope from the most recent request (the
+   * `jsonrpc`, `id`, and `result` or `error` members), for diagnostics and logging. Note that this
+   * is the full JSON-RPC envelope, whereas {@link Mcp.listTools}, {@link Mcp.callTool}, {@link
+   * Mcp.readResource}, and {@link Mcp.getPrompt} each return only the inner `result` object.
+   */
+  getLastJsonData(json: JsonObject): void
+
+  // ---- Events (ReactNativeGen_DESIGN.md §6) ----
+
+  /**
+   * Called with the percent completed (0..100) while a long-running method runs, when Chilkat
+   * can measure progress. Runs on the JavaScript thread, so it is only useful with the
+   * `...Async` methods (during a synchronous call the thread is busy and the events arrive
+   * after it returns). Assign `undefined` to remove.
+   */
+  onPercentDone?: (pctDone: number) => void
+
+  /**
+   * Called with a name/value pair of progress information while a long-running method runs
+   * (what is reported depends on the class and method). Runs on the JavaScript thread; see
+   * {@link Mcp.onPercentDone}. Assign `undefined` to remove.
+   */
+  onProgressInfo?: (name: string, value: string) => void
+
+  /**
+   * Requests that the pending `...Async` call on this object stop at its next progress check.
+   * The promise then rejects with Chilkat's abort error. Chilkat checks at least every
+   * `heartbeatMs` milliseconds on the classes that have that property, so set it (e.g. 250)
+   * for a responsive cancel. Harmless when nothing is pending.
+   */
+  abort(): void
+}