MCPServer Class

Properties Methods Events Config Settings Errors

Implements an easy way to expose custom tools, prompts, and resources to Model Context Protocol (MCP) clients.

Syntax

MCPServer

Remarks

The MCPServer class provides a simple, event-driven API for interacting with clients that use the Model Context Protocol (MCP).

Supported Transport Mechanisms

The MCPServer class supports multiple transport mechanisms that are used to facilitate communication, which can be specified by setting the Transport property.

For local communication scenarios, such as when the server is launched as a subprocess of a client application, the class is capable of communicating via standard input and output streams. This setup is simple and enables direct data exchange between the client and server within the same process environment.

In remote deployment scenarios, where the server must be accessible to multiple concurrent clients across a network, the class also supports HTTP as the transport layer, using standard HTTP requests and responses for communication. To accommodate different hosting needs, the class includes a built-in embedded HTTP server, but it can also be integrated into an existing web infrastructure such as ASP.NET Core, Apache Tomcat, or other frameworks.

While the developer experience is largely the same between these, there are some differences in authentication and request processing depending on how the server is hosted. Comprehensive information on these hosting options and configuration can be found in the Hosting Options page.

Key Features

The MCPServer 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.

Registering Tools

Tools must be registered with the server via the RegisterTool method to be exposed to the client. Each registration requires a unique Name and a natural language Description. The name identifies the tool, while the description helps LLM clients determine when to use it. Since tool selection is client-driven, writing clear and specific descriptions is key to improving tool usage accuracy.

A tool may have zero or more associated parameters. Each parameter must be registered before the tool it will be associated with. Each parameter requires a Name and a Required boolean indicating if that parameter is required.

server.RegisterToolParam("limit", false); server.RegisterTool("random-num", "Generates a random number");

Handling Tool Invocations

Once a tool is registered, the client may invoke it at any time. When this occurs, the ToolRequest event is fired. This event includes the Name of the requested tool, which the server can use to determine how to respond. If the tool requires input, the server can retrieve parameters from the client using the GetToolParamValue method.

If the tool completes successfully and needs to return output, the server may respond using the AddToolMessage method. If an error occurs, such as an unrecognized tool is requested or a failure occurs during execution, the server should set the IsError parameter to true to inform the client that the request failed.

server.OnToolRequest += (s, e) => { if (e.Name == "random-num") { server.AddToolMessage((int)TToolMessageTypes.mtText, randomNum); } else { e.IsError = true; } };

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. Prompts may also include arguments that allow runtime customization.

Unlike tools, prompts are user-driven. The client does not select prompts on its own; instead, the user chooses when and which prompt to insert, which allows for consistent and reusable guidance tailored to specific workflows.

Registering Prompts

Prompts must be registered with the server via the RegisterPrompt method to be exposed to the client. Each registration requires a unique Name and a natural language Description. The name identifies the prompt, while the description helps the user understand its purpose. Once registered, the prompt becomes available for the end user to insert into the client context as needed.

A prompt may have zero or more associated arguments. Each argument must be registered before the prompt it will be associated with. Each argument requires a Name and a Required boolean indicating if that argument is required.

// Define argument schema. server.RegisterPromptArg("code", true); server.RegisterPromptArg("language", false); // Register the prompt. string name = "explain-code"; string description = "Explain how code works"; server.RegisterPrompt(name, description);

Handling Prompt Requests

When a user selects a prompt, the client notifies the server, causing the PromptRequest event to be fired. This event includes the Name of the requested prompt, allowing the server to determine the correct response to be sent using the AddPromptMessage method. Any related prompt arguments may also be retrieved by their associated name using the GetPromptParamValue method.

