MCPClient Component

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

TsdmMCPClient

Remarks

The MCPClient component 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 component 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 component 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 component with short descriptions. Click on the links for further details.

Method List

---

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

Event List

---

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

Config Settings

---

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

LocalServerPath Property (MCPClient Component)

The path to the local MCP server executable.

Syntax

__property String LocalServerPath = { read=FLocalServerPath, write=FSetLocalServerPath };

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 component will launch and connect to. When set, the component 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 component will not attempt to start a local server process.

Data Type

String

PromptMessageCount Property (MCPClient Component)

The number of records in the PromptMessage arrays.

Syntax

__property int PromptMessageCount = { read=FPromptMessageCount, write=FSetPromptMessageCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• PromptMessageRole
• PromptMessageText

The array indices start at 0 and end at PromptMessageCount - 1.

This property is not available at design time.

Data Type

Integer

PromptMessageRole Property (MCPClient Component)

The speaker or author of the message.

Syntax

__property TsdmMCPClientPromptMessageRoles PromptMessageRole[int PromptMessageIndex] = { read=FPromptMessageRole, write=FSetPromptMessageRole };

enum TsdmMCPClientPromptMessageRoles {
  rtUser=0,
  rtAssistant=1
};

Default Value

rtUser

Remarks

The speaker or author of the message.

This property indicates who authored each message and helps provide conversational context to language models. Valid roles include:

The PromptMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PromptMessageCount property.

This property is not available at design time.

Data Type

Integer

PromptMessageText Property (MCPClient Component)

The instruction that can be passed into the client's language model.

Syntax

__property String PromptMessageText[int PromptMessageIndex] = { read=FPromptMessageText, write=FSetPromptMessageText };

Default Value

""

Remarks

The instruction that can be passed into the client's language model.

This property contains natural language describing an instruction that can be passed into the client's language model (e.g., Review python code, Summarize an article, or Provide an example of using the /n software MCP SDK).

The PromptMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PromptMessageCount property.

This property is not available at design time.

Data Type

String

PromptCount Property (MCPClient Component)

The number of records in the Prompt arrays.

Syntax

__property int PromptCount = { read=FPromptCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• PromptDescription
• PromptMessageRole
• PromptMessageText
• PromptName

The array indices start at 0 and end at PromptCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

PromptDescription Property (MCPClient Component)

The brief, human-readable description of what the prompt does.

Syntax

__property String PromptDescription[int PromptIndex] = { read=FPromptDescription };

Default Value

""

Remarks

The brief, human-readable description of what the prompt does.

This property holds a brief, human-readable description of what the prompt does, which is critical in helping the client to understand the purpose and functionality of the prompt.

The PromptIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PromptCount property.

This property is read-only and not available at design time.

Data Type

String

PromptName Property (MCPClient Component)

The unique name associated with the prompt.

Syntax

__property String PromptName[int PromptIndex] = { read=FPromptName };

Default Value

""

Remarks

The unique name associated with the prompt.

This property identifies the unique name associated with the prompt.

The PromptIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PromptCount property.

This property is read-only and not available at design time.

Data Type

String

ResourceContentCount Property (MCPClient Component)

The number of records in the ResourceContent arrays.

Syntax

__property int ResourceContentCount = { read=FResourceContentCount, write=FSetResourceContentCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• ResourceContentData
• ResourceContentMimeType
• ResourceContentUri

The array indices start at 0 and end at ResourceContentCount - 1.

This property is not available at design time.

Data Type

Integer

ResourceContentData Property (MCPClient Component)

The data included in the resource content.

Syntax

__property String ResourceContentData[int ResourceContentIndex] = { read=FResourceContentData, write=FSetResourceContentData };
__property DynamicArray<Byte> ResourceContentDataB[int ResourceContentIndex] = { read=FResourceContentDataB, write=FSetResourceContentDataB };

Default Value

""

Remarks

The data included in the resource content.

This property contains the data included in the resource content. Its format depends on the value in the ResourceMimeType property.

The ResourceContentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceContentCount property.

This property is not available at design time.

Data Type

Byte Array

ResourceContentMimeType Property (MCPClient Component)

The MIME type of the resource content data.

Syntax

__property String ResourceContentMimeType[int ResourceContentIndex] = { read=FResourceContentMimeType, write=FSetResourceContentMimeType };

Default Value

""

Remarks

The MIME type of the resource content data.

This property identifies the MIME type of the resource content data and informs the client of how the data in the ResourceData property should be interpreted and processed.

The ResourceContentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceContentCount property.

This property is not available at design time.

Data Type

String

ResourceContentUri Property (MCPClient Component)

The unique resource identifier that corresponds to the content received from the server.

Syntax

__property String ResourceContentUri[int ResourceContentIndex] = { read=FResourceContentUri, write=FSetResourceContentUri };

Default Value

""

Remarks

The unique resource identifier that corresponds to the content received from the server.

This property identifies the individual resource content's unique resource identifier and may differ from the one corresponding to the overall resource.

For example, a client may request a resource with a URI of file:///test, and the server may then return two individual resource contents with the following URIs: file:///file/test/desc.txt, and file:///file/test/data.json.

The ResourceContentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceContentCount property.

This property is not available at design time.

Data Type

String

ResourceCount Property (MCPClient Component)

The number of records in the Resource arrays.

Syntax

__property int ResourceCount = { read=FResourceCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• ResourceContentData
• ResourceContentMimeType
• ResourceContentUri
• ResourceDescription
• ResourceMimetype
• ResourceName
• ResourceSize
• ResourceUri

The array indices start at 0 and end at ResourceCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

ResourceDescription Property (MCPClient Component)

The brief, human-readable description of the purpose of the resource as well as appropriate use cases.

Syntax

__property String ResourceDescription[int ResourceIndex] = { read=FResourceDescription };

Default Value

""

Remarks

The brief, human-readable description of the purpose of the resource as well as appropriate use cases.

This property holds a brief, human-readable description of the purpose of the resource as well as appropriate use cases.

The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

This property is read-only and not available at design time.

Data Type

String

ResourceMimetype Property (MCPClient Component)

The media type of the resource content.

Syntax

__property String ResourceMimetype[int ResourceIndex] = { read=FResourceMimetype };

Default Value

""

Remarks

The media type of the resource content.

This property holds the media type of resource content (e.g., text/plain, image/png, etc.) and helps clients interpret the resource correctly and determine how it should be processed or displayed.

The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

This property is read-only and not available at design time.

Data Type

String

ResourceName Property (MCPClient Component)

The display name associated with the resource.

Syntax

__property String ResourceName[int ResourceIndex] = { read=FResourceName };

Default Value

""

Remarks

The display name associated with the resource.

This property indicates the display associated with the resource that is shown to end users by the client.

The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

This property is read-only and not available at design time.

Data Type

String

ResourceSize Property (MCPClient Component)

The size of the resource content, in bytes.

Syntax

__property int ResourceSize[int ResourceIndex] = { read=FResourceSize };

Default Value

0

Remarks

The size of the resource content, in bytes.

This property indicates the size of the resource content, in bytes.

The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

This property is read-only and not available at design time.

Data Type

Integer

ResourceUri Property (MCPClient Component)

The unique resource identifier associated with the resource.

Syntax

__property String ResourceUri[int ResourceIndex] = { read=FResourceUri };

Default Value

""

Remarks

The unique resource identifier associated with the resource.

This property identifies the unique resource identifier associated with the resource.

The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

This property is read-only and not available at design time.

Data Type

String

SamplingMessageCount Property (MCPClient Component)

The number of records in the SamplingMessage arrays.

Syntax

__property int SamplingMessageCount = { read=FSamplingMessageCount, write=FSetSamplingMessageCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• SamplingMessageRole
• SamplingMessageText

The array indices start at 0 and end at SamplingMessageCount - 1.

This property is not available at design time.

Data Type

Integer

SamplingMessageRole Property (MCPClient Component)

The speaker or author of the message.

Syntax

__property TsdmMCPClientSamplingMessageRoles SamplingMessageRole[int SamplingMessageIndex] = { read=FSamplingMessageRole };

enum TsdmMCPClientSamplingMessageRoles {
  rtUser=0,
  rtAssistant=1
};

Default Value

rtUser

Remarks

The speaker or author of the message.

This property indicates who authored each message and helps provide conversational context to language models. Valid roles include:

The SamplingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SamplingMessageCount property.

This property is read-only and not available at design time.

Data Type

Integer

SamplingMessageText Property (MCPClient Component)

The instruction that can be passed into the client's language model.

Syntax

__property String SamplingMessageText[int SamplingMessageIndex] = { read=FSamplingMessageText, write=FSetSamplingMessageText };

Default Value

""

Remarks

The instruction that can be passed into the client's language model.

This property contains natural language describing an instruction that can be passed into the client's language model (e.g., Review python code, Summarize an article, or Provide an example of using the /n software MCP SDK).

The SamplingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SamplingMessageCount property.

This property is not available at design time.

Data Type

String

Timeout Property (MCPClient Component)

The timeout for operations in seconds.

Syntax

__property int Timeout = { read=FTimeout, write=FSetTimeout };

Default Value

10

Remarks

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

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 component will wait for the operation to complete before returning control. If the timeout expires before the operation completes, the component 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.

This property is not available at design time.

Data Type

Integer

ToolMessageCount Property (MCPClient Component)

The number of records in the ToolMessage arrays.

Syntax

__property int ToolMessageCount = { read=FToolMessageCount, write=FSetToolMessageCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• ToolMessageMessageType
• ToolMessageValue

The array indices start at 0 and end at ToolMessageCount - 1.

This property is not available at design time.

Data Type

Integer

ToolMessageMessageType Property (MCPClient Component)

The data type of the message.

Syntax

__property TsdmMCPClientToolMessageMessageTypes ToolMessageMessageType[int ToolMessageIndex] = { read=FToolMessageMessageType };

enum TsdmMCPClientToolMessageMessageTypes {
  mtText=0,
  mtAudio=1,
  mtImage=2,
  mtResource=3
};

Default Value

mtText

Remarks

The data type of the message.

This property indicates the data type of the message. Valid data types include:

The ToolMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ToolMessageCount property.

This property is read-only and not available at design time.

Data Type

Integer

ToolMessageValue Property (MCPClient Component)

The raw data included in the message.

Syntax

__property String ToolMessageValue[int ToolMessageIndex] = { read=FToolMessageValue, write=FSetToolMessageValue };

Default Value

""

Remarks

The raw data included in the message.

This property contains the raw data included in the message. Its format depends on the value in the ToolMessageType property.

The ToolMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ToolMessageCount property.

This property is not available at design time.

Data Type

String

ToolCount Property (MCPClient Component)

The number of records in the Tool arrays.

Syntax

__property int ToolCount = { read=FToolCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• ToolDescription
• ToolMessageMessageType
• ToolMessageValue
• ToolName

The array indices start at 0 and end at ToolCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

ToolDescription Property (MCPClient Component)

The brief, human-readable description of what the tool does.

Syntax

__property String ToolDescription[int ToolIndex] = { read=FToolDescription };

Default Value

""

Remarks

The brief, human-readable description of what the tool does.

This property holds a brief, human-readable description of what the tool does, which is critical in helping the client to understand when the tool should be invoked.

The ToolIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ToolCount property.

This property is read-only and not available at design time.

Data Type

String

ToolName Property (MCPClient Component)

The unique name associated with the tool.

Syntax

__property String ToolName[int ToolIndex] = { read=FToolName };

Default Value

""

Remarks

The unique name associated with the tool.

This property identifies the unique name associated with the tool.

The ToolIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ToolCount property.

This property is read-only and not available at design time.

Data Type

String

Transport Property (MCPClient Component)

The transport mechanism used for communication.

Syntax

__property TsdmMCPClientTransports Transport = { read=FTransport, write=FSetTransport };

enum TsdmMCPClientTransports {
  ttStdio=1,
  ttHTTP=2
};

Default Value

ttStdio

Remarks

This property indicates whether the component 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 component 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 component to serve multiple clients at once.

This property is not available at design time.

Data Type

Integer

AddPromptParam Method (MCPClient Component)

Adds a prompt parameter.

Syntax

void __fastcall AddPromptParam(String Name, String 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 Component)

Adds a tool parameter.

Syntax

void __fastcall AddToolParam(String Name, String 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 Component)

Sets or retrieves a configuration setting.

Syntax

String __fastcall Config(String ConfigurationString);

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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 Component)

Connects to a MCP server.

Syntax

void __fastcall 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 Component)

Disconnects from a MCP server.

Syntax

void __fastcall 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 Component)

Retrieves a prompt from the server.

Syntax

void __fastcall GetPrompt(String 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 Component)

Invokes a tool from the server.

Syntax

void __fastcall InvokeTool(String 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 Component)

Retrieves the list of prompts available on the server.

Syntax

void __fastcall 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 Component)

Retrieves the list of resources available on the server.

Syntax

void __fastcall 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 Component)

Retrieves the list of tools available on the server.

Syntax

void __fastcall 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 Component)

Reads a resource from the server.

Syntax

void __fastcall ReadResource(String 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 Component)

Fires when an error occurs during operation.

Syntax

typedef struct {
  int ConnectionId;
  int ErrorCode;
  String Description;
} TsdmMCPClientErrorEventParams;
typedef void __fastcall (__closure *TsdmMCPClientErrorEvent)(System::TObject* Sender, TsdmMCPClientErrorEventParams *e);
__property TsdmMCPClientErrorEvent OnError = { read=FOnError, write=FOnError };

Remarks

This event is fired when an unhandled exception is caught by the component, 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 Component)

This event is fired once for each log message.

Syntax

typedef struct {
  int LogLevel;
  String Message;
  String LogType;
} TsdmMCPClientLogEventParams;
typedef void __fastcall (__closure *TsdmMCPClientLogEvent)(System::TObject* Sender, TsdmMCPClientLogEventParams *e);
__property TsdmMCPClientLogEvent OnLog = { read=FOnLog, write=FOnLog };

Remarks

This event fires once for each log message generated by the component. 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 Component)

Fires when the server requests language model generation.

Syntax

typedef struct {
  String ResponseText;
  String SystemPrompt;
  int Role;
  String Model;
  String IntelligencePriority;
  String SpeedPriority;
} TsdmMCPClientSamplingRequestEventParams;
typedef void __fastcall (__closure *TsdmMCPClientSamplingRequestEvent)(System::TObject* Sender, TsdmMCPClientSamplingRequestEventParams *e);
__property TsdmMCPClientSamplingRequestEvent OnSamplingRequest = { read=FOnSamplingRequest, write=FOnSamplingRequest };

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.

Config Settings (MCPClient Component)

The component accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

MCPClient Config Settings

Base Config Settings

Trappable Errors (MCPClient Component)

MCPClient Errors