---
product: Chilkat
product_version: 11.7.0
language: xojo
language_label: Xojo
class: Mcp
license: bundle
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/xojoMcpRef.html
---
# Chilkat Mcp — Xojo — v11.7.0

> Chilkat 11.7.0 · language=xojo · class=Mcp
> Other versions: replace `11.7.0` in this URL. Other languages: `https://www.chilkatsoft.com/ai-docs/v/11.7.0/<lang>/classes/Mcp.md`.
> Language-wide rules (install, unlock, error model, strings/bytes): `https://www.chilkatsoft.com/ai-docs/v/11.7.0/xojo/guide.md`.

## Purpose

**A client for the Model Context Protocol (MCP).**

`Chilkat.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**

`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 `ListTools` and invoke them with `CallTool`.

**Resources & prompts**

Read resources with `ListResources` and `ReadResource`, and fetch prompts with `ListPrompts` and `GetPrompt`.

**Use with Chilkat.Ai**

Pass a connected `Chilkat.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 `AuthToken` property before calling `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.

## Object creation, unlocking and error handling

**Object Creation**

```xojo
Dim mcp As New Chilkat.Mcp
```

Call `Global.UnlockBundle` once at the start of the program, before using this or any other Chilkat class. Any string unlocks a fully functional 30-day trial; a purchased unlock code is used in production. See `guide.md` for the exact code in Xojo.

How failure is reported depends on the method's return type and is stated in the note under each method below. In every case the diagnostic text is in the `LastErrorText` property of the object whose method was called.

## Members common to every Chilkat class

Documented once per language in `common-members.md`; listed here so this page is self-contained.

| Property | Signature | Access | Meaning |
|---|---|---|---|
| `DebugLogFilePath` | `DebugLogFilePath As String` | read/write | If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. |
| `LastErrorHtml` | `LastErrorHtml As String (read-only)` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `LastErrorText As String (read-only)` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `LastErrorXml As String (read-only)` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `LastMethodSuccess As Boolean` | read/write | Indicates the success or failure of the most recent method call: `True` means success, `False` means failure. |
| `VerboseLogging` | `VerboseLogging As Boolean` | read/write | If set to `True`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `Version As String (read-only)` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `AuthToken` | property, read/write | `AuthToken As String` |
| `Connected` | property, read-only | `Connected As Boolean (read-only)` |
| `ConnectTimeoutMs` | property, read/write | `ConnectTimeoutMs As Int32` |
| `HeartbeatMs` | property, read/write | `HeartbeatMs As Int32` |
| `IdleTimeoutMs` | property, read/write | `IdleTimeoutMs As Int32` |
| `ProtocolVersion` | property, read/write | `ProtocolVersion As String` |
| `ServerInstructions` | property, read-only | `ServerInstructions As String (read-only)` |
| `ServerName` | property, read-only | `ServerName As String (read-only)` |
| `ServerVersion` | property, read-only | `ServerVersion As String (read-only)` |
| `SessionId` | property, read-only | `SessionId As String (read-only)` |
| `CallTool` | method | `Function CallTool(name As String, argsJson As Chilkat.JsonObject, resultJson As Chilkat.JsonObject) As Boolean` |
| `Close` | method | `Function Close() As Boolean` |
| `Connect` | method | `Function Connect(url As String) As Boolean` |
| `GetLastJsonData` | method | `Sub GetLastJsonData(json As Chilkat.JsonObject)` |
| `GetPrompt` | method | `Function GetPrompt(name As String, argsJson As Chilkat.JsonObject, json As Chilkat.JsonObject) As Boolean` |
| `ListPrompts` | method | `Function ListPrompts(json As Chilkat.JsonObject) As Boolean` |
| `ListResources` | method | `Function ListResources(json As Chilkat.JsonObject) As Boolean` |
| `ListTools` | method | `Function ListTools(json As Chilkat.JsonObject) As Boolean` |
| `ReadResource` | method | `Function ReadResource(uri As String, json As Chilkat.JsonObject) As Boolean` |
| `SetConnectionSettings` | method | `Function SetConnectionSettings(sock As Chilkat.Socket) As Boolean` |

## Properties

### Mcp.AuthToken

`Chilkat 11.7.0 · xojo · Mcp · AuthToken · property · read/write · since 11.6.0`

```xojo
AuthToken As String
```

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.

### Mcp.Connected

`Chilkat 11.7.0 · xojo · Mcp · Connected · property · read-only · since 11.6.0`

```xojo
Connected As Boolean (read-only)
```

Read-only. `True` after a successful `Connect` (the `initialize` handshake completed).

### Mcp.ConnectTimeoutMs

`Chilkat 11.7.0 · xojo · Mcp · ConnectTimeoutMs · property · read/write · since 11.6.0`

```xojo
ConnectTimeoutMs As Int32
```

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).

### Mcp.HeartbeatMs