server.OnPromptRequest += (s, e) => { // Retrieve runtime values sent by client. string code = server.GetPromptParamValue("code"); string language = server.GetPromptParamValue("language") ?? "Unknown"; // Build response messages. // Assuming the client sent 'a = 1 + 2;' for the 'code' argument, and 'python' for the 'language' argument. server.AddPromptMessage((int)TRoles.rtAssistant, "Don't add comments."); server.AddPromptMessage((int)TRoles.rtUser, $"Explain how this {language} code works:\n\n{code}"); };

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.

Registering Resources

Resources must be registered with the server via the RegisterResource method to be exposed to the client. Each registration requires a unique Uri, a short display Name, and a natural language Description.

server.RegisterResource("file://server.cs", "Server Demo", "The source code for a simple MCP SDK Server Demo");

Handling Resource Requests

When a user requests a resource, the ResourceRequest event is fired. This event includes the Uri of the requested resource, allowing the server to locate and load the correct resource using the AddResourceContent method. The client will manage the resource afterward, making it available for reuse as needed.

server.OnResourceRequest += (s, e) => { string fileName = e.Uri.Substring("file://".Length); if (File.Exists(fileName)) { string content = File.ReadAllText(fileName); server.AddResourceContent(e.Uri, content, "text/plain"); } };

Property List

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


Listening	Whether the class is listening for incoming connections.
ProcessingMode	The mode in which the class will be hosted.
Prompts	A collection of registered prompts.
RegisteredPromptArgs	A collection of prompt arguments to be registered.
RegisteredToolParams	A collection of tool parameters to be registered.
Request	The body of the HTTP request to be processed by the class.
RequestHeaders	The full set of headers of the HTTP request to be processed by the class.
Resources	A collection of registered resources.
Response	The body of the HTTP response generated after processing a request with the class.
ResponseHeaders	The full set of headers of the HTTP response generated after processing a request with the class.
SamplingMessages	A collection of messages to send when requesting language model generation from the client.
ServerCert	The certificate used during SSL negotiation.
ServerSettings	The embedded HTTP server settings used by the class.
SystemPrompt	An instruction sent to the client's language model to influence its behavior during a sampling request.
Tools	A collection of registered tools.
Transport	The transport mechanism used for communication.

Method List

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


AddPromptMessage	Adds a prompt message to be returned during a prompt request.
AddResourceContent	Adds data to be returned during a resource request.
AddToolMessage	Adds a tool message to be returned during a tool request.
Config	Sets or retrieves a configuration setting.
DoEvents	Processes events from the internal queue.
GetPromptParamValue	Retrieves the value of an existing prompt parameter.
GetToolParamValue	Retrieves the value of an existing tool parameter.
ProcessRequest	Processes the request and sends the result.
ProcessRequests	Instructs the class to start processing incoming requests.
RegisterPrompt	Registers a prompt that can be requested by the client.
RegisterPromptArg	Registers an argument for a prompt.
RegisterResource	Registers a resource that can be requested by the client.
RegisterTool	Registers a tool that can be requested by the client.
RegisterToolParam	Registers a parameter for a tool.
SendSamplingRequest	Requests language model reasoning from the client.
StartListening	Instructs the class to start listening for incoming connections.
StopListening	Instructs the class to stop listening for new connections.
UnregisterPrompt	Unregisters an existing prompt.
UnregisterResource	Unregisters an existing resource.
UnregisterTool	Unregisters an existing tool.

Event List

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


Error	Fires when an error occurs during operation.
Log	Fires once for each log message.
PromptRequest	Fires when a prompt is requested by the client.
ResourceRequest	Fires when a resource is requested by the client.
SessionEnd	Fires when the class ends a session.
SessionStart	Fires when the class starts a session.
ToolRequest	Fires when a tool is requested by the client.

Config Settings

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


LogLevel	Specifies the level of detail that is logged.
MaxTokens	Specifies the maximum number of tokens to generate when sampling the client's LLM.
PageSizePrompts	Specifies the page size to use when responding to prompt listing requests from the client.
PageSizeResources	Specifies the page size to use when responding to resource listing requests from the client.
PageSizeTools	Specifies the page size to use when responding to tool listing requests from the client.
BuildInfo	Information about the product's build.
CodePage	The system code page used for Unicode to Multibyte translations.
LicenseInfo	Information about the current license.
MaskSensitiveData	Whether sensitive data is masked in log messages.
ProcessIdleEvents	Whether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillis	The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPI	Whether or not to use the system security libraries or an internal implementation.

Listening Property (MCPServer Class)

Whether the class is listening for incoming connections.

Syntax

ANSI (Cross Platform)
int GetListening();

Unicode (Windows)
BOOL GetListening();

int mcpsdk_mcpserver_getlistening(void* lpObj);

bool getListening();

Default Value

FALSE

Remarks

When the Transport property is set to ttStdio, or it is set to ttHTTP and the ProcessingMode property is set to modeEmbeddedServer, this property indicates whether the class is listening for connections on the port specified by the LocalPort property.

The StartListening and StopListening methods can be used to control whether the class is listening.

This property is read-only.

Data Type

Boolean

ProcessingMode Property (MCPServer Class)

The mode in which the class will be hosted.

Syntax

ANSI (Cross Platform)
int GetProcessingMode();
int SetProcessingMode(int iProcessingMode);

Unicode (Windows)
INT GetProcessingMode();
INT SetProcessingMode(INT iProcessingMode);

Possible Values

MODE_EMBEDDED_SERVER(0), 
MODE_EXTERNAL_SERVER(1), 
MODE_OFFLINE(2)

int mcpsdk_mcpserver_getprocessingmode(void* lpObj);
int mcpsdk_mcpserver_setprocessingmode(void* lpObj, int iProcessingMode);

int getProcessingMode();
int setProcessingMode(int iProcessingMode);

Default Value

Remarks

When the Transport property is set to ttHTTP, this property governs whether the class operates via the embedded HTTP server, an external server, or in a fully-offline mode. Possible values are as follows:

modeEmbeddedServer (0, default): Uses the embedded server.
modeExternalServer (1): Uses an external server framework.
modeOffline (2): Uses offline processing.

Please refer to the Hosting Options pages to learn more about the different processing modes and how they relate to configuring a host server.

Data Type

Integer

Prompts Property (MCPServer Class)

A collection of registered prompts.

Syntax

MCPSDKList<MCPSDKPrompt>* GetPrompts();

int mcpsdk_mcpserver_getpromptcount(void* lpObj);

char* mcpsdk_mcpserver_getpromptdescription(void* lpObj, int promptindex);

char* mcpsdk_mcpserver_getpromptname(void* lpObj, int promptindex);

int getPromptCount();

QString getPromptDescription(int iPromptIndex);

QString getPromptName(int iPromptIndex);

Remarks

This collection holds a list of Prompt items.

Calling the RegisterPrompt and UnregisterPrompt methods will add and remove items to and from this collection, respectively.

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

Data Type

MCPSDKPrompt

RegisteredPromptArgs Property (MCPServer Class)

A collection of prompt arguments to be registered.

Syntax

MCPSDKList<MCPSDKPromptArg>* GetRegisteredPromptArgs();
int SetRegisteredPromptArgs(MCPSDKList<MCPSDKPromptArg>* val);

int mcpsdk_mcpserver_getregisteredpromptargcount(void* lpObj);
int mcpsdk_mcpserver_setregisteredpromptargcount(void* lpObj, int iRegisteredPromptArgCount);

char* mcpsdk_mcpserver_getregisteredpromptargdescription(void* lpObj, int registeredpromptargindex);
int mcpsdk_mcpserver_setregisteredpromptargdescription(void* lpObj, int registeredpromptargindex, const char* lpszRegisteredPromptArgDescription);

char* mcpsdk_mcpserver_getregisteredpromptargname(void* lpObj, int registeredpromptargindex);
int mcpsdk_mcpserver_setregisteredpromptargname(void* lpObj, int registeredpromptargindex, const char* lpszRegisteredPromptArgName);

int mcpsdk_mcpserver_getregisteredpromptargrequired(void* lpObj, int registeredpromptargindex);
int mcpsdk_mcpserver_setregisteredpromptargrequired(void* lpObj, int registeredpromptargindex, int bRegisteredPromptArgRequired);

int getRegisteredPromptArgCount();
int setRegisteredPromptArgCount(int iRegisteredPromptArgCount);

QString getRegisteredPromptArgDescription(int iRegisteredPromptArgIndex);
int setRegisteredPromptArgDescription(int iRegisteredPromptArgIndex, QString qsRegisteredPromptArgDescription);

QString getRegisteredPromptArgName(int iRegisteredPromptArgIndex);
int setRegisteredPromptArgName(int iRegisteredPromptArgIndex, QString qsRegisteredPromptArgName);

bool getRegisteredPromptArgRequired(int iRegisteredPromptArgIndex);
int setRegisteredPromptArgRequired(int iRegisteredPromptArgIndex, bool bRegisteredPromptArgRequired);

Remarks

This collection holds a list of PromptArg items to be registered.

Calling the RegisterPromptArg method will add items to this collection, and calling the RegisterPrompt method will clear this collection.

Example: // Register two prompt argument schemas. server.RegisterPromptArg("code", "Code to explain", true); server.RegisterPromptArg("language", "Programming language", false); // Register the prompt with the added arguments. server.RegisterPrompt("explain-code", "Explain how code works");

This property is not available at design time.

Data Type

MCPSDKPromptArg

RegisteredToolParams Property (MCPServer Class)

A collection of tool parameters to be registered.

Syntax

MCPSDKList<MCPSDKToolParam>* GetRegisteredToolParams();
int SetRegisteredToolParams(MCPSDKList<MCPSDKToolParam>* val);

int mcpsdk_mcpserver_getregisteredtoolparamcount(void* lpObj);
int mcpsdk_mcpserver_setregisteredtoolparamcount(void* lpObj, int iRegisteredToolParamCount);

int mcpsdk_mcpserver_getregisteredtoolparamparamtype(void* lpObj, int registeredtoolparamindex);
int mcpsdk_mcpserver_setregisteredtoolparamparamtype(void* lpObj, int registeredtoolparamindex, int iRegisteredToolParamParamType);

char* mcpsdk_mcpserver_getregisteredtoolparamvalue(void* lpObj, int registeredtoolparamindex);
int mcpsdk_mcpserver_setregisteredtoolparamvalue(void* lpObj, int registeredtoolparamindex, const char* lpszRegisteredToolParamValue);

int getRegisteredToolParamCount();
int setRegisteredToolParamCount(int iRegisteredToolParamCount);

int getRegisteredToolParamParamType(int iRegisteredToolParamIndex);
int setRegisteredToolParamParamType(int iRegisteredToolParamIndex, int iRegisteredToolParamParamType);

QString getRegisteredToolParamValue(int iRegisteredToolParamIndex);
int setRegisteredToolParamValue(int iRegisteredToolParamIndex, QString qsRegisteredToolParamValue);

Remarks

This collection holds a list of ToolParam items to be registered.

Calling the RegisterToolParam method will add items to this collection, and calling the RegisterTool method will clear this collection.

This property is not available at design time.

Data Type

MCPSDKToolParam

Request Property (MCPServer Class)

The body of the HTTP request to be processed by the class.

Syntax

ANSI (Cross Platform)
int GetRequest(char* &lpRequest, int &lenRequest);
int SetRequest(const char* lpRequest, int lenRequest);

Unicode (Windows)
INT GetRequest(LPSTR &lpRequest, INT &lenRequest);
INT SetRequest(LPCSTR lpRequest, INT lenRequest);

int mcpsdk_mcpserver_getrequest(void* lpObj, char** lpRequest, int* lenRequest);
int mcpsdk_mcpserver_setrequest(void* lpObj, const char* lpRequest, int lenRequest);

QByteArray getRequest();
int setRequest(QByteArray qbaRequest);

Default Value

Remarks

When the Transport property is set to ttHTTP and the ProcessingMode property is set to modeOffline, the class processes inbound HTTP requests via this property and the RequestHeaders property.

After setting this property to the full body content of the HTTP request, as well as setting any headers in the RequestHeaders property, the class will begin processing the request when the ProcessRequest method is called.

Data Type

Binary String

RequestHeaders Property (MCPServer Class)

The full set of headers of the HTTP request to be processed by the class.

Syntax

ANSI (Cross Platform)
char* GetRequestHeaders();
int SetRequestHeaders(const char* lpszRequestHeaders);

Unicode (Windows)
LPWSTR GetRequestHeaders();
INT SetRequestHeaders(LPCWSTR lpszRequestHeaders);

char* mcpsdk_mcpserver_getrequestheaders(void* lpObj);
int mcpsdk_mcpserver_setrequestheaders(void* lpObj, const char* lpszRequestHeaders);

QString getRequestHeaders();
int setRequestHeaders(QString qsRequestHeaders);

Default Value

Remarks

When the Transport property is set to ttHTTP and the ProcessingMode property is set to modeOffline, the class processes inbound HTTP requests via this property and the Request property.

After setting this property to the header content of the HTTP request, as well as setting the body content in the Request property, the class will begin processing the request when the ProcessRequest method is called.

Data Type

String

Resources Property (MCPServer Class)

A collection of registered resources.

Syntax

MCPSDKList<MCPSDKResource>* GetResources();

int mcpsdk_mcpserver_getresourcecount(void* lpObj);

char* mcpsdk_mcpserver_getresourcedescription(void* lpObj, int resourceindex);

char* mcpsdk_mcpserver_getresourcemimetype(void* lpObj, int resourceindex);

char* mcpsdk_mcpserver_getresourcename(void* lpObj, int resourceindex);

int mcpsdk_mcpserver_getresourcesize(void* lpObj, int resourceindex);

char* mcpsdk_mcpserver_getresourceuri(void* lpObj, int resourceindex);

int getResourceCount();

QString getResourceDescription(int iResourceIndex);

QString getResourceMimetype(int iResourceIndex);

QString getResourceName(int iResourceIndex);

int getResourceSize(int iResourceIndex);

QString getResourceUri(int iResourceIndex);

Remarks

This collection holds a list of Resource items.

Calling the RegisterResource and UnregisterResource methods will add and remove items to and from this collection, respectively.

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

Data Type

MCPSDKResource

Response Property (MCPServer Class)

The body of the HTTP response generated after processing a request with the class.

Syntax

ANSI (Cross Platform)
int GetResponse(char* &lpResponse, int &lenResponse);
int SetResponse(const char* lpResponse, int lenResponse);

Unicode (Windows)
INT GetResponse(LPSTR &lpResponse, INT &lenResponse);
INT SetResponse(LPCSTR lpResponse, INT lenResponse);

int mcpsdk_mcpserver_getresponse(void* lpObj, char** lpResponse, int* lenResponse);
int mcpsdk_mcpserver_setresponse(void* lpObj, const char* lpResponse, int lenResponse);

QByteArray getResponse();
int setResponse(QByteArray qbaResponse);

Default Value

Remarks

When the Transport property is set to ttHTTP and the ProcessingMode property is set to modeOffline, this property holds the body of the HTTP response that was generated as a result of calling the ProcessRequest method.

Note that this response is not sent to a client, and instead the class simply populates this property along with the ResponseHeaders property.

Data Type

Binary String

ResponseHeaders Property (MCPServer Class)

The full set of headers of the HTTP response generated after processing a request with the class.

Syntax

ANSI (Cross Platform)
char* GetResponseHeaders();
int SetResponseHeaders(const char* lpszResponseHeaders);

Unicode (Windows)
LPWSTR GetResponseHeaders();
INT SetResponseHeaders(LPCWSTR lpszResponseHeaders);

char* mcpsdk_mcpserver_getresponseheaders(void* lpObj);
int mcpsdk_mcpserver_setresponseheaders(void* lpObj, const char* lpszResponseHeaders);

QString getResponseHeaders();
int setResponseHeaders(QString qsResponseHeaders);

Default Value

Remarks

When the Transport property is set to ttHTTP and the ProcessingMode property is set to modeOffline, this property holds the headers of the HTTP response that was generated as a result of calling the ProcessRequest method.

Note that this response is not sent to a client, and instead the class simply populates this property along with the Response property.

Data Type

String

SamplingMessages Property (MCPServer Class)

A collection of messages to send when requesting language model generation from the client.

Syntax

MCPSDKList<MCPSDKSamplingMessage>* GetSamplingMessages();
int SetSamplingMessages(MCPSDKList<MCPSDKSamplingMessage>* val);

int mcpsdk_mcpserver_getsamplingmessagecount(void* lpObj);
int mcpsdk_mcpserver_setsamplingmessagecount(void* lpObj, int iSamplingMessageCount);

int mcpsdk_mcpserver_getsamplingmessagerole(void* lpObj, int samplingmessageindex);

char* mcpsdk_mcpserver_getsamplingmessagetext(void* lpObj, int samplingmessageindex);
int mcpsdk_mcpserver_setsamplingmessagetext(void* lpObj, int samplingmessageindex, const char* lpszSamplingMessageText);

int getSamplingMessageCount();
int setSamplingMessageCount(int iSamplingMessageCount);

int getSamplingMessageRole(int iSamplingMessageIndex);

QString getSamplingMessageText(int iSamplingMessageIndex);
int setSamplingMessageText(int iSamplingMessageIndex, QString qsSamplingMessageText);

Remarks

This collection holds a list of SamplingMessage items.

When the Transport property is set to ttStdio, calling the SendSamplingRequest method sends the messages currently in this collection to the client, where they will be passed into the client's language model as input for text generation.

This property is not available at design time.

Data Type

MCPSDKSamplingMessage

ServerCert Property (MCPServer Class)

The certificate used during SSL negotiation.

Syntax

MCPSDKCertificate* GetServerCert();
int SetServerCert(MCPSDKCertificate* val);

char* mcpsdk_mcpserver_getservercerteffectivedate(void* lpObj);

char* mcpsdk_mcpserver_getservercertexpirationdate(void* lpObj);

char* mcpsdk_mcpserver_getservercertextendedkeyusage(void* lpObj);

char* mcpsdk_mcpserver_getservercertfingerprint(void* lpObj);

char* mcpsdk_mcpserver_getservercertfingerprintsha1(void* lpObj);

char* mcpsdk_mcpserver_getservercertfingerprintsha256(void* lpObj);

char* mcpsdk_mcpserver_getservercertissuer(void* lpObj);

char* mcpsdk_mcpserver_getservercertprivatekey(void* lpObj);

int mcpsdk_mcpserver_getservercertprivatekeyavailable(void* lpObj);

char* mcpsdk_mcpserver_getservercertprivatekeycontainer(void* lpObj);

char* mcpsdk_mcpserver_getservercertpublickey(void* lpObj);

char* mcpsdk_mcpserver_getservercertpublickeyalgorithm(void* lpObj);

int mcpsdk_mcpserver_getservercertpublickeylength(void* lpObj);

char* mcpsdk_mcpserver_getservercertserialnumber(void* lpObj);

char* mcpsdk_mcpserver_getservercertsignaturealgorithm(void* lpObj);

int mcpsdk_mcpserver_getservercertstore(void* lpObj, char** lpServerCertStore, int* lenServerCertStore);
int mcpsdk_mcpserver_setservercertstore(void* lpObj, const char* lpServerCertStore, int lenServerCertStore);

char* mcpsdk_mcpserver_getservercertstorepassword(void* lpObj);
int mcpsdk_mcpserver_setservercertstorepassword(void* lpObj, const char* lpszServerCertStorePassword);

int mcpsdk_mcpserver_getservercertstoretype(void* lpObj);
int mcpsdk_mcpserver_setservercertstoretype(void* lpObj, int iServerCertStoreType);

char* mcpsdk_mcpserver_getservercertsubjectaltnames(void* lpObj);

char* mcpsdk_mcpserver_getservercertthumbprintmd5(void* lpObj);

char* mcpsdk_mcpserver_getservercertthumbprintsha1(void* lpObj);

char* mcpsdk_mcpserver_getservercertthumbprintsha256(void* lpObj);

char* mcpsdk_mcpserver_getservercertusage(void* lpObj);

int mcpsdk_mcpserver_getservercertusageflags(void* lpObj);

char* mcpsdk_mcpserver_getservercertversion(void* lpObj);

char* mcpsdk_mcpserver_getservercertsubject(void* lpObj);
int mcpsdk_mcpserver_setservercertsubject(void* lpObj, const char* lpszServerCertSubject);

int mcpsdk_mcpserver_getservercertencoded(void* lpObj, char** lpServerCertEncoded, int* lenServerCertEncoded);
int mcpsdk_mcpserver_setservercertencoded(void* lpObj, const char* lpServerCertEncoded, int lenServerCertEncoded);

QString getServerCertEffectiveDate();

QString getServerCertExpirationDate();

QString getServerCertExtendedKeyUsage();

QString getServerCertFingerprint();

QString getServerCertFingerprintSHA1();

QString getServerCertFingerprintSHA256();

QString getServerCertIssuer();

QString getServerCertPrivateKey();

bool getServerCertPrivateKeyAvailable();

QString getServerCertPrivateKeyContainer();

QString getServerCertPublicKey();

QString getServerCertPublicKeyAlgorithm();

int getServerCertPublicKeyLength();

QString getServerCertSerialNumber();

QString getServerCertSignatureAlgorithm();

QByteArray getServerCertStore();
int setServerCertStore(QByteArray qbaServerCertStore);

QString getServerCertStorePassword();
int setServerCertStorePassword(QString qsServerCertStorePassword);

int getServerCertStoreType();
int setServerCertStoreType(int iServerCertStoreType);

QString getServerCertSubjectAltNames();

QString getServerCertThumbprintMD5();

QString getServerCertThumbprintSHA1();

QString getServerCertThumbprintSHA256();

QString getServerCertUsage();

int getServerCertUsageFlags();

QString getServerCertVersion();

QString getServerCertSubject();
int setServerCertSubject(QString qsServerCertSubject);

QByteArray getServerCertEncoded();
int setServerCertEncoded(QByteArray qbaServerCertEncoded);

Remarks

When the Transport property is set to ttHTTP and the ProcessingMode property is set to modeEmbeddedServer, this property holds the digital certificate that the class will use during SSL negotiation.

This is the server's certificate, and it must be set before the StartListening method is called.

Data Type

MCPSDKCertificate

ServerSettings Property (MCPServer Class)

The embedded HTTP server settings used by the class.

Syntax

MCPSDKServerSettings* GetServerSettings();
int SetServerSettings(MCPSDKServerSettings* val);

char* mcpsdk_mcpserver_getserversettingsallowedauthmethods(void* lpObj);
int mcpsdk_mcpserver_setserversettingsallowedauthmethods(void* lpObj, const char* lpszServerSettingsAllowedAuthMethods);

char* mcpsdk_mcpserver_getserversettingslocalhost(void* lpObj);
int mcpsdk_mcpserver_setserversettingslocalhost(void* lpObj, const char* lpszServerSettingsLocalHost);

int mcpsdk_mcpserver_getserversettingslocalport(void* lpObj);
int mcpsdk_mcpserver_setserversettingslocalport(void* lpObj, int iServerSettingsLocalPort);

int mcpsdk_mcpserver_getserversettingstimeout(void* lpObj);
int mcpsdk_mcpserver_setserversettingstimeout(void* lpObj, int iServerSettingsTimeout);

QString getServerSettingsAllowedAuthMethods();
int setServerSettingsAllowedAuthMethods(QString qsServerSettingsAllowedAuthMethods);

QString getServerSettingsLocalHost();
int setServerSettingsLocalHost(QString qsServerSettingsLocalHost);

int getServerSettingsLocalPort();
int setServerSettingsLocalPort(int iServerSettingsLocalPort);

int getServerSettingsTimeout();
int setServerSettingsTimeout(int iServerSettingsTimeout);

Remarks

When the Transport property is set to ttHTTP and the ProcessingMode property is set to modeEmbeddedServer, this property is used to define the necessary fields to configure the embedded HTTP server.

Data Type

MCPSDKServerSettings

SystemPrompt Property (MCPServer Class)

An instruction sent to the client's language model to influence its behavior during a sampling request.

Syntax

ANSI (Cross Platform)
char* GetSystemPrompt();
int SetSystemPrompt(const char* lpszSystemPrompt);

Unicode (Windows)
LPWSTR GetSystemPrompt();
INT SetSystemPrompt(LPCWSTR lpszSystemPrompt);

char* mcpsdk_mcpserver_getsystemprompt(void* lpObj);
int mcpsdk_mcpserver_setsystemprompt(void* lpObj, const char* lpszSystemPrompt);

QString getSystemPrompt();
int setSystemPrompt(QString qsSystemPrompt);

Default Value

Remarks

When the Transport property is set to ttStdio, this property specifies an instruction sent to the client's language model to influence its behavior when the SendSamplingRequest method is called. It acts as high-level guidance or context for how the language model should interpret and respond to the messages in the SamplingMessages properties.

Example: server.SystemPrompt = "You are an assistant meant to summarize text only using a formal tone."; SamplingMessage message = new SamplingMessage(); message.Role = TRoles.rtUser; message.Text = "Summarize the following text: " + text; server.SamplingMessages.Add(message); string result = server.SendSamplingRequest();

Data Type

String

Tools Property (MCPServer Class)

A collection of registered tools.

Syntax

MCPSDKList<MCPSDKTool>* GetTools();

int mcpsdk_mcpserver_gettoolcount(void* lpObj);

char* mcpsdk_mcpserver_gettooldescription(void* lpObj, int toolindex);

char* mcpsdk_mcpserver_gettoolname(void* lpObj, int toolindex);

int getToolCount();

QString getToolDescription(int iToolIndex);

QString getToolName(int iToolIndex);

Remarks

This collection holds a list of Tool items.

Calling the RegisterTool and UnregisterTool methods will add and remove items to and from this collection, respectively.

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

Data Type

MCPSDKTool

Transport Property (MCPServer Class)

The transport mechanism used for communication.

Syntax

ANSI (Cross Platform)
int GetTransport();
int SetTransport(int iTransport);

Unicode (Windows)
INT GetTransport();
INT SetTransport(INT iTransport);

Possible Values

TT_STDIO(1), 
TT_HTTP(2)

int mcpsdk_mcpserver_gettransport(void* lpObj);
int mcpsdk_mcpserver_settransport(void* lpObj, int iTransport);

int getTransport();
int setTransport(int iTransport);

Default Value

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.

This property is not available at design time.

Data Type

Integer

AddPromptMessage Method (MCPServer Class)

Adds a prompt message to be returned during a prompt request.

Syntax

ANSI (Cross Platform)
int AddPromptMessage(int irole, const char* lpsztext);

Unicode (Windows)
INT AddPromptMessage(INT irole, LPCWSTR lpsztext);

int mcpsdk_mcpserver_addpromptmessage(void* lpObj, int irole, const char* lpsztext);

int addPromptMessage(int irole, const QString& qstext);

Remarks

This method is used to add a new prompt message to be passed back to the client during an ongoing prompt request. It may only be called from within the PromptRequest event.

Role determines the message's origin and context within the conversation flow. Valid roles include:


`0 (rtUser)`	Message from the end user requesting assistance.
`1 (rtAssistant)`	Message from the client providing responses.

Text contains natural language describing the prompt that will 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).

