MCPClient Module

Properties   Methods   Events   Config Settings   Errors  

Provides an easy way to retrieve prompts, resources, and invoke tools from Model Context Protocol (MCP) servers.

Syntax

MCPSDK.MCPClient

Remarks

The MCPClient class provides a simple way to communicate with MCP Servers.

Connecting to a Server

When the Transport property is set to ttStdio, the LocalServerPath property must first be set to a file path pointing to a server executable. The Timeout property can be used to specify a timeout when connecting to the server. To initiate the connection, the Connect method should be used.

If successful, the class will then launch the server executable as a subprocess and will be able to send and receive MCP requests.

// Server executable. client.LocalServerPath = @"PATH\\TO\\SERVER\\EXE"; // Launches the server .exe as a subprocess and connects to it. client.Connect();

Key Features

The MCPClient class supports all major MCP functionality, including tools, prompts, resources, and sampling.

Tools

Tools provide an opportunity for LLM clients to execute custom code, interact with external systems, and access dynamic or external data. Anything for which a function can be written can also be exposed as a tool. Common examples include database queries, file operations, or computations.

Listing Tools

Before a client can begin invoking tools, it should first know which tools are available on the server. A client can retrieve a list of valid tools via the ListTools method. When called, the Tools properties will be automatically cleared and populated with the retrieved tools.

Each tool contains a , which acts as a unique identifier that can be used to reference the tool.

// Request a list of tools on the server. client.ListTools(); // Display the name of each tool. foreach (var tool in client.Tools) { // A unique identifier for the tool. string name = tool.Name; // A natural language description of the tool. This is often used to allow LLMs to reason over. string description = tool.Description; // Write to 'stderr' as 'stdio' is reserved for client/server communications. Console.Error.WriteLine($"Tool name: {name}"); Console.Error.WriteLine($"Tool description: {description}"); }

Invoking Tools

Once a tool has been identified, it can be invoked using the InvokeTool method. The server will then reply with a list of individual tool messages that can be retrieved via the ToolMessages properties.

Each tool message contains a indicating the type of response and a , which is typically plain text (e.g., a string result or a base64-encoded image).

// Invoke a tool named 'get-weather'. client.InvokeTool("get-weather"); // Write to 'stderr' as 'stdio' is reserved for client/server communications. foreach (var message in client.ToolMessages) { Console.Error.WriteLine($"message.Value"); }

Tool Parameters

Some server implementations allow tools to receive runtime parameters, allowing clients to provide additional data or context at the time of invocation. These parameters can be specified by calling the AddToolParam method prior to calling the InvokeTool method. Each parameter consists of a Name and a Value, which are then passed along to the server with the tool request.

// Set up parameters for the 'get-weather' tool. client.AddToolParam("location", "New York"); client.AddToolParam("units", "metric"); // Invoke the tool with the specified parameters. client.InvokeTool("get-weather"); // The response will contain the weather information for New York in metric units. // Write to 'stderr' as 'stdio' is reserved for client/server communications. foreach (var message in client.ToolMessages) { Console.Error.WriteLine($"Tool response: {message.Value}"); }

Prompts

Prompts are predefined conversation starters or instructions that can be quickly inserted into the LLM's context to guide specific interactions or workflows. Prompts serve as standardized templates for common conversational patterns and allow for consistent responses for tasks like reviewing code, analyzing data, or answering specific types of questions.

Listing Prompts

Before a client can begin retrieving prompts, it should first know which prompts are available on the server. A client can retrieve a list of available prompts via the ListPrompts method. When called, the Prompts properties will be automatically cleared and populated with the retrieved prompts.

client.ListPrompts(); // Write to 'stderr' as 'stdio' is reserved for client/server communications. foreach (var prompt in client.Prompts) { Console.Error.WriteLine($"Prompt name: {prompt.Name}"); Console.Error.WriteLine($"Description: {prompt.Description}"); }

Retrieving Prompts