`Chilkat 11.7.0 · xojo · Mcp · HeartbeatMs · property · read/write · since 11.6.0`

```xojo
HeartbeatMs As Int32
```

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.**

### Mcp.IdleTimeoutMs

`Chilkat 11.7.0 · xojo · Mcp · IdleTimeoutMs · property · read/write · since 11.6.0`

```xojo
IdleTimeoutMs As Int32
```

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).

### Mcp.ProtocolVersion

`Chilkat 11.7.0 · xojo · Mcp · ProtocolVersion · property · read/write · since 11.6.0`

```xojo
ProtocolVersion As String
```

The MCP protocol version. May be set before `Connect` to request a specific version; after `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`.

### Mcp.ServerInstructions

`Chilkat 11.7.0 · xojo · Mcp · ServerInstructions · property · read-only · since 11.6.0`

```xojo
ServerInstructions As String (read-only)
```

Read-only. Optional usage instructions provided by the server in the `initialize` result (may be the empty string), available after `Connect`.

### Mcp.ServerName

`Chilkat 11.7.0 · xojo · Mcp · ServerName · property · read-only · since 11.6.0`

```xojo
ServerName As String (read-only)
```

Read-only. The server name reported in the `initialize` result, available after `Connect`.

### Mcp.ServerVersion

`Chilkat 11.7.0 · xojo · Mcp · ServerVersion · property · read-only · since 11.6.0`

```xojo
ServerVersion As String (read-only)
```

Read-only. The server version reported in the `initialize` result, available after `Connect`.

### Mcp.SessionId

`Chilkat 11.7.0 · xojo · Mcp · SessionId · property · read-only · since 11.6.0`

```xojo
SessionId As String (read-only)
```

Read-only. The `Mcp-Session-Id` assigned by the server during the `Connect` handshake, or the empty string if the server is stateless. Chilkat automatically includes this session id on all subsequent requests.

## Methods

### Mcp.CallTool

`Chilkat 11.7.0 · xojo · Mcp · CallTool · method · since 11.6.0`

```xojo
Function CallTool(name As String, argsJson As Chilkat.JsonObject, resultJson As Chilkat.JsonObject) As Boolean
```

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 `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.

`Connect` must be called first.

Returns True for success, False for failure.

Async variant: `CallToolAsync` — same arguments, returns a `Task` (see Async variants below).

### Mcp.Close

`Chilkat 11.7.0 · xojo · Mcp · Close · method · since 11.6.0`

```xojo
Function Close() As Boolean
```

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.

Returns True for success, False for failure.

Async variant: `CloseAsync` — same arguments, returns a `Task` (see Async variants below).

### Mcp.Connect

`Chilkat 11.7.0 · xojo · Mcp · Connect · method · since 11.6.0`

```xojo
Function Connect(url As String) As Boolean
```

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 `SessionId`, `ProtocolVersion`, `ServerName`, `ServerVersion`, and `ServerInstructions` properties are populated, and `Connected` becomes `True`.

If an `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.

Returns True for success, False for failure.

Async variant: `ConnectAsync` — same arguments, returns a `Task` (see Async variants below).

### Mcp.GetLastJsonData

`Chilkat 11.7.0 · xojo · Mcp · GetLastJsonData · method · since 11.6.0`

```xojo
Sub GetLastJsonData(json As Chilkat.JsonObject)
```

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 `ListTools`, `CallTool`, `ReadResource`, and `GetPrompt` each return only the inner `result` object.

### Mcp.GetPrompt

`Chilkat 11.7.0 · xojo · Mcp · GetPrompt · method · since 11.6.0`

