Mcp Perl Reference Documentation

CkMcp

Current Version: 11.6.0

Chilkat.Mcp

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

$obj = chilkat::CkMcp->new();

Properties

AuthToken
# $strVal is a string
# $ckStr is a CkString
$mcp->get_AuthToken($ckStr);
$strVal = $mcp->authToken();
$mcp->put_AuthToken($strVal);
Introduced in version 11.6.0

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.

top
Connected
# $boolVal is a boolean
$boolVal = $mcp->get_Connected();
Introduced in version 11.6.0

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

top
ConnectTimeoutMs
# $intVal is an integer
$intVal = $mcp->get_ConnectTimeoutMs();
$mcp->put_ConnectTimeoutMs($intVal);
Introduced in version 11.6.0

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

top
DebugLogFilePath
# $strVal is a string
# $ckStr is a CkString
$mcp->get_DebugLogFilePath($ckStr);
$strVal = $mcp->debugLogFilePath();
$mcp->put_DebugLogFilePath($strVal);

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.

More Information and Examples
top
IdleTimeoutMs
# $intVal is an integer
$intVal = $mcp->get_IdleTimeoutMs();
$mcp->put_IdleTimeoutMs($intVal);
Introduced in version 11.6.0

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

top
LastErrorHtml
# $strVal is a string
# $ckStr is a CkString
$mcp->get_LastErrorHtml($ckStr);
$strVal = $mcp->lastErrorHtml();

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.

top
LastErrorText
# $strVal is a string
# $ckStr is a CkString
$mcp->get_LastErrorText($ckStr);
$strVal = $mcp->lastErrorText();

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.

top
LastErrorXml
# $strVal is a string
# $ckStr is a CkString
$mcp->get_LastErrorXml($ckStr);
$strVal = $mcp->lastErrorXml();

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.

top
LastMethodSuccess
# $boolVal is a boolean
$boolVal = $mcp->get_LastMethodSuccess();
$mcp->put_LastMethodSuccess($boolVal);

Indicates the success or failure of the most recent method call: 1 means success, 0 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.

top
ProtocolVersion
# $strVal is a string
# $ckStr is a CkString
$mcp->get_ProtocolVersion($ckStr);
$strVal = $mcp->protocolVersion();
$mcp->put_ProtocolVersion($strVal);
Introduced in version 11.6.0

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.

top
ServerInstructions
# $strVal is a string
# $ckStr is a CkString
$mcp->get_ServerInstructions($ckStr);
$strVal = $mcp->serverInstructions();
Introduced in version 11.6.0

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

top
ServerName
# $strVal is a string
# $ckStr is a CkString
$mcp->get_ServerName($ckStr);
$strVal = $mcp->serverName();
Introduced in version 11.6.0

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

top
ServerVersion
# $strVal is a string
# $ckStr is a CkString
$mcp->get_ServerVersion($ckStr);
$strVal = $mcp->serverVersion();
Introduced in version 11.6.0

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

top
SessionId
# $strVal is a string
# $ckStr is a CkString
$mcp->get_SessionId($ckStr);
$strVal = $mcp->sessionId();
Introduced in version 11.6.0

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.

top
Utf8
# $boolVal is a boolean
$boolVal = $mcp->get_Utf8();
$mcp->put_Utf8($boolVal);

When set to 1, all string arguments and return values are interpreted as UTF-8 strings. When set to 0, they are interpreted as ANSI strings.

In Chilkat v11.0.0 and later, the default value is 1. Before v11.0.0, it was 0.

top
VerboseLogging
# $boolVal is a boolean
$boolVal = $mcp->get_VerboseLogging();
$mcp->put_VerboseLogging($boolVal);

If set to 1, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is 0. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

top
Version
# $strVal is a string
# $ckStr is a CkString
$mcp->get_Version($ckStr);
$strVal = $mcp->version();

Version of the component/library, such as "10.1.0"

More Information and Examples
top

Methods

CallTool
# $name is a string
# $arguments is a CkJsonObject
# $result is a CkJsonObject
$status = $mcp->CallTool($name, $arguments, $result);
Introduced in version 11.6.0