Once a prompt has been identified, it can be requested using the GetPrompt method. The server will then reply with a list of individual prompt messages that will be available via the PromptMessages properties.

Each prompt message consists of and a . A Role identifies the speaker or author of a given message, and its Text represents a natural language instruction that can be fed into a language model.

client.GetPrompt("review-code"); // Write to 'stderr' as 'stdio' is reserved for client/server communications. for (var message in client.PromptMessages) { // A role of '0' indicates a prompt message coming from a 'user'. // A value of '1' indicates that it comes from an 'assistant'. string direction = (message.Role == 0) ? "User" : "Assistant"; Console.Error.WriteLine($"Message from {direction}: {message.Text}"); }

Prompt Parameters

Some server implementations support runtime arguments. These parameters allow prompts to be customized with client-specific data before execution. Prompt parameters can be specified by calling the AddPromptParam method before calling the GetPrompt method.

Each parameter consists of a Name and a Value, which are then passed along to the server with the prompt request.

// Request a prompt named 'review-code', passing along the following parameters: // code-language: 'javascript' // code-to-review: 'var a = 5;' client.AddPromptParam("code-language", "javascript"); client.AddPromptParam("code-to-review", "var a = 5;"); client.GetPrompt("review-code"); // The server would then return a code review of the javascript code 'var a = 5;'. // Write to 'stderr' as 'stdio' is reserved for client/server communications. Console.Error.WriteLine($"{client.PromptMessages[0].Text}");

Resources

Resources provide persistent, read-only content that can be requested once by the user and reused throughout the session. These are typically static files such as documentation, source code, or other reference materials that help provide context for LLM interactions.

Listing Resources

Before a client can begin retrieving resources, it should first know which resources are available on the server. A client can retrieve a list of available resources via the ListResources method. When called, the Resources properties will be automatically cleared and populated with the retrieved resources.

Each resource contains a , which acts as a unique identifier that can be used to fetch its contents. Resources may also have a and a natural language , which are typically used to provide language models context over what each resource represents.

client.ListResources(); // Write to 'stderr' as 'stdio' is reserved for client/server communications. foreach (var resource in client.Resources) { Console.Error.WriteLine($"Resource name: {resource.Name}"); Console.Error.WriteLine($"Description: {resource.Description}"); Console.Error.WriteLine($"URI: {resource.Uri}"); }

Retrieving Resources

Once a resource has been identified, its contents can be retrieved using the ReadResource method. The server will then reply with the resource contents that can be retrieved via the ResourceContents properties.

// Resources are identified by URIs. In this case, this resource can be identified with 'file:///docs/reference.txt'. client.ReadResource("file:///docs/reference.txt"); // Write to 'stderr' as 'stdio' is reserved for client/server communications. foreach (var content in client.ResourceContents) { Console.Error.WriteLine($"Resource content (text): {content.Data}"); }

Disconnecting from a Server

To disconnect from the server, the Disconnect method should be used. When the Transport property is set to ttStdio, the client will drop the underlying connection and the server subprocess will be automatically terminated. client.Disconnect();

Property List

The following is the full list of the properties of the module with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the module with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the module with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the module with short descriptions. Click on the links for further details.

LocalServerPath Property (MCPClient Module)

The path to the local MCP server executable.

Syntax

• Swift
• Objective-C

public var localServerPath: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=localServerPath,setter=setLocalServerPath:) NSString* localServerPath;

- (NSString*)localServerPath;
- (void)setLocalServerPath :(NSString*)newLocalServerPath;

Default Value

""

Remarks

When the Transport property is set to ttStdio, this property is used to specify the full path to the local MCP server executable that the class will launch and connect to. When set, the class will start the server process at the specified path and establish a connection for MCP operations.

The supplied path must point to a valid MCP server executable file. If the path is empty or invalid, the class will not attempt to start a local server process.

PromptMessages Property (MCPClient Module)

A collection of prompt messages received after a prompt request.

Syntax

• Swift
• Objective-C