```xojo
Function GetPrompt(name As String, argsJson As Chilkat.JsonObject, json As Chilkat.JsonObject) As Boolean
```

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`.

`Connect` must be called first.

Returns True for success, False for failure.

Async variant: `GetPromptAsync` — same arguments, returns a `Task` (see Async variants below).

### Mcp.ListPrompts

`Chilkat 11.7.0 · xojo · Mcp · ListPrompts · method · since 11.6.0`

```xojo
Function ListPrompts(json As Chilkat.JsonObject) As Boolean
```

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.

`Connect` must be called first.

Returns True for success, False for failure.

Async variant: `ListPromptsAsync` — same arguments, returns a `Task` (see Async variants below).

### Mcp.ListResources

`Chilkat 11.7.0 · xojo · Mcp · ListResources · method · since 11.6.0`

```xojo
Function ListResources(json As Chilkat.JsonObject) As Boolean
```

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.

`Connect` must be called first.

Returns True for success, False for failure.

Async variant: `ListResourcesAsync` — same arguments, returns a `Task` (see Async variants below).

### Mcp.ListTools

`Chilkat 11.7.0 · xojo · Mcp · ListTools · method · since 11.6.0`

```xojo
Function ListTools(json As Chilkat.JsonObject) As Boolean
```

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.

`Connect` must be called first.

Returns True for success, False for failure.

Async variant: `ListToolsAsync` — same arguments, returns a `Task` (see Async variants below).

### Mcp.ReadResource

`Chilkat 11.7.0 · xojo · Mcp · ReadResource · method · since 11.6.0`

```xojo
Function ReadResource(uri As String, json As Chilkat.JsonObject) As Boolean
```

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).

`Connect` must be called first.

Returns True for success, False for failure.

Async variant: `ReadResourceAsync` — same arguments, returns a `Task` (see Async variants below).

### Mcp.SetConnectionSettings

`Chilkat 11.7.0 · xojo · Mcp · SetConnectionSettings · method · since 11.6.0`

```xojo
Function SetConnectionSettings(sock As Chilkat.Socket) As Boolean
```

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 `Connect`.

Returns True for success, False for failure.

## Events and callbacks

In Xojo, Chilkat events are handled by subclassing. Add a new class to your project that inherits from Chilkat.Mcp, then override the event methods you want to respond to. Any method you don't override keeps its default do-nothing behavior, so you only need to write the ones you actually care about.

From that point on, create and use an instance of your subclass wherever you would have used a Chilkat.Mcp. The events fire on your instance automatically as the object does its work.

**For example:**

```vb
class MyMcp
    Inherits Chilkat.Mcp

    Function AbortCheck() As Boolean
    Function PercentDone(pctDone As Int32) As Boolean
    Sub ProgressInfo(name As String, value As String)
    Sub TaskCompleted(task As Chilkat.Task)

End Class
```

### Mcp.AbortCheck (event)

`Chilkat 11.7.0 · xojo · Mcp · AbortCheck · event`

```xojo
Function AbortCheck() As Boolean
```

Enables a method call to be aborted by triggering the AbortCheck event at intervals defined by the `HeartbeatMs` property. If HeartbeatMs is set to its default value of 0, no events will occur. For instance, set HeartbeatMs to 200 to trigger 5 AbortCheck events per second.

### Mcp.PercentDone (event)

`Chilkat 11.7.0 · xojo · Mcp · PercentDone · event`

```xojo
Function PercentDone(pctDone As Int32) As Boolean
```

This provides the percentage completion for any method involving network communications or time-consuming processing, assuming the progress can be measured as a percentage. This event is triggered only when it's possible and logical to express the operation's progress as a percentage. The `pctDone` argument will range from 1 to 100. For methods that finish quickly, the number of PercentDone callbacks may vary, but the final callback will have `pctDone` equal to 100. For longer operations, callbacks will not exceed one per percentage point (e.g., 1, 2, 3, ..., 98, 99, 100).

The PercentDone callback also acts as an `AbortCheck` event. For fast methods where PercentDone fires, an AbortCheck event may not trigger since the PercentDone callback already provides an opportunity to abort. For longer operations, where time between PercentDone callbacks is extended, AbortCheck callbacks enable more responsive operation termination.

To abort the operation, set the `abort` output argument to `True`. This will cause the method to terminate and return a failure status or corresponding failure value.

### Mcp.ProgressInfo (event)

`Chilkat 11.7.0 · xojo · Mcp · ProgressInfo · event`

```xojo
Sub ProgressInfo(name As String, value As String)
```

This event callback provides `tag name`/value pairs that detail what occurs during a method call. To discover existing tag names, create code to handle the event, emit the pairs, and review them. Most tag names are self-explanatory.

Note: Some Chilkat methods don't fire any ProgressInfo events.

### Mcp.TaskCompleted (event)

`Chilkat 11.7.0 · xojo · Mcp · TaskCompleted · event`

```xojo
Sub TaskCompleted(task As Chilkat.Task)
```

Called from the background thread when an asynchronous task completes.

## Async variants

Each returns a `Task` instead of the result and takes the same arguments as the synchronous method; run the task, wait for `Finished`, then read the result from the task. No new Async methods are added from 11.7.0 on.

```xojo
Function CallToolAsync(name As String, argsJson As Chilkat.JsonObject, resultJson As Chilkat.JsonObject) As Chilkat.Task
Function CloseAsync() As Chilkat.Task
Function ConnectAsync(url As String) As Chilkat.Task
Function GetPromptAsync(name As String, argsJson As Chilkat.JsonObject, json As Chilkat.JsonObject) As Chilkat.Task
Function ListPromptsAsync(json As Chilkat.JsonObject) As Chilkat.Task
Function ListResourcesAsync(json As Chilkat.JsonObject) As Chilkat.Task
Function ListToolsAsync(json As Chilkat.JsonObject) As Chilkat.Task
Function ReadResourceAsync(uri As String, json As Chilkat.JsonObject) As Chilkat.Task
```

## Related classes

[`JsonObject`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/xojo/classes/JsonObject.md), [`Socket`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/xojo/classes/Socket.md)