Example: server.OnPromptRequest += (s, e) => { if (e.Name.Equals("Greeting")) { server.AddPromptMessage((int)TRoles.rtUser, "Hello!"); } };

Advanced Example: server.OnPromptRequest += (s, e) => { if (e.Name.Equals("Code Review")) { string code = server.GetPromptParamValue("code"); string language = server.GetPromptParamValue("language"); string reviewType = server.GetPromptParamValue("reviewType"); string instructions = "Please review the following " + language + " code."; if (!string.IsNullOrEmpty(reviewType)) { instructions += " focusing on " + reviewType; } instructions += ":"; server.AddPromptMessage((int)TRoles.rtUser, instructions); server.AddPromptMessage((int)TRoles.rtUser, code); } };

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

AddResourceContent Method (MCPServer Class)

Adds data to be returned during a resource request.

Syntax

ANSI (Cross Platform)
int AddResourceContent(const char* lpszuri, const char* lpsztext, const char* lpszmimeType);

Unicode (Windows)
INT AddResourceContent(LPCWSTR lpszuri, LPCWSTR lpsztext, LPCWSTR lpszmimeType);

int mcpsdk_mcpserver_addresourcecontent(void* lpObj, const char* lpszuri, const char* lpsztext, const char* lpszmimeType);

int addResourceContent(const QString& qsuri, const QString& qstext, const QString& qsmimeType);