public var promptMessages: Array<PromptMessage> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=promptMessageCount,setter=setPromptMessageCount:) int promptMessageCount;

- (int)promptMessageCount;
- (void)setPromptMessageCount :(int)newPromptMessageCount;

- (int)promptMessageRole:(int)promptMessageIndex;
- (void)setPromptMessageRole:(int)promptMessageIndex :(int)newPromptMessageRole;

- (NSString*)promptMessageText:(int)promptMessageIndex;
- (void)setPromptMessageText:(int)promptMessageIndex :(NSString*)newPromptMessageText;

Default Value

1

Remarks

This collection holds a list of PromptMessage items.

Calling the GetPrompt method will populate this collection with a list of prompt messages received from the server.

Prompts Property (MCPClient Module)

A collection of prompts available on the server.

Syntax

• Swift
• Objective-C

public var prompts: Array<Prompt> {
  get {...}
}

@property (nonatomic,readonly,assign,getter=promptCount) int promptCount;

- (int)promptCount;

- (NSString*)promptDescription:(int)promptIndex;

- (NSString*)promptName:(int)promptIndex;

Default Value

1

Remarks

This collection holds a list of Prompt items.

Calling the ListPrompts method will populate this collection with a list of prompts received from the server.

ResourceContents Property (MCPClient Module)

A collection of resource contents received after a resource read request.

Syntax

• Swift
• Objective-C

public var resourceContents: Array<ResourceContent> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=resourceContentCount,setter=setResourceContentCount:) int resourceContentCount;

- (int)resourceContentCount;
- (void)setResourceContentCount :(int)newResourceContentCount;

- (NSString*)resourceContentData:(int)resourceContentIndex;
- (void)setResourceContentData:(int)resourceContentIndex :(NSString*)newResourceContentData;

- (NSData*)resourceContentDataB:(int)resourceContentIndex;
- (void)setResourceContentDataB:(int)resourceContentIndex :(NSData*)newResourceContentData;
- (NSString*)resourceContentMimeType:(int)resourceContentIndex;
- (void)setResourceContentMimeType:(int)resourceContentIndex :(NSString*)newResourceContentMimeType;

- (NSString*)resourceContentUri:(int)resourceContentIndex;
- (void)setResourceContentUri:(int)resourceContentIndex :(NSString*)newResourceContentUri;

Default Value

1

Remarks

This collection holds a list of ResourceContent items.

Calling the ReadResource method will populate this collection with a list of resource contents received from the server.

Resources Property (MCPClient Module)

A collection of resources available on the server.

Syntax

• Swift
• Objective-C

public var resources: Array<Resource> {
  get {...}
}

@property (nonatomic,readonly,assign,getter=resourceCount) int resourceCount;

- (int)resourceCount;

- (NSString*)resourceDescription:(int)resourceIndex;

- (NSString*)resourceMimetype:(int)resourceIndex;

- (NSString*)resourceName:(int)resourceIndex;

- (int)resourceSize:(int)resourceIndex;

- (NSString*)resourceUri:(int)resourceIndex;

Default Value

1

Remarks

This collection holds a list of Resource items.

Calling the ListResources method will populate this collection with a list of resources received from the server.

SamplingMessages Property (MCPClient Module)

A collection of messages received when the server requests language model generation.

Syntax

• Swift
• Objective-C

public var samplingMessages: Array<SamplingMessage> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=samplingMessageCount,setter=setSamplingMessageCount:) int samplingMessageCount;

- (int)samplingMessageCount;
- (void)setSamplingMessageCount :(int)newSamplingMessageCount;

- (int)samplingMessageRole:(int)samplingMessageIndex;

- (NSString*)samplingMessageText:(int)samplingMessageIndex;
- (void)setSamplingMessageText:(int)samplingMessageIndex :(NSString*)newSamplingMessageText;

Default Value

1

Remarks

This collection holds a list of SamplingMessage items.

When the Transport property is set to ttStdio, this collection is populated when the server initiates a sampling request and represents a list of messages meant to be passed into the client's language model.

