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

> Chilkat 11.7.0 · language=powerbuilder · 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/powerbuilder/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**

```powerbuilder
oleobject loo_Mcp
integer li_rc

loo_Mcp = create oleobject
li_rc = loo_Mcp.ConnectToNewObject("Chilkat.Mcp")
if li_rc < 0 then
    destroy loo_Mcp
    MessageBox("Error","Connecting to COM object failed")
    return
end if

// ... use loo_Mcp ...

destroy loo_Mcp
```

PowerBuilder uses the Chilkat ActiveX through an `oleobject`: declare the variable, `create` it, connect it to the Chilkat class with `ConnectToNewObject`, and `destroy` it when finished. A negative return code from `ConnectToNewObject` means the ActiveX is not registered, or the registered ActiveX does not match the bitness (32-bit or 64-bit) of the PowerBuilder target.

Objects returned by methods (such as an `HttpResponse` or `JsonObject`) are also `oleobject` variables and must likewise be destroyed. A method that fails to return an object returns `null`; test with `IsNull()`. In the signatures on this page, the Chilkat class name identifies which object is expected or returned; the PowerBuilder variable type is always `oleobject`.

To bind to a specific major version of Chilkat, append the major version number to the ProgID, such as `ConnectToNewObject("Chilkat.Mcp.11")` for Chilkat v11.\*.\*.

Members typed `blob` exchange binary data as a Variant byte array. The PowerBuilder examples instead use the `BinData`-based alternatives (methods ending in *Bd*), which keep binary data inside Chilkat objects.

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

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` | `string DebugLogFilePath` | read/write | If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. |
| `LastBinaryResult` | `blob LastBinaryResult (read-only)` | read-only | This property is mainly used in SQL Server stored procedures to retrieve binary data from the last method call that returned binary data. |
| `LastErrorHtml` | `string LastErrorHtml (read-only)` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `string LastErrorText (read-only)` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `string LastErrorXml (read-only)` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `long LastMethodSuccess` | read/write | Indicates the success or failure of the most recent method call: `1` means success, `0` means failure. |
| `LastStringResult` | `string LastStringResult (read-only)` | read-only | In SQL Server stored procedures, this property holds the string return value of the most recent method call that returns a string. |
| `LastStringResultLen` | `long LastStringResultLen (read-only)` | read-only | The length, in characters, of the string contained in the LastStringResult property. |
| `VerboseLogging` | `long VerboseLogging` | read/write | If set to `1`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `string Version (read-only)` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `AuthToken` | property, read/write | `string AuthToken` |
| `Connected` | property, read-only | `long Connected (read-only)` |
| `ConnectTimeoutMs` | property, read/write | `long ConnectTimeoutMs` |
| `IdleTimeoutMs` | property, read/write | `long IdleTimeoutMs` |
| `ProtocolVersion` | property, read/write | `string ProtocolVersion` |
| `ServerInstructions` | property, read-only | `string ServerInstructions (read-only)` |
| `ServerName` | property, read-only | `string ServerName (read-only)` |
| `ServerVersion` | property, read-only | `string ServerVersion (read-only)` |
| `SessionId` | property, read-only | `string SessionId (read-only)` |
| `CallTool` | method | `long CallTool(string name, ChilkatJsonObject argsJson, ChilkatJsonObject resultJson)` |
| `Close` | method | `long Close()` |
| `Connect` | method | `long Connect(string url)` |
| `GetLastJsonData` | method | `GetLastJsonData(ChilkatJsonObject json)` |
| `GetPrompt` | method | `long GetPrompt(string name, ChilkatJsonObject argsJson, ChilkatJsonObject json)` |
| `ListPrompts` | method | `long ListPrompts(ChilkatJsonObject json)` |
| `ListResources` | method | `long ListResources(ChilkatJsonObject json)` |
| `ListTools` | method | `long ListTools(ChilkatJsonObject json)` |
| `ReadResource` | method | `long ReadResource(string uri, ChilkatJsonObject json)` |
| `SetConnectionSettings` | method | `long SetConnectionSettings(ChilkatSocket sock)` |

## Properties

### Mcp.AuthToken

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

```powerbuilder
string AuthToken
```

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 · powerbuilder · Mcp · Connected · property · read-only · since 11.6.0`