Calls the MCP tools/call method for the tool named name, passing the JSON arguments object in arguments. The members of arguments 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 result. 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 result (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.

More Information and Examples
top
CallToolAsync (1)
# returns a CkTask
# $name is a string
# $arguments is a CkJsonObject
# $result is a CkJsonObject
$ret_task = $mcp->CallToolAsync($name, $arguments, $result);
Introduced in version 11.6.0

Creates an asynchronous task to call the CallTool method with the arguments provided.

Returns null on failure

top
Close
$status = $mcp->Close();
Introduced in version 11.6.0

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.

More Information and Examples
top
CloseAsync (1)
# returns a CkTask
$ret_task = $mcp->CloseAsync();
Introduced in version 11.6.0

Creates an asynchronous task to call the Close method with the arguments provided.

Returns null on failure

top
Connect
# $url is a string
$status = $mcp->Connect($url);
Introduced in version 11.6.0

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.

More Information and Examples
top
ConnectAsync (1)
# returns a CkTask
# $url is a string
$ret_task = $mcp->ConnectAsync($url);
Introduced in version 11.6.0

Creates an asynchronous task to call the Connect method with the arguments provided.

Returns null on failure

top
GetLastJsonData
# $json is a CkJsonObject
$mcp->GetLastJsonData($json);
Introduced in version 11.6.0

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.

top
GetPrompt
# $name is a string
# $arguments is a CkJsonObject
# $json is a CkJsonObject
$status = $mcp->GetPrompt($name, $arguments, $json);
Introduced in version 11.6.0

Calls the MCP prompts/get method for the prompt named name, passing the JSON arguments object in arguments (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.

More Information and Examples
top
GetPromptAsync (1)
# returns a CkTask
# $name is a string
# $arguments is a CkJsonObject
# $json is a CkJsonObject
$ret_task = $mcp->GetPromptAsync($name, $arguments, $json);
Introduced in version 11.6.0

Creates an asynchronous task to call the GetPrompt method with the arguments provided.

Returns null on failure

top
ListPrompts
# $json is a CkJsonObject
$status = $mcp->ListPrompts($json);
Introduced in version 11.6.0

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.

More Information and Examples
top
ListPromptsAsync (1)
# returns a CkTask
# $json is a CkJsonObject
$ret_task = $mcp->ListPromptsAsync($json);
Introduced in version 11.6.0

Creates an asynchronous task to call the ListPrompts method with the arguments provided.

Returns null on failure

top
ListResources
# $json is a CkJsonObject
$status = $mcp->ListResources($json);
Introduced in version 11.6.0

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.

More Information and Examples
top
ListResourcesAsync (1)
# returns a CkTask
# $json is a CkJsonObject
$ret_task = $mcp->ListResourcesAsync($json);
Introduced in version 11.6.0

Creates an asynchronous task to call the ListResources method with the arguments provided.

Returns null on failure

top
ListTools
# $json is a CkJsonObject
$status = $mcp->ListTools($json);
Introduced in version 11.6.0

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.

More Information and Examples
top
ListToolsAsync (1)
# returns a CkTask
# $json is a CkJsonObject
$ret_task = $mcp->ListToolsAsync($json);
Introduced in version 11.6.0

Creates an asynchronous task to call the ListTools method with the arguments provided.

Returns null on failure

top
ReadResource
# $uri is a string
# $json is a CkJsonObject
$status = $mcp->ReadResource($uri, $json);
Introduced in version 11.6.0

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.

More Information and Examples
top
ReadResourceAsync (1)
# returns a CkTask
# $uri is a string
# $json is a CkJsonObject
$ret_task = $mcp->ReadResourceAsync($uri, $json);
Introduced in version 11.6.0

Creates an asynchronous task to call the ReadResource method with the arguments provided.

Returns null on failure

top
SetConnectionSettings
# $sock is a CkSocket
$status = $mcp->SetConnectionSettings($sock);
Introduced in version 11.6.0

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.

More Information and Examples
top