Timeout Property (MCPClient Module)

The timeout for operations in seconds.

Syntax

• Swift
• Objective-C

public var timeout: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=timeout,setter=setTimeout:) int timeout;

- (int)timeout;
- (void)setTimeout :(int)newTimeout;

Default Value

10

Remarks

This property specifies the timeout period in seconds for operations performed by the class.

If this is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If this is set to a positive value, the class will wait for the operation to complete before returning control. If the timeout expires before the operation completes, the class throws an exception.

Note that all timeouts are inactivity timeouts, meaning the timeout period is extended by value specified in this property when any amount of data is successfully sent or received.

ToolMessages Property (MCPClient Module)

A collection of tool messages received after a tool invocation.

Syntax

• Swift
• Objective-C

public var toolMessages: Array<ToolMessage> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=toolMessageCount,setter=setToolMessageCount:) int toolMessageCount;

- (int)toolMessageCount;
- (void)setToolMessageCount :(int)newToolMessageCount;

- (int)toolMessageMessageType:(int)toolMessageIndex;

- (NSString*)toolMessageValue:(int)toolMessageIndex;
- (void)setToolMessageValue:(int)toolMessageIndex :(NSString*)newToolMessageValue;

Default Value

1

Remarks

This collection holds a list of ToolMessage items.

Calling the InvokeTool method will populate this collection with a list of tool messages received from the server.

Tools Property (MCPClient Module)

A collection of tools available on the server.

Syntax

• Swift
• Objective-C

public var tools: Array<Tool> {
  get {...}
}

@property (nonatomic,readonly,assign,getter=toolCount) int toolCount;

- (int)toolCount;

- (NSString*)toolDescription:(int)toolIndex;

- (NSString*)toolName:(int)toolIndex;

Default Value

1

Remarks

This collection holds a list of Tool items.

Calling the ListTools method will populate this collection with a list of tools received from the server.

Transport Property (MCPClient Module)

The transport mechanism used for communication.

Syntax

• Swift
• Objective-C

public var transport: MCPClientTransports {
  get {...}
  set {...}
}

public enum MCPClientTransports: Int32 {
  case ttStdio = 1
  case ttHTTP = 2
}

@property (nonatomic,readwrite,assign,getter=transport,setter=setTransport:) int transport;

- (int)transport;
- (void)setTransport :(int)newTransport;

Default Value

1

Remarks

This property indicates whether the class operates via the standard input/output or HTTP transport mechanism. Possible values are as follows:

• ttStdio (1, default): Enables communication through standard input and output streams, but the class is limited to serving a single client at once due to the server acting as a subprocess of a client application.
• ttHTTP (2): Enables communication via HTTP requests and responses, and allows the class to serve multiple clients at once.

AddPromptParam Method (MCPClient Module)

Adds a prompt parameter.

Syntax

• Swift
• Objective-C

public func addPromptParam(name: String, value: String) throws -> Void

- (void)addPromptParam:(NSString*)name :(NSString*)value;

Remarks

This method is used to add a parameter to be passed into the next prompt request. When called, the specified parameter value will be included in the next prompt requested via the GetPrompt method.

Name specifies the unique name identifier of the parameter.

Value specifies the value of the parameter that will be included in the prompt request.

Example: client.AddPromptParam("code-to-review", "var a = 5;"); client.GetPrompt("review-code"); // Write to 'stderr' as 'stdio' is reserved for client/server communications. Console.Error.WriteLine(client.PromptMessages[0].Text);

AddToolParam Method (MCPClient Module)

Adds a tool parameter.

Syntax

• Swift
• Objective-C

public func addToolParam(name: String, value: String) throws -> Void

- (void)addToolParam:(NSString*)name :(NSString*)value;

Remarks

This method is used to add a parameter to be passed into the next tool invocation. When called, the specified parameter value will be included in the next tool invoked via the InvokeTool method.

Name specifies the unique name identifier of the parameter.

Value specifies the value of the parameter that will be included in the tool request.