```powerbuilder
long Connected (read-only)
```

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

### Mcp.ConnectTimeoutMs

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

```powerbuilder
long ConnectTimeoutMs
```

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

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

```powerbuilder
long IdleTimeoutMs
```

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 · powerbuilder · Mcp · ProtocolVersion · property · read/write · since 11.6.0`

```powerbuilder
string ProtocolVersion
```

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 · powerbuilder · Mcp · ServerInstructions · property · read-only · since 11.6.0`

```powerbuilder
string ServerInstructions (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 · powerbuilder · Mcp · ServerName · property · read-only · since 11.6.0`

```powerbuilder
string ServerName (read-only)
```

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

### Mcp.ServerVersion

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

```powerbuilder
string ServerVersion (read-only)
```

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

### Mcp.SessionId

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

```powerbuilder
string SessionId (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 · powerbuilder · Mcp · CallTool · method · since 11.6.0`

```powerbuilder
long CallTool(string name, ChilkatJsonObject argsJson, ChilkatJsonObject resultJson)
```

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 `1` here with `isError` set to `1` in `resultJson` (the failure message is typically carried in the `content` array). The return value is `0` only for transport- or protocol-level failures.

`Connect` must be called first.

Returns 1 for success, 0 for failure.

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

### Mcp.Close

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

```powerbuilder
long Close()
```

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 1 for success, 0 for failure.

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

### Mcp.Connect

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

```powerbuilder
long Connect(string url)
```

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

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 1 for success, 0 for failure.

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

### Mcp.GetLastJsonData

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

```powerbuilder
GetLastJsonData(ChilkatJsonObject json)
```

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 · powerbuilder · Mcp · GetPrompt · method · since 11.6.0`

```powerbuilder
long GetPrompt(string name, ChilkatJsonObject argsJson, ChilkatJsonObject json)
```

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 1 for success, 0 for failure.

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

### Mcp.ListPrompts

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

```powerbuilder
long ListPrompts(ChilkatJsonObject json)
```

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 1 for success, 0 for failure.

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

### Mcp.ListResources

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

```powerbuilder
long ListResources(ChilkatJsonObject json)
```

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 1 for success, 0 for failure.

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

### Mcp.ListTools

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

```powerbuilder
long ListTools(ChilkatJsonObject json)
```

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 1 for success, 0 for failure.

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

### Mcp.ReadResource

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

```powerbuilder
long ReadResource(string uri, ChilkatJsonObject json)
```

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 1 for success, 0 for failure.

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

### Mcp.SetConnectionSettings

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

```powerbuilder
long SetConnectionSettings(ChilkatSocket sock)
```

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 1 for success, 0 for failure.

## Events and callbacks

This binding has no event callbacks. For progress, percent-done or cancellation use the `*Async` variant of a method and poll the returned `Task` (`PercentDone`, `Finished`, `Cancel`).

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

```powerbuilder
ChilkatTask CallToolAsync(string name, ChilkatJsonObject argsJson, ChilkatJsonObject resultJson)
ChilkatTask CloseAsync()
ChilkatTask ConnectAsync(string url)
ChilkatTask GetPromptAsync(string name, ChilkatJsonObject argsJson, ChilkatJsonObject json)
ChilkatTask ListPromptsAsync(ChilkatJsonObject json)
ChilkatTask ListResourcesAsync(ChilkatJsonObject json)
ChilkatTask ListToolsAsync(ChilkatJsonObject json)
ChilkatTask ReadResourceAsync(string uri, ChilkatJsonObject json)
```

## Related classes

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