Remarks

This method is used to add resource content to be passed back to the client during an ongoing resource request, providing the actual data that clients are requesting when they access a specific resource. It may only be called from within the ResourceRequest event and may be called multiple times during the same resource request to provide multiple related resources or different versions of the same content.

Uri specifies the unique resource identifier that corresponds to the content being provided.

Text contains text data that will be included in the response for the ongoing resource request.

MimeType (e.g., text/plain or application/json) informs the client of how the data passed into Text should be interpreted and processed.

Example: server.OnResourceRequest += (s, e) => { string uri = e.Uri.ToString(); if (uri.StartsWith("file:///")) { string fileName = uri.Substring("file:///".Length).Replace('/', Path.DirectorySeparatorChar); string fullPath = Path.Combine(baseDir, fileName); if (File.Exists(fullPath)) { string data = File.ReadAllText(fullPath); server.AddResourceContent(uri, data, "text/plain"); } } };

Advanced Example server.OnResourceRequest += (s, e) => { string uri = e.Uri.ToString(); if (uri.StartsWith("file:///")) { string fileName = uri.Substring("file:///".Length).Replace('/', Path.DirectorySeparatorChar); string fullPath = Path.Combine(baseDir, fileName); string fileExtension = Path.GetExtension(fullPath).ToLower(); string mimeType = GetMimeType(fileExtension); if (IsImageFile(fileExtension)) { // Handle image files. byte[] imageBytes = File.ReadAllBytes(fullPath); string base64Image = Convert.ToBase64String(imageBytes); server.AddResourceContent(uri, base64Image, mimeType); } else { // Handle text files. string data = File.ReadAllText(fullPath); server.AddResourceContent(uri, data, mimeType); } } };

Error Handling (C++)

AddToolMessage Method (MCPServer Class)

Adds a tool message to be returned during a tool request.

Syntax

ANSI (Cross Platform)
int AddToolMessage(int imessageType, const char* lpszvalue);

Unicode (Windows)
INT AddToolMessage(INT imessageType, LPCWSTR lpszvalue);

int mcpsdk_mcpserver_addtoolmessage(void* lpObj, int imessageType, const char* lpszvalue);

int addToolMessage(int imessageType, const QString& qsvalue);

Remarks

This method is used to add a new tool message to be passed back to the client during an ongoing tool request. It may only be called from within the ToolRequest event, and should only be called once per each type of data to be returned.

MessageType identifies the data type of the message being added. Valid data types include:


`0 (mtText)`	Natural language text data.
`1 (mtAudio)`	A base64-encoded string representing audio data (e.g., MP3 or WAV).
`2 (mtImage)`	A base64-encoded string representing image data (e.g., PNG or JPEG).
`3 (mtResource)`	A string message representing the contents of a text-based resource (e.g., `file://logs/output.txt`).

Value contains text that will be included in the response for the ongoing tool request.

Error Handling (C++)

Config Method (MCPServer Class)

Sets or retrieves a configuration setting.

Syntax

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* mcpsdk_mcpserver_config(void* lpObj, const char* lpszConfigurationString);

QString config(const QString& qsConfigurationString);

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.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

DoEvents Method (MCPServer Class)

Processes events from the internal queue.

Syntax

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

int mcpsdk_mcpserver_doevents(void* lpObj);

int doEvents();

Remarks

This method causes the component to process any available events. If no events are available, it waits for a preset period of time and then returns.

Error Handling (C++)

GetPromptParamValue Method (MCPServer Class)

Retrieves the value of an existing prompt parameter.

Syntax

ANSI (Cross Platform)
char* GetPromptParamValue(const char* lpszName);

Unicode (Windows)
LPWSTR GetPromptParamValue(LPCWSTR lpszName);

char* mcpsdk_mcpserver_getpromptparamvalue(void* lpObj, const char* lpszName);

QString getPromptParamValue(const QString& qsName);

Remarks

This method is used to retrieve the value of an existing prompt parameter. It may only be called from within the PromptRequest event.

Name contains a unique identifier for the prompt parameter that is being retrieved. This must match the value passed into the RegisterPromptArg method when the parameter was registered.

The value associated with the prompt parameter is returned when calling this method. If the specified parameter does not exist or was not provided by the client, then an empty string is returned.

Example: // Define argument schema. server.RegisterPromptArg("code", "Code to explain", true); server.RegisterPromptArg("language", "Programming language", false); // Register the prompt. string name = "explain-code"; string description = "Explain how code works"; server.RegisterPrompt(name, description); // Handling the prompt request. server.OnPromptRequest += (s, e) => { // Retrieve runtime values sent by client. string code = server.GetPromptParamValue("code"); string language = server.GetPromptParamValue("language") ?? "Unknown"; // Build response messages. // Assuming the client sent 'a = 1 + 2;' for the 'code' argument, and 'python' for the 'language' argument. // The following response should contain a user message with the text 'Explain how this python code works: \n\na = 1 + 2;'. server.AddPromptMessage("user", $"Explain how this {language} code works:\n\n{code}"); };

Error Handling (C++)

GetToolParamValue Method (MCPServer Class)

Retrieves the value of an existing tool parameter.

Syntax

ANSI (Cross Platform)
char* GetToolParamValue(const char* lpszName);

Unicode (Windows)
LPWSTR GetToolParamValue(LPCWSTR lpszName);

char* mcpsdk_mcpserver_gettoolparamvalue(void* lpObj, const char* lpszName);

QString getToolParamValue(const QString& qsName);

Remarks

This method is used to retrieve the value of an existing tool parameter. It may only be called from within the ToolRequest event.

Name contains a unique identifier for the tool parameter that is being retrieved. This must match the value passed into the RegisterToolParam method when the parameter was registered.

The value associated with the tool parameter is returned when calling this method. If the specified parameter does not exist or was not provided by the client, then an empty string is returned.

Error Handling (C++)

ProcessRequest Method (MCPServer Class)

Processes the request and sends the result.

Syntax

ANSI (Cross Platform)
int ProcessRequest();

Unicode (Windows)
INT ProcessRequest();

int mcpsdk_mcpserver_processrequest(void* lpObj);

int processRequest();

Remarks

When the Transport property is set to ttHTTP and the ProcessingMode property is set to modeExternalServer or modeOffline, this method acts as the main entry point for the class and is used to process a specific request. This method should not be called when the class is running in the modeEmbeddedServer mode.

Note that when using the modeOffline mode, the class processes the request and its associated headers supplied via the Request and RequestHeaders properties, respectively, and therefore ignores the parameters of this method.

Note that authentication occurs fully outside the scope of the class, and the logic that verifies these credentials is separate from any interaction with the class. Only once the request has been authenticated through this external verification should the be passed to this method.

Error Handling (C++)

ProcessRequests Method (MCPServer Class)

Instructs the class to start processing incoming requests.

Syntax

ANSI (Cross Platform)
int ProcessRequests();

Unicode (Windows)
INT ProcessRequests();

int mcpsdk_mcpserver_processrequests(void* lpObj);

int processRequests();

Remarks

This method instructs the class to process requests.

Notice that StartListening needs to be called before calling this method.

Error Handling (C++)

RegisterPrompt Method (MCPServer Class)

Registers a prompt that can be requested by the client.

Syntax

ANSI (Cross Platform)
int RegisterPrompt(const char* lpszName, const char* lpszDescription);

Unicode (Windows)
INT RegisterPrompt(LPCWSTR lpszName, LPCWSTR lpszDescription);

int mcpsdk_mcpserver_registerprompt(void* lpObj, const char* lpszName, const char* lpszDescription);

int registerPrompt(const QString& qsName, const QString& qsDescription);

Remarks

This method is used to register a new prompt that can be requested by the client.

Name specifies the unique name identifier for the prompt.

Description is critical in helping the client to understand the purpose and functionality of the prompt and should be set to a brief, human-readable description of what the prompt does.

Any prompt arguments associated with the prompt to be registered must be registered via the RegisterPromptArg method before this method is called.

Once the prompt has been registered, it is added to the Prompts properties and may be requested by the client, causing the PromptRequest event to be fired. Additionally, the RegisteredPromptArgs properties is cleared, and all prompt arguments previously in the properties are applied to the prompt.

Error Handling (C++)

RegisterPromptArg Method (MCPServer Class)

Registers an argument for a prompt.

Syntax

ANSI (Cross Platform)
int RegisterPromptArg(const char* lpszName, const char* lpszDescription, int bRequired);

Unicode (Windows)
INT RegisterPromptArg(LPCWSTR lpszName, LPCWSTR lpszDescription, BOOL bRequired);

int mcpsdk_mcpserver_registerpromptarg(void* lpObj, const char* lpszName, const char* lpszDescription, int bRequired);

int registerPromptArg(const QString& qsName, const QString& qsDescription, bool bRequired);

Remarks

This method is used to register a new argument for a prompt that has not yet been registered via the RegisterPrompt method.

Name specifies the unique name identifier for the prompt argument.

Description identifies what information should be provided to this argument.

Required specifies whether the prompt argument must be supplied by the client when requesting the prompt.

Once the prompt argument has been registered, it is added to the RegisteredPromptArgs properties. All of the prompt arguments in this properties will be applied to the next prompt registered via RegisterPrompt, after which the properties is cleared.

Error Handling (C++)

RegisterResource Method (MCPServer Class)

Registers a resource that can be requested by the client.

Syntax

ANSI (Cross Platform)
int RegisterResource(const char* lpszUri, const char* lpszName, const char* lpszDescription);

Unicode (Windows)
INT RegisterResource(LPCWSTR lpszUri, LPCWSTR lpszName, LPCWSTR lpszDescription);

int mcpsdk_mcpserver_registerresource(void* lpObj, const char* lpszUri, const char* lpszName, const char* lpszDescription);

int registerResource(const QString& qsUri, const QString& qsName, const QString& qsDescription);

Remarks

This method is used to register a new resource that can be requested by the client.

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.

Name indicates the display name of the resource shown to end users by the client.

Description should be set to a brief, human-readable description of the resource's purpose, its content type, and appropriate use cases.

Once the resource has been registered, it is added to the Resources properties and may be requested by the client, causing the ResourceRequest event to be fired.

Note that once registered, resources become available for discovery, but the actual content (including format details and MIME type) is not loaded until a specific resource has been requested.

Resource URIs

Resource URIs represent a unique identifier for a resource and must follow the format: [scheme]://[host]/[path]

Common schemes include:


file://:	For local or file-like resources, even if they do not map directly to a local file (e.g., `file:///example.png`).
https://:	Refers to web-accessible resources. This should only be used if the clients can fetch and parse the content directly (e.g., `https://www.nsoftware.com`).
git://:	Indicates resources that originate from a Git repository (e.g., `git://github.com/nsoftware/repo.git`).

Custom URI Schemes

In addition to the previously listed schemes, applications may define their own custom URI schemes. These must be in accordance with RFC3986, especially with regards to reserved characters and general formatting recommendations. Characters such as :, /, and ? must be percent-encoded when used as data.

Client behavior may vary; therefore when registering resource URIs, servers must be prepared to handle every resource they register, regardless of client behavior. MCP-compatible clients may ignore scheme recommendations or fail to fetch resources as expected.

Error Handling (C++)

RegisterTool Method (MCPServer Class)

Registers a tool that can be requested by the client.

Syntax

ANSI (Cross Platform)
int RegisterTool(const char* lpszName, const char* lpszDescription);

Unicode (Windows)
INT RegisterTool(LPCWSTR lpszName, LPCWSTR lpszDescription);

int mcpsdk_mcpserver_registertool(void* lpObj, const char* lpszName, const char* lpszDescription);

int registerTool(const QString& qsName, const QString& qsDescription);

Remarks

This method is used to register a new tool that can be requested by the client.

Name specifies the unique name identifier for the tool.

Description is critical in helping the client to understand when to invoke this tool should be set to a brief, human-readable description of what the tool does.

Any tool parameters associated with the tool to be registered must be registered via the RegisterToolParam method before this method is called.

Once the tool has been registered, it is added to the Tools properties and may be requested by the client, causing the ToolRequest event to be fired. Additionally, the RegisteredToolParams properties is cleared, and all tool parameters previously in the properties are applied to the tool.

Error Handling (C++)

RegisterToolParam Method (MCPServer Class)

Registers a parameter for a tool.

Syntax

ANSI (Cross Platform)
int RegisterToolParam(const char* lpszName, int bRequired);

Unicode (Windows)
INT RegisterToolParam(LPCWSTR lpszName, BOOL bRequired);

int mcpsdk_mcpserver_registertoolparam(void* lpObj, const char* lpszName, int bRequired);

int registerToolParam(const QString& qsName, bool bRequired);

Remarks

This method is used to register a new parameter for a tool that has not yet been registered via the RegisterTool method.

Name specifies the unique name identifier for the tool parameter.

Required specifies whether the tool parameter must be supplied by the client when requesting the tool.

Once the tool parameter has been registered, it is added to the RegisteredToolParams properties. All of the tool parameters in this properties will be applied to the next tool registered via RegisterTool, after which the properties is cleared.

Error Handling (C++)

SendSamplingRequest Method (MCPServer Class)

Requests language model reasoning from the client.

Syntax

ANSI (Cross Platform)
char* SendSamplingRequest();

Unicode (Windows)
LPWSTR SendSamplingRequest();

char* mcpsdk_mcpserver_sendsamplingrequest(void* lpObj);

QString sendSamplingRequest();

Remarks

When the Transport property is set to ttStdio, this method is used to send a sampling request to the client, which is often used in order to utilize language model reasoning.

When called, the set of messages in the SamplingMessages properties will be passed over to the client in order for them to be used as a prompt for the client's language model. This method will then return the output of the prompt as text.

Example: server.OnToolRequest += (s, e) => { if (e.Name.Contains("summarize-text")) { // Grab text to summarize from the corresponding tool parameter. string text = GetText(); // Custom logic. // Add a prompt asking the client's LLM to summarize the text we just received. SamplingMessage message = new SamplingMessage(); message.Role = TRoles.rtUser; message.Text = "Summarize the following text: " + text; server.SamplingMessages.Add(message); // Send the sampling messages over to the client and request a response. string result = server.SendSamplingRequest(); // Return some text. server.AddToolMessage((int)TToolMessageTypes.mtText, result); } };

System Prompts

When performing a sampling request, the server may specify a system prompt to influence the client's LLM behavior during sampling. A system prompt provides high-level guidance or context for how the language model should interpret and respond to the messages in SamplingMessages. It is especially useful for establishing tone, role, or task-specific instructions.

Error Handling (C++)

StartListening Method (MCPServer Class)

Instructs the class to start listening for incoming connections.

Syntax

ANSI (Cross Platform)
int StartListening();

Unicode (Windows)
INT StartListening();

int mcpsdk_mcpserver_startlistening(void* lpObj);

int startListening();

Remarks

When the Transport property is set to ttStdio, or it is set to ttHTTP and the ProcessingMode property is set to modeEmbeddedServer, this method instructs the class to start listening for incoming connections on the port specified by LocalPort.

To stop listening for new connections, please refer to the StopListening method.

Error Handling (C++)

StopListening Method (MCPServer Class)

Instructs the class to stop listening for new connections.

Syntax

ANSI (Cross Platform)
int StopListening();

Unicode (Windows)
INT StopListening();

int mcpsdk_mcpserver_stoplistening(void* lpObj);

int stopListening();

Remarks

When the Transport property is set to ttStdio, or it is set to ttHTTP and the ProcessingMode property is set to modeEmbeddedServer, this method instructs the class to stop listening for new connections. After being called, any new connection attempts will be rejected. Calling this method does not disconnect existing connections.

Error Handling (C++)

UnregisterPrompt Method (MCPServer Class)

Unregisters an existing prompt.

Syntax

ANSI (Cross Platform)
int UnregisterPrompt(const char* lpszName);

Unicode (Windows)
INT UnregisterPrompt(LPCWSTR lpszName);

int mcpsdk_mcpserver_unregisterprompt(void* lpObj, const char* lpszName);

int unregisterPrompt(const QString& qsName);

Remarks

This method is used to unregister a prompt that had previously been registered via the RegisterPrompt method. Once called, the specified prompt will be removed from the Prompts properties and will not be able to be requested by the client until it is registered again with RegisterPrompt.

Name specifies the unique name identifier for the prompt that will be unregistered. This should match the value passed into RegisterPrompt when the prompt was registered.

Example: // Register a prompt, making it available for clients to request. server.RegisterPromptArg("code-to-review", "The source code to review", true); server.RegisterPrompt("review-code", "Review the specified code"); // Handle client requests. // Unregister the prompt and prevent clients from being able to request it. server.UnregisterPrompt("review-code");

Error Handling (C++)

UnregisterResource Method (MCPServer Class)

Unregisters an existing resource.

Syntax

ANSI (Cross Platform)
int UnregisterResource(const char* lpszUri);

Unicode (Windows)
INT UnregisterResource(LPCWSTR lpszUri);

int mcpsdk_mcpserver_unregisterresource(void* lpObj, const char* lpszUri);

int unregisterResource(const QString& qsUri);

Remarks

This method is used to unregister a resource that had previously been registered via the RegisterResource method. Once called, the specified resource will be removed from the Resources properties and will not be able to be requested by the client until it is registered again with RegisterResource.

Uri specifies the unique identifier for the resource that will be unregistered. This should match the value passed into RegisterResource when the resource was registered.

Example: // Register a resource, making it available for clients to request. server.RegisterResource("file:///kb/test.txt", "Sample resource file", "A sample resource file with text content"); // Handle client requests. // Unregister the resource and prevent clients from being able to request it. server.UnregisterResource("file:///kb/test.txt");

Resource URIs

Resource URIs represent a unique identifier for a resource and must follow the format: [scheme]://[host]/[path]

Common schemes include:


file://:	For local or file-like resources, even if they do not map directly to a local file (e.g., `file:///example.png`).
https://:	Refers to web-accessible resources. This should only be used if the clients can fetch and parse the content directly (e.g., `https://www.nsoftware.com`).
git://:	Indicates resources that originate from a Git repository (e.g., `git://github.com/nsoftware/repo.git`).

Custom URI Schemes

Error Handling (C++)

UnregisterTool Method (MCPServer Class)

Unregisters an existing tool.

Syntax

ANSI (Cross Platform)
int UnregisterTool(const char* lpszName);

Unicode (Windows)
INT UnregisterTool(LPCWSTR lpszName);

int mcpsdk_mcpserver_unregistertool(void* lpObj, const char* lpszName);

int unregisterTool(const QString& qsName);

Remarks

This method is used to unregister a tool that had previously been registered via the RegisterTool method. Once called, the specified tool will be removed from the Tools properties and will not be able to be invoked by the client until it is registered again with RegisterTool.

Name specifies the unique name identifier for the tool that will be unregistered. This should match the value passed into RegisterTool when the tool was registered.

Example: // Register a tool, making it available for clients to invoke. server.RegisterTool("random-num", "Generate a random number"); // Handle client requests. // Unregister the tool and prevent clients from being able to invoke it. server.UnregisterTool("random-num");

Error Handling (C++)

Error Event (MCPServer Class)

Fires when an error occurs during operation.

Syntax

ANSI (Cross Platform)
virtual int FireError(MCPServerErrorEventParams *e);

typedef struct {
  int ConnectionId;
  int ErrorCode;
  const char *Description;
  int reserved;
} MCPServerErrorEventParams;


Unicode (Windows)
virtual INT FireError(MCPServerErrorEventParams *e);

typedef struct {
  INT ConnectionId;
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} MCPServerErrorEventParams;

#define EID_MCPSERVER_ERROR 1

virtual INT MCPSDK_CALL FireError(INT &iConnectionId, INT &iErrorCode, LPSTR &lpszDescription);

class MCPServerErrorEventParams {
public:
  int connectionId();

  int errorCode();

  const QString &description();

  int eventRetVal();
  void setEventRetVal(int iRetVal);
};

// To handle, subclass MCPServer and override this emitter function.
virtual int fireError(MCPServerErrorEventParams *e) {...}
// Or, connect one or more slots to this signal.
void error(MCPServerErrorEventParams *e);

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 (MCPServer Class)

Fires once for each log message.

Syntax

ANSI (Cross Platform)
virtual int FireLog(MCPServerLogEventParams *e);

typedef struct {
  int LogLevel;
  const char *Message;
  const char *LogType;
  int reserved;
} MCPServerLogEventParams;


Unicode (Windows)
virtual INT FireLog(MCPServerLogEventParams *e);

typedef struct {
  INT LogLevel;
  LPCWSTR Message;
  LPCWSTR LogType;
  INT reserved;
} MCPServerLogEventParams;

#define EID_MCPSERVER_LOG 2

virtual INT MCPSDK_CALL FireLog(INT &iLogLevel, LPSTR &lpszMessage, LPSTR &lpszLogType);

class MCPServerLogEventParams {
public:
  int logLevel();

  const QString &message();

  const QString &logType();

  int eventRetVal();
  void setEventRetVal(int iRetVal);
};

// To handle, subclass MCPServer and override this emitter function.
virtual int fireLog(MCPServerLogEventParams *e) {...}
// Or, connect one or more slots to this signal.
void log(MCPServerLogEventParams *e);

Remarks

This event is fired 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:


0 (None)	No messages are logged.
1 (Info - Default)	Informational events are logged.
2 (Verbose)	Detailed data is logged.
3 (Debug)	Debug data including all sent and received NFS operations are logged.

Message is the log message.

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

PromptRequest Event (MCPServer Class)

Fires when a prompt is requested by the client.

Syntax

ANSI (Cross Platform)
virtual int FirePromptRequest(MCPServerPromptRequestEventParams *e);

typedef struct {
  const char *Name;
  const char *Description;
  int reserved;
} MCPServerPromptRequestEventParams;


Unicode (Windows)
virtual INT FirePromptRequest(MCPServerPromptRequestEventParams *e);

typedef struct {
  LPCWSTR Name;
  LPCWSTR Description;
  INT reserved;
} MCPServerPromptRequestEventParams;

#define EID_MCPSERVER_PROMPTREQUEST 3

virtual INT MCPSDK_CALL FirePromptRequest(LPSTR &lpszName, LPSTR &lpszDescription);

class MCPServerPromptRequestEventParams {
public:
  const QString &name();

  const QString &description();

  int eventRetVal();
  void setEventRetVal(int iRetVal);
};

// To handle, subclass MCPServer and override this emitter function.
virtual int firePromptRequest(MCPServerPromptRequestEventParams *e) {...}
// Or, connect one or more slots to this signal.
void promptRequest(MCPServerPromptRequestEventParams *e);

Remarks

This event is fired when a prompt has been requested by the client and allows the server to run custom logic. The text-based output to be returned to the client should be passed to the AddPromptMessage method while handling this event. This method may be called multiple times during the same prompt request to build a complete conversation history with alternating roles.

The GetPromptParamValue method may be called from within this event to retrieve the values for the prompt arguments associated with the requested prompt.

Name contains the unique name associated with the prompt.

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

ResourceRequest Event (MCPServer Class)

Fires when a resource is requested by the client.

Syntax

ANSI (Cross Platform)
virtual int FireResourceRequest(MCPServerResourceRequestEventParams *e);

typedef struct {
  const char *Uri;
  int reserved;
} MCPServerResourceRequestEventParams;


Unicode (Windows)
virtual INT FireResourceRequest(MCPServerResourceRequestEventParams *e);

typedef struct {
  LPCWSTR Uri;
  INT reserved;
} MCPServerResourceRequestEventParams;

#define EID_MCPSERVER_RESOURCEREQUEST 4

virtual INT MCPSDK_CALL FireResourceRequest(LPSTR &lpszUri);

class MCPServerResourceRequestEventParams {
public:
  const QString &uri();

  int eventRetVal();
  void setEventRetVal(int iRetVal);
};

// To handle, subclass MCPServer and override this emitter function.
virtual int fireResourceRequest(MCPServerResourceRequestEventParams *e) {...}
// Or, connect one or more slots to this signal.
void resourceRequest(MCPServerResourceRequestEventParams *e);

Remarks

This event is fired when a resource has been requested by the client and allows the server to run custom logic. The resource content to be returned to the client should be passed to the AddResourceContent method while handling this event. This method may be called multiple times during the same resource request to provide multiple related resources or different versions of the same content.

Uri specifies the unique resource identifier for the requested resource.

Example: server.OnResourceRequest += (s, e) => { string uri = e.Uri.ToString(); if (uri == "file:///logs/app.log") { string logData = File.ReadAllText("app.log"); server.AddResourceContent(uri, logData, "text/plain"); } else { server.Response = "[Unknown resource]"; } };

Resource URIs

Resource URIs represent a unique identifier for a resource and must follow the format: [scheme]://[host]/[path]

Common schemes include:


file://:	For local or file-like resources, even if they do not map directly to a local file (e.g., `file:///example.png`).
https://:	Refers to web-accessible resources. This should only be used if the clients can fetch and parse the content directly (e.g., `https://www.nsoftware.com`).
git://:	Indicates resources that originate from a Git repository (e.g., `git://github.com/nsoftware/repo.git`).

Custom URI Schemes

SessionEnd Event (MCPServer Class)

Fires when the class ends a session.

Syntax

ANSI (Cross Platform)
virtual int FireSessionEnd(MCPServerSessionEndEventParams *e);

typedef struct {
  int64 SessionId;
  int reserved;
} MCPServerSessionEndEventParams;


Unicode (Windows)
virtual INT FireSessionEnd(MCPServerSessionEndEventParams *e);

typedef struct {
  LONG64 SessionId;
  INT reserved;
} MCPServerSessionEndEventParams;

#define EID_MCPSERVER_SESSIONEND 5

virtual INT MCPSDK_CALL FireSessionEnd(LONG64 &lSessionId);

class MCPServerSessionEndEventParams {
public:
  qint64 sessionId();

  int eventRetVal();
  void setEventRetVal(int iRetVal);
};

// To handle, subclass MCPServer and override this emitter function.
virtual int fireSessionEnd(MCPServerSessionEndEventParams *e) {...}
// Or, connect one or more slots to this signal.
void sessionEnd(MCPServerSessionEndEventParams *e);

Remarks

When the Transport property is set to ttHTTP, this event fires when the class ends a previously started session. The class doesn't expect any errors to occur or be reported by handlers of this event.

SessionId specifies the unique identifier for the current session and can be obtained from the initial SessionStart event when the session is first opened.

SessionStart Event (MCPServer Class)

Fires when the class starts a session.

Syntax

ANSI (Cross Platform)
virtual int FireSessionStart(MCPServerSessionStartEventParams *e);

typedef struct {
  int64 SessionId;
  int ResultCode;
  int reserved;
} MCPServerSessionStartEventParams;


Unicode (Windows)
virtual INT FireSessionStart(MCPServerSessionStartEventParams *e);

typedef struct {
  LONG64 SessionId;
  INT ResultCode;
  INT reserved;
} MCPServerSessionStartEventParams;

#define EID_MCPSERVER_SESSIONSTART 6

virtual INT MCPSDK_CALL FireSessionStart(LONG64 &lSessionId, INT &iResultCode);

class MCPServerSessionStartEventParams {
public:
  qint64 sessionId();

  int resultCode();
  void setResultCode(int iResultCode);

  int eventRetVal();
  void setEventRetVal(int iRetVal);
};

// To handle, subclass MCPServer and override this emitter function.
virtual int fireSessionStart(MCPServerSessionStartEventParams *e) {...}
// Or, connect one or more slots to this signal.
void sessionStart(MCPServerSessionStartEventParams *e);

Remarks

When the Transport property is set to ttHTTP, this event fires when a new session with a connected client begins. The lifetime of a session is a single HTTP request and response, meaning once the response has been sent, the session ends.

SessionId is the unique identifier of the session, assigned by the class. It is provided as a parameter in all other events so that the operations for a particular client session may be tracked.

ResultCode provides an opportunity to report the operation as failed. This parameter will always be 0 when the event is fired, indicating the operation was successful. If the event cannot be handled in a "successful" manner for some reason, this must be set to a non-zero value.

Reporting an error will abort the operation.

ToolRequest Event (MCPServer Class)

Fires when a tool is requested by the client.

Syntax

ANSI (Cross Platform)
virtual int FireToolRequest(MCPServerToolRequestEventParams *e);

typedef struct {
  int ConnectionId;
  const char *Name;
  const char *Description;
  int IsError;
  int reserved;
} MCPServerToolRequestEventParams;


Unicode (Windows)
virtual INT FireToolRequest(MCPServerToolRequestEventParams *e);

typedef struct {
  INT ConnectionId;
  LPCWSTR Name;
  LPCWSTR Description;
  BOOL IsError;
  INT reserved;
} MCPServerToolRequestEventParams;

#define EID_MCPSERVER_TOOLREQUEST 7

virtual INT MCPSDK_CALL FireToolRequest(INT &iConnectionId, LPSTR &lpszName, LPSTR &lpszDescription, BOOL &bIsError);

class MCPServerToolRequestEventParams {
public:
  int connectionId();

  const QString &name();

  const QString &description();

  bool isError();
  void setIsError(bool bIsError);

  int eventRetVal();
  void setEventRetVal(int iRetVal);
};

// To handle, subclass MCPServer and override this emitter function.
virtual int fireToolRequest(MCPServerToolRequestEventParams *e) {...}
// Or, connect one or more slots to this signal.
void toolRequest(MCPServerToolRequestEventParams *e);

Remarks

This event is fired when a tool has been requested by the client and allows the server to run custom logic. If applicable, the text-based output to be returned to the client should be passed to the AddToolMessage method while handling this event. This method may be called multiple times, once for each data type, if the tool needs to pass multiple types of data back to the client.

The GetToolParamValue method may be called from within this event to retrieve the values for the tool parameters associated with the requested tool.

Name identifies the unique name associated with the tool.

Description holds the brief, human-readable description of what the tool does, and while not necessary, is often used here for sampling.

IsError may be set to true to indicate when an error condition is met and the tool cannot be handled successfully.

Example: server.OnToolRequest += (s, e) => { if (e.Name.Contains("read-docs")) { // Execute custom logic. string documentation = ReadDocumentation(); // Return some text. server.AddToolMessage((int)TToolMessageTypes.mtText, documentation); } };

Certificate Type

This is the digital certificate being used.

Syntax

MCPSDKCertificate (declared in mcpsdk.h)

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

The following fields are available:

Fields

EffectiveDate
char* (read-only)
Default Value: ""

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

ExpirationDate
char* (read-only)
Default Value: ""

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

ExtendedKeyUsage
char* (read-only)
Default Value: ""

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

Fingerprint
char* (read-only)
Default Value: ""

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

FingerprintSHA1
char* (read-only)
Default Value: ""

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

FingerprintSHA256
char* (read-only)
Default Value: ""

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

Issuer
char* (read-only)
Default Value: ""

The issuer of the certificate. This field contains a string representation of the name of the issuing authority for the certificate.

PrivateKey
char* (read-only)
Default Value: ""

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The PrivateKey may be available but not exportable. In this case, PrivateKey returns an empty string.

PrivateKeyAvailable
int (read-only)
Default Value: FALSE

Whether a PrivateKey is available for the selected certificate. If PrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

PrivateKeyContainer
char* (read-only)
Default Value: ""

The name of the PrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

PublicKey
char* (read-only)
Default Value: ""

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

PublicKeyAlgorithm
char* (read-only)
Default Value: ""

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

PublicKeyLength
int (read-only)
Default Value: 0

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

SerialNumber
char* (read-only)
Default Value: ""

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

SignatureAlgorithm
char* (read-only)
Default Value: ""

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

Store
char*
Default Value: "MY"

The name of the certificate store for the client certificate.

The StoreType field denotes the type of the certificate store specified by Store. If the store is password-protected, specify the password in StorePassword.

Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:


MY	A certificate store holding personal certificates with their associated private keys.
CA	Certifying authority certificates.
ROOT	Root certificates.

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

StorePassword
char*
Default Value: ""

If the type of certificate store requires a password, this field is used to specify the password needed to open the certificate store.

StoreType
int
Default Value: 0

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This field can take one of the following values:


0 (cstUser - default)	For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java.
1 (cstMachine)	For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java.
2 (cstPFXFile)	The certificate store is the name of a PFX (PKCS#12) file containing certificates.
3 (cstPFXBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format.
4 (cstJKSFile)	The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java.
5 (cstJKSBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java.
6 (cstPEMKeyFile)	The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)	The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)	The certificate store is the name of a PKCS#7 file containing certificates.
12 (cstP7BBlob)	The certificate store is a string (binary) representing a certificate store in PKCS#7 format.
13 (cstSSHPublicKeyFile)	The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)	The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)	The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)	The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)	The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)	The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)	The certificate store is a string that contains a JWK (JSON Web Key).
21 (cstBCFKSFile)	The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET.
22 (cstBCFKSBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET.
23 (cstPKCS11)	The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to `cstPKCS11`, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's `CertEncoded` parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the Store and set StorePassword to the PIN. Code Example. SSH Authentication with Security Key: `certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);`
99 (cstAuto)	The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

SubjectAltNames
char* (read-only)
Default Value: ""

Comma-separated lists of alternative subject names for the certificate.

ThumbprintMD5
char* (read-only)
Default Value: ""

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

ThumbprintSHA1
char* (read-only)
Default Value: ""

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

ThumbprintSHA256
char* (read-only)
Default Value: ""

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

Usage
char* (read-only)
Default Value: ""

The text description of UsageFlags.

This value will be one or more of the following strings and will be separated by commas:

Digital Signature
Non-Repudiation
Key Encipherment
Data Encipherment
Key Agreement
Certificate Signing
CRL Signing
Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

UsageFlags
int (read-only)
Default Value: 0

The flags that show intended use for the certificate. The value of UsageFlags is a combination of the following flags:


0x80	Digital Signature
0x40	Non-Repudiation
0x20	Key Encipherment
0x10	Data Encipherment
0x08	Key Agreement
0x04	Certificate Signing
0x02	CRL Signing
0x01	Encipher Only

Please see the Usage field for a text representation of UsageFlags.

This functionality currently is not available when the provider is OpenSSL.

Version
char* (read-only)
Default Value: ""

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

Subject
char*
Default Value: ""

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the field is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:


Field	Meaning
CN	Common Name. This is commonly a hostname like www.server.com.
O	Organization
OU	Organizational Unit
L	Locality
S	State
C	Country
E	Email Address

If a field value contains a comma, it must be quoted.

Encoded
char*
Default Value: ""

The certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.

When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.

Constructors

Certificate()

Creates a instance whose properties can be set.

Certificate(const char* lpEncoded, int lenEncoded)

Parses Encoded as an X.509 public key.

Certificate(int iStoreType, const char* lpStore, int lenStore, const char* lpszStorePassword, const char* lpszSubject)

StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a byte array containing the certificate data. StorePassword is the password used to protect the store.

After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

Prompt Type

A registered prompt.

Syntax

MCPSDKPrompt (declared in mcpsdk.h)

Remarks

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

The following fields are available:

Description
Name

Fields

Description
char*
Default Value: ""

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

This field 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.

Name
char*
Default Value: ""

The unique name associated with the prompt.

This field identifies the unique name associated with the prompt.

Constructors

Prompt()

PromptArg Type

A prompt argument to be registered.

Syntax

MCPSDKPromptArg (declared in mcpsdk.h)

Remarks

This type represents a prompt argument that is yet to be registered.

The following fields are available:

Description
Name
Required

Fields

Description
char*
Default Value: ""

The brief, human-readable description of what information should be provided to this argument.

This field holds a brief, human-readable description of what information should be provided to this argument.

Name
char*
Default Value: ""

The unique name associated with the prompt argument.

This field identifies the unique name associated with the prompt argument.

Required
int
Default Value: TRUE

Whether the prompt argument must be supplied by the client when requesting the prompt.

This field indicates whether the prompt argument must be supplied by the client when requesting the prompt.

Constructors

PromptArg()

Resource Type

A registered resource.

Syntax

MCPSDKResource (declared in mcpsdk.h)

Remarks

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

The following fields are available:

Description
Mimetype
Name
Size
Uri

Fields

Description
char*
Default Value: ""

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

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

Mimetype
char*
Default Value: ""

The media type of the resource content.

This field 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.

Name
char*
Default Value: ""

The display name associated with the resource.

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

Size
int (read-only)
Default Value: 0

The size of the resource content, in bytes.

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

Uri
char*
Default Value: ""

The unique resource identifier associated with the resource.

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

Constructors

Resource()

SamplingMessage Type

An individual message in a sampling request.

Syntax

MCPSDKSamplingMessage (declared in mcpsdk.h)

Remarks

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

The following fields are available:

Role
Text

Fields

Role
int (read-only)
Default Value: 0

The speaker or author of the message.

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


`0 (rtUser)`	Message from the end user requesting assistance.
`1 (rtAssistant)`	Message from the client providing responses.

Text
char*
Default Value: ""

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

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

Constructors

SamplingMessage()

ServerSettings Type

The embedded HTTP server settings used by the component.

Syntax

MCPSDKServerSettings (declared in mcpsdk.h)

Remarks

This type describes the current embedded HTTP server settings used by the class. The fields are used to configure the server.

The following fields are available:

AllowedAuthMethods
LocalHost
LocalPort
Timeout

Fields

AllowedAuthMethods
char*
Default Value: "Anonymous,Basic,Digest,NTLM,Negotiate"

Specifies the authentication schemes that the class will allow.

This field must be set to a valid comma-separated string of authentication scheme values that the embedded server will allow. Possible values are as follows:

Anonymous: Unauthenticated connection requests will be allowed.
Basic: HTTP Basic authentication is allowed.
Digest: Digest authentication is allowed.
NTLM: NTLM authentication is allowed.
Negotiate: Windows Negotiate (Kerberos) authentication is allowed.

LocalHost
char*
Default Value: ""

Specifies the name of the local host or user-assigned IP interface through which connections are initiated or accepted.

This field contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classes) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this field to ensure the desired interface is used.

If the class is connected, the LocalHost field shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.

LocalPort
int
Default Value: 0

Includes the Transmission Control Protocol (TCP) port in the local host where the class listens.

This field must be set before the class can start listening. If this is set to 0, then the TCP/IP subsystem will pick a port number at random.

The service port is not shared among servers, so two classes cannot be listening on the same port at the same time.

Timeout
int
Default Value: 60

Specifies the timeout in seconds for 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, and the operation is not yet complete, the class throws an exception.

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

Constructors

ServerSettings()

Creates an empty settings instance whose properties can be set.

Tool Type

A registered tool.

Syntax

MCPSDKTool (declared in mcpsdk.h)

Remarks

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

The following fields are available:

Description
Name

Fields

Description
char*
Default Value: ""

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

This field 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.

Name
char*
Default Value: ""

The unique name associated with the tool.

This field identifies the unique name associated with the tool.

Constructors

Tool()

ToolParam Type

A tool parameter to be registered.

Syntax

MCPSDKToolParam (declared in mcpsdk.h)

Remarks

This type represents a tool parameter that is yet to be registered.

The following fields are available:

ParamType
Value

Fields

ParamType
int
Default Value: 0

The type of data associated with the tool parameter.

This field indicates the type of data associated with the tool parameter.

Valid data types include:

0 (ptString)
1 (ptNumber)
2 (ptBool)
3 (ptArray)
4 (ptObject)

Value
char*
Default Value: ""

The value associated with the tool parameter.

This field contains the value associated with the tool parameter.

Constructors

ToolParam()

MCPSDKList Type

Syntax

MCPSDKList<T> (declared in mcpsdk.h)

Remarks

MCPSDKList is a generic class that is used to hold a collection of objects of type T, where T is one of the custom types supported by the MCPServer class.

Methods

GetCount	This method returns the current size of the collection. int GetCount() {}
SetCount	This method sets the size of the collection. This method returns `0` if setting the size was successful; or `-1` if the collection is `ReadOnly`. When adding additional objects to a collection call this method to specify the new size. Increasing the size of the collection preserves existing objects in the collection. int SetCount(int count) {}
Get	This method gets the item at the specified position. The `index` parameter specifies the index of the item in the collection. This method returns `NULL` if an invalid `index` is specified. T* Get(int index) {}
Set	This method sets the item at the specified position. The `index` parameter specifies the index of the item in the collection that is being set. This method returns `-1` if an invalid `index` is specified. Note: Objects created using the `new` operator must be freed using the `delete` operator; they will not be automatically freed by the class. T* Set(int index, T* value) {}

Config Settings (MCPServer Class)

The class 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 class, access to these internal properties is provided through the Config method.

MCPServer Config Settings

LogLevel: Specifies the level of detail that is logged.

This configuration controls the level of detail that is logged through the Log event. Possible values are:


0 (None)	No messages are logged.
1 (Info - Default)	Informational events are logged.
2 (Verbose)	Detailed data is logged.
3 (Debug)	Debug data including all relevant sent and received NFS operations are logged.

MaxTokens: Specifies the maximum number of tokens to generate when sampling the client's LLM.

This setting controls the maximum number of tokens a client's LLM can generate in response to a call to SendSamplingRequest. The default value is 100.

PageSizePrompts: Specifies the page size to use when responding to prompt listing requests from the client.

This setting controls the page size when listing prompts. The default value is 100.

The receiving MCP client should also support pagination.

PageSizeResources: Specifies the page size to use when responding to resource listing requests from the client.

This setting controls the page size when listing resources. The default value is 100.

The receiving MCP client should also support pagination.

PageSizeTools: Specifies the page size to use when responding to tool listing requests from the client.

This setting controls the page size when listing tools. The default value is 100.

The receiving MCP client should also support pagination.

Base Config Settings

BuildInfo: Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

CodePage: The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:


Identifier	Name
037	IBM EBCDIC - U.S./Canada
437	OEM - United States
500	IBM EBCDIC - International
708	Arabic - ASMO 708
709	Arabic - ASMO 449+, BCON V4
710	Arabic - Transparent Arabic
720	Arabic - Transparent ASMO
737	OEM - Greek (formerly 437G)
775	OEM - Baltic
850	OEM - Multilingual Latin I
852	OEM - Latin II
855	OEM - Cyrillic (primarily Russian)
857	OEM - Turkish
858	OEM - Multilingual Latin I + Euro symbol
860	OEM - Portuguese
861	OEM - Icelandic
862	OEM - Hebrew
863	OEM - Canadian-French
864	OEM - Arabic
865	OEM - Nordic
866	OEM - Russian
869	OEM - Modern Greek
870	IBM EBCDIC - Multilingual/ROECE (Latin-2)
874	ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875	IBM EBCDIC - Modern Greek
932	ANSI/OEM - Japanese, Shift-JIS
936	ANSI/OEM - Simplified Chinese (PRC, Singapore)
949	ANSI/OEM - Korean (Unified Hangul Code)
950	ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026	IBM EBCDIC - Turkish (Latin-5)
1047	IBM EBCDIC - Latin 1/Open System
1140	IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141	IBM EBCDIC - Germany (20273 + Euro symbol)
1142	IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143	IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144	IBM EBCDIC - Italy (20280 + Euro symbol)
1145	IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146	IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147	IBM EBCDIC - France (20297 + Euro symbol)
1148	IBM EBCDIC - International (500 + Euro symbol)
1149	IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200	Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201	Unicode UCS-2 Big-Endian
1250	ANSI - Central European
1251	ANSI - Cyrillic
1252	ANSI - Latin I
1253	ANSI - Greek
1254	ANSI - Turkish
1255	ANSI - Hebrew
1256	ANSI - Arabic
1257	ANSI - Baltic
1258	ANSI/OEM - Vietnamese
1361	Korean (Johab)
10000	MAC - Roman
10001	MAC - Japanese
10002	MAC - Traditional Chinese (Big5)
10003	MAC - Korean
10004	MAC - Arabic
10005	MAC - Hebrew
10006	MAC - Greek I
10007	MAC - Cyrillic
10008	MAC - Simplified Chinese (GB 2312)
10010	MAC - Romania
10017	MAC - Ukraine
10021	MAC - Thai
10029	MAC - Latin II
10079	MAC - Icelandic
10081	MAC - Turkish
10082	MAC - Croatia
12000	Unicode UCS-4 Little-Endian
12001	Unicode UCS-4 Big-Endian
20000	CNS - Taiwan
20001	TCA - Taiwan
20002	Eten - Taiwan
20003	IBM5550 - Taiwan
20004	TeleText - Taiwan
20005	Wang - Taiwan
20105	IA5 IRV International Alphabet No. 5 (7-bit)
20106	IA5 German (7-bit)
20107	IA5 Swedish (7-bit)
20108	IA5 Norwegian (7-bit)
20127	US-ASCII (7-bit)
20261	T.61
20269	ISO 6937 Non-Spacing Accent
20273	IBM EBCDIC - Germany
20277	IBM EBCDIC - Denmark/Norway
20278	IBM EBCDIC - Finland/Sweden
20280	IBM EBCDIC - Italy
20284	IBM EBCDIC - Latin America/Spain
20285	IBM EBCDIC - United Kingdom
20290	IBM EBCDIC - Japanese Katakana Extended
20297	IBM EBCDIC - France
20420	IBM EBCDIC - Arabic
20423	IBM EBCDIC - Greek
20424	IBM EBCDIC - Hebrew
20833	IBM EBCDIC - Korean Extended
20838	IBM EBCDIC - Thai
20866	Russian - KOI8-R
20871	IBM EBCDIC - Icelandic
20880	IBM EBCDIC - Cyrillic (Russian)
20905	IBM EBCDIC - Turkish
20924	IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932	JIS X 0208-1990 & 0121-1990
20936	Simplified Chinese (GB2312)
21025	IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027	Extended Alpha Lowercase
21866	Ukrainian (KOI8-U)
28591	ISO 8859-1 Latin I
28592	ISO 8859-2 Central Europe
28593	ISO 8859-3 Latin 3
28594	ISO 8859-4 Baltic
28595	ISO 8859-5 Cyrillic
28596	ISO 8859-6 Arabic
28597	ISO 8859-7 Greek
28598	ISO 8859-8 Hebrew
28599	ISO 8859-9 Latin 5
28605	ISO 8859-15 Latin 9
29001	Europa 3
38598	ISO 8859-8 Hebrew
50220	ISO 2022 Japanese with no halfwidth Katakana
50221	ISO 2022 Japanese with halfwidth Katakana
50222	ISO 2022 Japanese JIS X 0201-1989
50225	ISO 2022 Korean
50227	ISO 2022 Simplified Chinese
50229	ISO 2022 Traditional Chinese
50930	Japanese (Katakana) Extended
50931	US/Canada and Japanese
50933	Korean Extended and Korean
50935	Simplified Chinese Extended and Simplified Chinese
50936	Simplified Chinese
50937	US/Canada and Traditional Chinese
50939	Japanese (Latin) Extended and Japanese
51932	EUC - Japanese
51936	EUC - Simplified Chinese
51949	EUC - Korean
51950	EUC - Traditional Chinese
52936	HZ-GB2312 Simplified Chinese
54936	Windows XP: GB18030 Simplified Chinese (4 Byte)
57002	ISCII Devanagari
57003	ISCII Bengali
57004	ISCII Tamil
57005	ISCII Telugu
57006	ISCII Assamese
57007	ISCII Oriya
57008	ISCII Kannada
57009	ISCII Malayalam
57010	ISCII Gujarati
57011	ISCII Punjabi
65000	Unicode UTF-7
65001	Unicode UTF-8

The following is a list of valid code page identifiers for Mac OS only:


Identifier	Name
1	ASCII
2	NEXTSTEP
3	JapaneseEUC
4	UTF8
5	ISOLatin1
6	Symbol
7	NonLossyASCII
8	ShiftJIS
9	ISOLatin2
10	Unicode
11	WindowsCP1251
12	WindowsCP1252
13	WindowsCP1253
14	WindowsCP1254
15	WindowsCP1250
21	ISO2022JP
30	MacOSRoman
10	UTF16String
0x90000100	UTF16BigEndian
0x94000100	UTF16LittleEndian
0x8c000100	UTF32String
0x98000100	UTF32BigEndian
0x9c000100	UTF32LittleEndian
65536	Proprietary

LicenseInfo: Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

Product: The product the license is for.
Product Key: The key the license was generated from.
License Source: Where the license was found (e.g., RuntimeLicense, License File).
License Type: The type of license installed (e.g., Royalty Free, Single Server).
Last Valid Build: The last valid build number for which the license will work.

MaskSensitiveData: Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is true.

ProcessIdleEvents: Whether the class uses its internal event loop to process events when the main thread is idle.

If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.

SelectWaitMillis: The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.

If there are no events to process when DoEvents is called, the class will wait for the amount of time specified here before returning. The default value is 20.

UseInternalSecurityAPI: Whether or not to use the system security libraries or an internal implementation.

When set to false, the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to true tells the class to use the internal implementation instead of using the system security libraries.

On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.

To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.

Trappable Errors (MCPServer Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

MCPServer Errors

104	The class is already listening.