Example: client.AddToolParam("location", "New York"); // The 'get-weather' tool will receive a 'location' parameter with a value of 'New York'. client.InvokeTool("get-weather"); // Write to 'stderr' as 'stdio' is reserved for client/server communications. Console.Error.WriteLine(client.ToolMessages[0].Value);

Config Method (MCPClient Module)

Sets or retrieves a configuration setting.

Syntax

• Swift
• Objective-C

public func config(configurationString: String) throws -> String

- (NSString*)config:(NSString*)configurationString;

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Connect Method (MCPClient Module)

Connects to a MCP server.

Syntax

• Swift
• Objective-C

public func connect() throws -> Void

- (void)connect;

Remarks

This method is used to establish a connection to a MCP server and initializes the communication channel. After establishing the connection, the initialize request is automatically sent to the server.

If the Transport property is set to ttStdio, this method will start the server as a subprocess using the path specified in the LocalServerPath property and enable communication through standard input/output streams.

This method will throw an exception if the connection cannot be established or if the server initialization fails.

Disconnect Method (MCPClient Module)

Disconnects from a MCP server.

Syntax

• Swift
• Objective-C

public func disconnect() throws -> Void

- (void)disconnect;

Remarks

This method is used to close the connection to a MCP server and terminates the communication channel. All active operations will be canceled and any pending requests will be discarded.

If the Transport property is set to ttStdio, this method will also terminate the server subprocess that was started during connection.

GetPrompt Method (MCPClient Module)

Retrieves a prompt from the server.

Syntax

• Swift
• Objective-C

public func getPrompt(name: String) throws -> Void

- (void)getPrompt:(NSString*)name;

Remarks

This method is used to request a prompt from the server. When called, the PromptMessages properties will be cleared and populated with the individual messages that make up the requested prompt.

Name specifies the unique name identifier of the prompt that will be retrieved.

InvokeTool Method (MCPClient Module)

Invokes a tool from the server.

Syntax

• Swift
• Objective-C

public func invokeTool(name: String) throws -> Void

- (void)invokeTool:(NSString*)name;

Remarks

This method is used to invoke a tool from the server. When called, the server will execute the requested tool and the ToolMessages properties will be cleared and populated with a list of response messages associated with the tool.

Name specifies the unique name identifier of the tool that will be invoked.

ListPrompts Method (MCPClient Module)

Retrieves the list of prompts available on the server.

Syntax

• Swift
• Objective-C

public func listPrompts() throws -> Void

- (void)listPrompts;

Remarks

This method is used to request a listing of all of the prompts available on the server. When called, the Prompts properties will be cleared and populated with the retrieved prompts.

This method is typically called during the client's initialization phase or when the client needs to retrieve the latest list of prompts it can request via the GetPrompt method.

ListResources Method (MCPClient Module)

Retrieves the list of resources available on the server.

Syntax

• Swift
• Objective-C

public func listResources() throws -> Void

- (void)listResources;

Remarks

This method is used to request a listing of all of the resources available on the server. When called, the Resources properties will be cleared and populated with the retrieved resources.

This method is typically used during the client's initialization phase, or when the client needs to retrieve the latest list of resources it can request via the ReadResource method.

ListTools Method (MCPClient Module)

Retrieves the list of tools available on the server.

Syntax

• Swift
• Objective-C

public func listTools() throws -> Void

- (void)listTools;

Remarks

This method is used to request a listing of all of the tools available on the server. When called, the Tools properties will be cleared and populated with the retrieved tools.

This method is typically used during the client's initialization phase, or when the client needs to retrieve the latest list of tools it can invoke via the InvokeTool method.

ReadResource Method (MCPClient Module)

Reads a resource from the server.

Syntax

• Swift
• Objective-C

public func readResource(uri: String) throws -> Void

- (void)readResource:(NSString*)uri;

Remarks

This method is used to request a resource from the server. When called, the ResourceContents properties will be cleared and populated with the data of the requested resource.

Uri specifies the unique identifier for the resource, of which common formats include file:///filename.ext for files, standard HTTP/HTTPS URLs for web resources, or custom schemes like db://table_name.

Error Event (MCPClient Module)

Fires when an error occurs during operation.

Syntax

• Swift
• Objective-C

func onError(connectionId: Int32, errorCode: Int32, description: String)

- (void)onError:(int)connectionId :(int)errorCode :(NSString*)description;

Remarks

This event is fired when an unhandled exception is caught by the class, providing information about the error.

ConnectionId identifies the connection associated with the error.

ErrorCode contains the numeric error code representing the specific error condition.

Description contains a textual description of the error that occurred.

Log Event (MCPClient Module)

This event is fired once for each log message.

Syntax

• Swift
• Objective-C

func onLog(logLevel: Int32, message: String, logType: String)

- (void)onLog:(int)logLevel :(NSString*)message :(NSString*)logType;

Remarks

This event fires once for each log message generated by the class. The verbosity is controlled by the LogLevel configuration.

LogLevel indicates the detail level of the message. Possible values are:

Message is the log message.

LogType identifies the type of log entry. Possible values are as follows:

• NFS

SamplingRequest Event (MCPClient Module)

Fires when the server requests language model generation.

Syntax

• Swift
• Objective-C

func onSamplingRequest(responseText: inout String, systemPrompt: String, role: inout Int32, model: inout String, intelligencePriority: String, speedPriority: String)

- (void)onSamplingRequest:(NSString**)responseText :(NSString*)systemPrompt :(int*)role :(NSString**)model :(NSString*)intelligencePriority :(NSString*)speedPriority;

Remarks

When the Transport property is set to ttStdio, this event is fired when the server requests to sample the client's language model. When fired, the messages that make up the server's prompt will be available via the SamplingMessages properties.

To successfully handle the event, a client should construct a prompt from the messages in SamplingMessages and generate a response using the client's language model.

ResponseText should be set to the text output generated by the model when fed the messages in SamplingMessages.

SystemPrompt contains a natural language instruction or directive used to guide the model's behavior during generation. It is typically used to establish context, define tone, or specify how the model should respond.

Role should be set to the role used by the language model when generating ResponseText. Valid roles include:

Model should be set to the name of the model used to generate ResponseText.

IntelligencePriority specifies how much the client should prioritize advanced capabilities when generating ResponseText. Its value is a decimal number ranging from 0.0 to 1.0. Higher values prefer more capable models.

SpeedPriority specifies how much the client should prioritize low latency when generating ResponseText. Its value is a decimal number ranging from 0.0 to 1.0. Higher values prefer faster models.

Prompt Type

A registered prompt.

Remarks

This type represents a registered prompt that can be requested by the client.

• Description
• Name

Fields

Constructors

public init()

PromptMessage Type

A prompt message.

Remarks

This type represents an individual message within a prompt that can be requested by the client.

• Role
• Text

Fields

Constructors

public init()

public init(role: , text: )

Resource Type

A registered resource.

Remarks

This type represents a registered resource that can be requested by the client.

• Description
• Mimetype
• Name
• Size
• Uri

Fields

Constructors

public init()

ResourceContent Type

A resource's content.

Remarks

This type represents the content for an individual resource that can be requested by the client.

• Data
• MimeType
• Uri

Fields

Constructors

public init()

SamplingMessage Type

An individual message in a sampling request.

Remarks

This type represents an individual message within a sampling request received by the server.

• Role
• Text

Fields

Constructors

public init()

Tool Type

A registered tool.

Remarks

This type represents a registered tool that can be requested by the client.

• Description
• Name

Fields

Constructors

public init()

ToolMessage Type

A tool message.

Remarks

This type represents an individual message within a tool response.

• MessageType
• Value

Fields

Constructors

public init()

Config Settings (MCPClient Module)

MCPClient Config Settings

Base Config Settings

Trappable Errors (MCPClient Module)

MCPClient Errors