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.

Class Name

MCPSDK_MCPServer

Procedural Interface

 mcpsdk_mcpserver_open();
 mcpsdk_mcpserver_close($res);
 mcpsdk_mcpserver_register_callback($res, $id, $function);
 mcpsdk_mcpserver_get_last_error($res);
 mcpsdk_mcpserver_get_last_error_code($res);
 mcpsdk_mcpserver_set($res, $id, $index, $value);
 mcpsdk_mcpserver_get($res, $id, $index);
 mcpsdk_mcpserver_do_addpromptmessage($res, $role, $text);
 mcpsdk_mcpserver_do_addresourcecontent($res, $uri, $text, $mimetype);
 mcpsdk_mcpserver_do_addtoolmessage($res, $messagetype, $value);
 mcpsdk_mcpserver_do_config($res, $configurationstring);
 mcpsdk_mcpserver_do_doevents($res);
 mcpsdk_mcpserver_do_getpromptparamvalue($res, $name);
 mcpsdk_mcpserver_do_gettoolparamvalue($res, $name);
 mcpsdk_mcpserver_do_processrequest($res);
 mcpsdk_mcpserver_do_processrequests($res);
 mcpsdk_mcpserver_do_registerprompt($res, $name, $description);
 mcpsdk_mcpserver_do_registerpromptarg($res, $name, $description, $required);
 mcpsdk_mcpserver_do_registerresource($res, $uri, $name, $description);
 mcpsdk_mcpserver_do_registertool($res, $name, $description);
 mcpsdk_mcpserver_do_registertoolparam($res, $name, $required);
 mcpsdk_mcpserver_do_sendsamplingrequest($res);
 mcpsdk_mcpserver_do_startlistening($res);
 mcpsdk_mcpserver_do_stoplistening($res);
 mcpsdk_mcpserver_do_unregisterprompt($res, $name);
 mcpsdk_mcpserver_do_unregisterresource($res, $uri);
 mcpsdk_mcpserver_do_unregistertool($res, $name);

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.

Method List

---

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

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.

Config Settings

---

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

Listening Property (MCPSDK_MCPServer Class)

Whether the class is listening for incoming connections.

Object Oriented Interface

public function getListening();

Procedural Interface

mcpsdk_mcpserver_get($res, 1 );

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

The mode in which the class will be hosted.

Object Oriented Interface

public function getProcessingMode();
public function setProcessingMode($value);

Procedural Interface

mcpsdk_mcpserver_get($res, 2 );
mcpsdk_mcpserver_set($res, 2, $value );

Possible Values

MCPSERVER_PROCESSINGMODE_EMBEDDED_SERVER(0), 
MCPSERVER_PROCESSINGMODE_EXTERNAL_SERVER(1), 
MCPSERVER_PROCESSINGMODE_OFFLINE(2)

Default Value

0

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

PromptCount Property (MCPSDK_MCPServer Class)

The number of records in the Prompt arrays.

Object Oriented Interface

public function getPromptCount();

Procedural Interface

mcpsdk_mcpserver_get($res, 3 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• PromptDescription
• PromptName

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

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

Data Type

Integer

PromptDescription Property (MCPSDK_MCPServer Class)

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

Object Oriented Interface

public function getPromptDescription($promptindex);

Procedural Interface

mcpsdk_mcpserver_get($res, 4 , $promptindex);

Default Value

''

Remarks

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

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

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

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

Data Type

String

PromptName Property (MCPSDK_MCPServer Class)

The unique name associated with the prompt.

Object Oriented Interface

public function getPromptName($promptindex);

Procedural Interface

mcpsdk_mcpserver_get($res, 5 , $promptindex);

Default Value

''

Remarks

The unique name associated with the prompt.

This property identifies the unique name associated with the prompt.

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

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

Data Type

String

RegisteredPromptArgCount Property (MCPSDK_MCPServer Class)

The number of records in the RegisteredPromptArg arrays.

Object Oriented Interface

public function getRegisteredPromptArgCount();
public function setRegisteredPromptArgCount($value);

Procedural Interface

mcpsdk_mcpserver_get($res, 6 );
mcpsdk_mcpserver_set($res, 6, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• RegisteredPromptArgDescription
• RegisteredPromptArgName
• RegisteredPromptArgRequired

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

This property is not available at design time.

Data Type

Integer

RegisteredPromptArgDescription Property (MCPSDK_MCPServer Class)

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

Object Oriented Interface

public function getRegisteredPromptArgDescription($registeredpromptargindex);
public function setRegisteredPromptArgDescription($registeredpromptargindex, $value);

Procedural Interface

mcpsdk_mcpserver_get($res, 7 , $registeredpromptargindex);
mcpsdk_mcpserver_set($res, 7, $value , $registeredpromptargindex);

Default Value

''

Remarks

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

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

The $registeredpromptargindex parameter specifies the index of the item in the array. The size of the array is controlled by the RegisteredPromptArgCount property.

This property is not available at design time.

Data Type

String

RegisteredPromptArgName Property (MCPSDK_MCPServer Class)

The unique name associated with the prompt argument.

Object Oriented Interface

public function getRegisteredPromptArgName($registeredpromptargindex);
public function setRegisteredPromptArgName($registeredpromptargindex, $value);

Procedural Interface

mcpsdk_mcpserver_get($res, 8 , $registeredpromptargindex);
mcpsdk_mcpserver_set($res, 8, $value , $registeredpromptargindex);

Default Value

''

Remarks

The unique name associated with the prompt argument.

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

The $registeredpromptargindex parameter specifies the index of the item in the array. The size of the array is controlled by the RegisteredPromptArgCount property.

This property is not available at design time.

Data Type

String

RegisteredPromptArgRequired Property (MCPSDK_MCPServer Class)

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

Object Oriented Interface

public function getRegisteredPromptArgRequired($registeredpromptargindex);
public function setRegisteredPromptArgRequired($registeredpromptargindex, $value);

Procedural Interface

mcpsdk_mcpserver_get($res, 9 , $registeredpromptargindex);
mcpsdk_mcpserver_set($res, 9, $value , $registeredpromptargindex);

Default Value

true

Remarks

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

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

The $registeredpromptargindex parameter specifies the index of the item in the array. The size of the array is controlled by the RegisteredPromptArgCount property.

This property is not available at design time.

Data Type

Boolean

RegisteredToolParamCount Property (MCPSDK_MCPServer Class)

The number of records in the RegisteredToolParam arrays.

Object Oriented Interface

public function getRegisteredToolParamCount();
public function setRegisteredToolParamCount($value);

Procedural Interface

mcpsdk_mcpserver_get($res, 10 );
mcpsdk_mcpserver_set($res, 10, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• RegisteredToolParamParamType
• RegisteredToolParamValue

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

This property is not available at design time.

Data Type

Integer

RegisteredToolParamParamType Property (MCPSDK_MCPServer Class)

The type of data associated with the tool parameter.

Object Oriented Interface

public function getRegisteredToolParamParamType($registeredtoolparamindex);
public function setRegisteredToolParamParamType($registeredtoolparamindex, $value);

Procedural Interface

mcpsdk_mcpserver_get($res, 11 , $registeredtoolparamindex);
mcpsdk_mcpserver_set($res, 11, $value , $registeredtoolparamindex);

Possible Values

MCPSERVER_REGISTEREDTOOLPARAMPARAMTYPE_STRING(0), 
MCPSERVER_REGISTEREDTOOLPARAMPARAMTYPE_NUMBER(1), 
MCPSERVER_REGISTEREDTOOLPARAMPARAMTYPE_BOOL(2), 
MCPSERVER_REGISTEREDTOOLPARAMPARAMTYPE_ARRAY(3), 
MCPSERVER_REGISTEREDTOOLPARAMPARAMTYPE_OBJECT(4)

Default Value

0

Remarks

The type of data associated with the tool parameter.

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

Valid data types include:

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

The $registeredtoolparamindex parameter specifies the index of the item in the array. The size of the array is controlled by the RegisteredToolParamCount property.

This property is not available at design time.

Data Type

Integer

RegisteredToolParamValue Property (MCPSDK_MCPServer Class)

The value associated with the tool parameter.

Object Oriented Interface

public function getRegisteredToolParamValue($registeredtoolparamindex);
public function setRegisteredToolParamValue($registeredtoolparamindex, $value);

Procedural Interface

mcpsdk_mcpserver_get($res, 12 , $registeredtoolparamindex);
mcpsdk_mcpserver_set($res, 12, $value , $registeredtoolparamindex);

Default Value

''

Remarks

The value associated with the tool parameter.

This property contains the value associated with the tool parameter.

The $registeredtoolparamindex parameter specifies the index of the item in the array. The size of the array is controlled by the RegisteredToolParamCount property.

This property is not available at design time.

Data Type

String

Request Property (MCPSDK_MCPServer Class)

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

Object Oriented Interface

public function getRequest();
public function setRequest($value);

Procedural Interface

mcpsdk_mcpserver_get($res, 13 );
mcpsdk_mcpserver_set($res, 13, $value );

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

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

Object Oriented Interface

public function getRequestHeaders();
public function setRequestHeaders($value);

Procedural Interface

mcpsdk_mcpserver_get($res, 14 );
mcpsdk_mcpserver_set($res, 14, $value );

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

ResourceCount Property (MCPSDK_MCPServer Class)

The number of records in the Resource arrays.

Object Oriented Interface

public function getResourceCount();

Procedural Interface

mcpsdk_mcpserver_get($res, 15 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• ResourceDescription
• ResourceMimetype
• ResourceName
• ResourceSize
• ResourceUri

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

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

Data Type

Integer

ResourceDescription Property (MCPSDK_MCPServer Class)

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

Object Oriented Interface

public function getResourceDescription($resourceindex);

Procedural Interface

mcpsdk_mcpserver_get($res, 16 , $resourceindex);

Default Value

''

Remarks

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

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

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

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

Data Type

String

ResourceMimetype Property (MCPSDK_MCPServer Class)

The media type of the resource content.

Object Oriented Interface

public function getResourceMimetype($resourceindex);

Procedural Interface

mcpsdk_mcpserver_get($res, 17 , $resourceindex);

Default Value

''

Remarks

The media type of the resource content.

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

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

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

Data Type

String

ResourceName Property (MCPSDK_MCPServer Class)

The display name associated with the resource.

Object Oriented Interface

public function getResourceName($resourceindex);

Procedural Interface

mcpsdk_mcpserver_get($res, 18 , $resourceindex);

Default Value

''

Remarks

The display name associated with the resource.

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

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

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

Data Type

String

ResourceSize Property (MCPSDK_MCPServer Class)

The size of the resource content, in bytes.

Object Oriented Interface

public function getResourceSize($resourceindex);

Procedural Interface

mcpsdk_mcpserver_get($res, 19 , $resourceindex);

Default Value

0

Remarks

The size of the resource content, in bytes.

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

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

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

Data Type

Integer

ResourceUri Property (MCPSDK_MCPServer Class)

The unique resource identifier associated with the resource.

Object Oriented Interface

public function getResourceUri($resourceindex);

Procedural Interface

mcpsdk_mcpserver_get($res, 20 , $resourceindex);

Default Value

''

Remarks

The unique resource identifier associated with the resource.

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

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

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

Data Type

String

Response Property (MCPSDK_MCPServer Class)

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

Object Oriented Interface

public function getResponse();
public function setResponse($value);

Procedural Interface

mcpsdk_mcpserver_get($res, 21 );
mcpsdk_mcpserver_set($res, 21, $value );

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

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

Object Oriented Interface

public function getResponseHeaders();
public function setResponseHeaders($value);

Procedural Interface

mcpsdk_mcpserver_get($res, 22 );
mcpsdk_mcpserver_set($res, 22, $value );

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

SamplingMessageCount Property (MCPSDK_MCPServer Class)

The number of records in the SamplingMessage arrays.

Object Oriented Interface

public function getSamplingMessageCount();
public function setSamplingMessageCount($value);

Procedural Interface

mcpsdk_mcpserver_get($res, 23 );
mcpsdk_mcpserver_set($res, 23, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• SamplingMessageRole
• SamplingMessageText

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

This property is not available at design time.

Data Type

Integer

SamplingMessageRole Property (MCPSDK_MCPServer Class)

The speaker or author of the message.

Object Oriented Interface

public function getSamplingMessageRole($samplingmessageindex);

Procedural Interface

mcpsdk_mcpserver_get($res, 24 , $samplingmessageindex);

Possible Values

MCPSERVER_SAMPLINGMESSAGEROLE_USER(0), 
MCPSERVER_SAMPLINGMESSAGEROLE_ASSISTANT(1)

Default Value

0

Remarks

The speaker or author of the message.

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

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

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

Data Type

Integer

SamplingMessageText Property (MCPSDK_MCPServer Class)

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

Object Oriented Interface

public function getSamplingMessageText($samplingmessageindex);
public function setSamplingMessageText($samplingmessageindex, $value);

Procedural Interface

mcpsdk_mcpserver_get($res, 25 , $samplingmessageindex);
mcpsdk_mcpserver_set($res, 25, $value , $samplingmessageindex);

Default Value

''

Remarks

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

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

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

This property is not available at design time.

Data Type

String

ServerCertEffectiveDate Property (MCPSDK_MCPServer Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getServerCertEffectiveDate();

Procedural Interface

mcpsdk_mcpserver_get($res, 26 );

Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

ServerCertExpirationDate Property (MCPSDK_MCPServer Class)

The date on which the certificate expires.

Object Oriented Interface

public function getServerCertExpirationDate();

Procedural Interface

mcpsdk_mcpserver_get($res, 27 );

Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

ServerCertExtendedKeyUsage Property (MCPSDK_MCPServer Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getServerCertExtendedKeyUsage();

Procedural Interface

mcpsdk_mcpserver_get($res, 28 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

ServerCertFingerprint Property (MCPSDK_MCPServer Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getServerCertFingerprint();

Procedural Interface

mcpsdk_mcpserver_get($res, 29 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

ServerCertFingerprintSHA1 Property (MCPSDK_MCPServer Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getServerCertFingerprintSHA1();

Procedural Interface

mcpsdk_mcpserver_get($res, 30 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

ServerCertFingerprintSHA256 Property (MCPSDK_MCPServer Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getServerCertFingerprintSHA256();

Procedural Interface

mcpsdk_mcpserver_get($res, 31 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

ServerCertIssuer Property (MCPSDK_MCPServer Class)

The issuer of the certificate.

Object Oriented Interface

public function getServerCertIssuer();

Procedural Interface

mcpsdk_mcpserver_get($res, 32 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

ServerCertPrivateKey Property (MCPSDK_MCPServer Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getServerCertPrivateKey();

Procedural Interface

mcpsdk_mcpserver_get($res, 33 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

ServerCertPrivateKeyAvailable Property (MCPSDK_MCPServer Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getServerCertPrivateKeyAvailable();

Procedural Interface

mcpsdk_mcpserver_get($res, 34 );

Default Value

false

Remarks

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

This property is read-only.

Data Type

Boolean

ServerCertPrivateKeyContainer Property (MCPSDK_MCPServer Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getServerCertPrivateKeyContainer();

Procedural Interface

mcpsdk_mcpserver_get($res, 35 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

ServerCertPublicKey Property (MCPSDK_MCPServer Class)

The public key of the certificate.

Object Oriented Interface

public function getServerCertPublicKey();

Procedural Interface

mcpsdk_mcpserver_get($res, 36 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

ServerCertPublicKeyAlgorithm Property (MCPSDK_MCPServer Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getServerCertPublicKeyAlgorithm();

Procedural Interface

mcpsdk_mcpserver_get($res, 37 );

Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

ServerCertPublicKeyLength Property (MCPSDK_MCPServer Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getServerCertPublicKeyLength();

Procedural Interface

mcpsdk_mcpserver_get($res, 38 );

Default Value

0

Remarks

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

This property is read-only.

Data Type

Integer

ServerCertSerialNumber Property (MCPSDK_MCPServer Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getServerCertSerialNumber();

Procedural Interface

mcpsdk_mcpserver_get($res, 39 );

Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

ServerCertSignatureAlgorithm Property (MCPSDK_MCPServer Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getServerCertSignatureAlgorithm();

Procedural Interface

mcpsdk_mcpserver_get($res, 40 );

Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

ServerCertStore Property (MCPSDK_MCPServer Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getServerCertStore();
public function setServerCertStore($value);

Procedural Interface

mcpsdk_mcpserver_get($res, 41 );
mcpsdk_mcpserver_set($res, 41, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The ServerCertStoreType property denotes the type of the certificate store specified by ServerCertStore. If the store is password-protected, specify the password in ServerCertStorePassword.

ServerCertStore is used in conjunction with the ServerCertSubject property to specify client certificates. If ServerCertStore has a value, and ServerCertSubject or ServerCertEncoded is set, a search for a certificate is initiated. Please see the ServerCertSubject property for details.

Designations of certificate stores are platform dependent.

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

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

Data Type

Binary String

ServerCertStorePassword Property (MCPSDK_MCPServer Class)

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

Object Oriented Interface

public function getServerCertStorePassword();
public function setServerCertStorePassword($value);

Procedural Interface

mcpsdk_mcpserver_get($res, 42 );
mcpsdk_mcpserver_set($res, 42, $value );

Default Value

''

Remarks

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

Data Type

String

ServerCertStoreType Property (MCPSDK_MCPServer Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getServerCertStoreType();
public function setServerCertStoreType($value);

Procedural Interface

mcpsdk_mcpserver_get($res, 43 );
mcpsdk_mcpserver_set($res, 43, $value );

Possible Values

MCPSERVER_SERVERCERTSTORETYPE_USER(0), 
MCPSERVER_SERVERCERTSTORETYPE_MACHINE(1), 
MCPSERVER_SERVERCERTSTORETYPE_PFXFILE(2), 
MCPSERVER_SERVERCERTSTORETYPE_PFXBLOB(3), 
MCPSERVER_SERVERCERTSTORETYPE_JKSFILE(4), 
MCPSERVER_SERVERCERTSTORETYPE_JKSBLOB(5), 
MCPSERVER_SERVERCERTSTORETYPE_PEMKEY_FILE(6), 
MCPSERVER_SERVERCERTSTORETYPE_PEMKEY_BLOB(7), 
MCPSERVER_SERVERCERTSTORETYPE_PUBLIC_KEY_FILE(8), 
MCPSERVER_SERVERCERTSTORETYPE_PUBLIC_KEY_BLOB(9), 
MCPSERVER_SERVERCERTSTORETYPE_SSHPUBLIC_KEY_BLOB(10), 
MCPSERVER_SERVERCERTSTORETYPE_P7BFILE(11), 
MCPSERVER_SERVERCERTSTORETYPE_P7BBLOB(12), 
MCPSERVER_SERVERCERTSTORETYPE_SSHPUBLIC_KEY_FILE(13), 
MCPSERVER_SERVERCERTSTORETYPE_PPKFILE(14), 
MCPSERVER_SERVERCERTSTORETYPE_PPKBLOB(15), 
MCPSERVER_SERVERCERTSTORETYPE_XMLFILE(16), 
MCPSERVER_SERVERCERTSTORETYPE_XMLBLOB(17), 
MCPSERVER_SERVERCERTSTORETYPE_JWKFILE(18), 
MCPSERVER_SERVERCERTSTORETYPE_JWKBLOB(19), 
MCPSERVER_SERVERCERTSTORETYPE_SECURITY_KEY(20), 
MCPSERVER_SERVERCERTSTORETYPE_BCFKSFILE(21), 
MCPSERVER_SERVERCERTSTORETYPE_BCFKSBLOB(22), 
MCPSERVER_SERVERCERTSTORETYPE_PKCS11(23), 
MCPSERVER_SERVERCERTSTORETYPE_AUTO(99)

Default Value

0

Remarks

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 property can take one of the following values:

Data Type

Integer

ServerCertSubjectAltNames Property (MCPSDK_MCPServer Class)

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

Object Oriented Interface

public function getServerCertSubjectAltNames();

Procedural Interface

mcpsdk_mcpserver_get($res, 44 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

ServerCertThumbprintMD5 Property (MCPSDK_MCPServer Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getServerCertThumbprintMD5();

Procedural Interface

mcpsdk_mcpserver_get($res, 45 );

Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

ServerCertThumbprintSHA1 Property (MCPSDK_MCPServer Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getServerCertThumbprintSHA1();

Procedural Interface

mcpsdk_mcpserver_get($res, 46 );

Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

ServerCertThumbprintSHA256 Property (MCPSDK_MCPServer Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getServerCertThumbprintSHA256();

Procedural Interface

mcpsdk_mcpserver_get($res, 47 );

Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

ServerCertUsage Property (MCPSDK_MCPServer Class)

The text description of UsageFlags .

Object Oriented Interface

public function getServerCertUsage();

Procedural Interface

mcpsdk_mcpserver_get($res, 48 );

Default Value

''

Remarks

The text description of ServerCertUsageFlags.

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.

This property is read-only.

Data Type

String

ServerCertUsageFlags Property (MCPSDK_MCPServer Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getServerCertUsageFlags();

Procedural Interface

mcpsdk_mcpserver_get($res, 49 );

Default Value

0

Remarks

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

Please see the ServerCertUsage property for a text representation of ServerCertUsageFlags.

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

This property is read-only.

Data Type

Integer

ServerCertVersion Property (MCPSDK_MCPServer Class)

The certificate's version number.

Object Oriented Interface

public function getServerCertVersion();

Procedural Interface

mcpsdk_mcpserver_get($res, 50 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

ServerCertSubject Property (MCPSDK_MCPServer Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getServerCertSubject();
public function setServerCertSubject($value);

Procedural Interface

mcpsdk_mcpserver_get($res, 51 );
mcpsdk_mcpserver_set($res, 51, $value );

Default Value

''

Remarks

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 property 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:

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

Data Type

String

ServerCertEncoded Property (MCPSDK_MCPServer Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getServerCertEncoded();
public function setServerCertEncoded($value);

Procedural Interface

mcpsdk_mcpserver_get($res, 52 );
mcpsdk_mcpserver_set($res, 52, $value );

Default Value

''

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ServerCertStore and ServerCertSubject properties also may be used to specify a certificate.

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

This property is not available at design time.

Data Type

Binary String

ServerSettingsAllowedAuthMethods Property (MCPSDK_MCPServer Class)

Specifies the authentication schemes that the class will allow.

Object Oriented Interface

public function getServerSettingsAllowedAuthMethods();
public function setServerSettingsAllowedAuthMethods($value);

Procedural Interface

mcpsdk_mcpserver_get($res, 53 );
mcpsdk_mcpserver_set($res, 53, $value );

Default Value

'Anonymous,Basic,Digest,NTLM,Negotiate'

Remarks

Specifies the authentication schemes that the class will allow.

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

Data Type

String

ServerSettingsLocalHost Property (MCPSDK_MCPServer Class)

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

Object Oriented Interface

public function getServerSettingsLocalHost();
public function setServerSettingsLocalHost($value);

Procedural Interface

mcpsdk_mcpserver_get($res, 54 );
mcpsdk_mcpserver_set($res, 54, $value );

Default Value

''

Remarks

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 ServerSettingsLocalHost 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: ServerSettingsLocalHost is not persistent. You must always set it in code, and never in the property window.

Data Type

String

ServerSettingsLocalPort Property (MCPSDK_MCPServer Class)

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

Object Oriented Interface

public function getServerSettingsLocalPort();
public function setServerSettingsLocalPort($value);

Procedural Interface

mcpsdk_mcpserver_get($res, 55 );
mcpsdk_mcpserver_set($res, 55, $value );

Default Value

0

Remarks

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.

Data Type

Integer

ServerSettingsTimeout Property (MCPSDK_MCPServer Class)

Specifies the timeout in seconds for the class.

Object Oriented Interface

public function getServerSettingsTimeout();
public function setServerSettingsTimeout($value);

Procedural Interface

mcpsdk_mcpserver_get($res, 56 );
mcpsdk_mcpserver_set($res, 56, $value );

Default Value

60

Remarks

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 property when any amount of data is successfully sent or received.

Data Type

Integer

SystemPrompt Property (MCPSDK_MCPServer Class)

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

Object Oriented Interface

public function getSystemPrompt();
public function setSystemPrompt($value);

Procedural Interface

mcpsdk_mcpserver_get($res, 57 );
mcpsdk_mcpserver_set($res, 57, $value );

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

ToolCount Property (MCPSDK_MCPServer Class)

The number of records in the Tool arrays.

Object Oriented Interface

public function getToolCount();

Procedural Interface

mcpsdk_mcpserver_get($res, 58 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• ToolDescription
• ToolName

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

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

Data Type

Integer

ToolDescription Property (MCPSDK_MCPServer Class)

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

Object Oriented Interface

public function getToolDescription($toolindex);

Procedural Interface

mcpsdk_mcpserver_get($res, 59 , $toolindex);

Default Value

''

Remarks

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

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

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

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

Data Type

String

ToolName Property (MCPSDK_MCPServer Class)

The unique name associated with the tool.

Object Oriented Interface

public function getToolName($toolindex);

Procedural Interface

mcpsdk_mcpserver_get($res, 60 , $toolindex);

Default Value

''

Remarks

The unique name associated with the tool.

This property identifies the unique name associated with the tool.

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

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

Data Type

String

Transport Property (MCPSDK_MCPServer Class)

The transport mechanism used for communication.

Object Oriented Interface

public function getTransport();
public function setTransport($value);

Procedural Interface

mcpsdk_mcpserver_get($res, 61 );
mcpsdk_mcpserver_set($res, 61, $value );

Possible Values

MCPSERVER_TRANSPORT_STDIO(1), 
MCPSERVER_TRANSPORT_HTTP(2)

Default Value

1

Remarks

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

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

This property is not available at design time.

Data Type

Integer

AddPromptMessage Method (MCPSDK_MCPServer Class)

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

Object Oriented Interface

public function doAddPromptMessage($role, $text);

Procedural Interface

mcpsdk_mcpserver_do_addpromptmessage($res, $role, $text);

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:

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); } };

AddResourceContent Method (MCPSDK_MCPServer Class)

Adds data to be returned during a resource request.

Object Oriented Interface

public function doAddResourceContent($uri, $text, $mimetype);

Procedural Interface

mcpsdk_mcpserver_do_addresourcecontent($res, $uri, $text, $mimetype);

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); } } };

AddToolMessage Method (MCPSDK_MCPServer Class)

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

Object Oriented Interface

public function doAddToolMessage($messagetype, $value);

Procedural Interface

mcpsdk_mcpserver_do_addtoolmessage($res, $messagetype, $value);

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:

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

Config Method (MCPSDK_MCPServer Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

mcpsdk_mcpserver_do_config($res, $configurationstring);

Remarks

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

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

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

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

DoEvents Method (MCPSDK_MCPServer Class)

Processes events from the internal queue.

Object Oriented Interface

public function doEvents();

Procedural Interface

mcpsdk_mcpserver_do_doevents($res);

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.

GetPromptParamValue Method (MCPSDK_MCPServer Class)

Retrieves the value of an existing prompt parameter.

Object Oriented Interface

public function doGetPromptParamValue($name);

Procedural Interface

mcpsdk_mcpserver_do_getpromptparamvalue($res, $name);

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}"); };

GetToolParamValue Method (MCPSDK_MCPServer Class)

Retrieves the value of an existing tool parameter.

Object Oriented Interface

public function doGetToolParamValue($name);

Procedural Interface

mcpsdk_mcpserver_do_gettoolparamvalue($res, $name);

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.

ProcessRequest Method (MCPSDK_MCPServer Class)

Processes the request and sends the result.

Object Oriented Interface

public function doProcessRequest();

Procedural Interface

mcpsdk_mcpserver_do_processrequest($res);

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.

ProcessRequests Method (MCPSDK_MCPServer Class)

Instructs the class to start processing incoming requests.

Object Oriented Interface

public function doProcessRequests();

Procedural Interface

mcpsdk_mcpserver_do_processrequests($res);

Remarks

This method instructs the class to process requests.

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

RegisterPrompt Method (MCPSDK_MCPServer Class)

Registers a prompt that can be requested by the client.

Object Oriented Interface

public function doRegisterPrompt($name, $description);

Procedural Interface

mcpsdk_mcpserver_do_registerprompt($res, $name, $description);

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.

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");

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}"); };

RegisterPromptArg Method (MCPSDK_MCPServer Class)

Registers an argument for a prompt.

Object Oriented Interface

public function doRegisterPromptArg($name, $description, $required);

Procedural Interface

mcpsdk_mcpserver_do_registerpromptarg($res, $name, $description, $required);

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.

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");

RegisterResource Method (MCPSDK_MCPServer Class)

Registers a resource that can be requested by the client.

Object Oriented Interface

public function doRegisterResource($uri, $name, $description);

Procedural Interface

mcpsdk_mcpserver_do_registerresource($res, $uri, $name, $description);

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:

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.

RegisterTool Method (MCPSDK_MCPServer Class)

Registers a tool that can be requested by the client.

Object Oriented Interface

public function doRegisterTool($name, $description);

Procedural Interface

mcpsdk_mcpserver_do_registertool($res, $name, $description);

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.

RegisterToolParam Method (MCPSDK_MCPServer Class)

Registers a parameter for a tool.

Object Oriented Interface

public function doRegisterToolParam($name, $required);

Procedural Interface

mcpsdk_mcpserver_do_registertoolparam($res, $name, $required);

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.

SendSamplingRequest Method (MCPSDK_MCPServer Class)

Requests language model reasoning from the client.

Object Oriented Interface

public function doSendSamplingRequest();

Procedural Interface

mcpsdk_mcpserver_do_sendsamplingrequest($res);

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.

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();

StartListening Method (MCPSDK_MCPServer Class)

Instructs the class to start listening for incoming connections.

Object Oriented Interface

public function doStartListening();

Procedural Interface

mcpsdk_mcpserver_do_startlistening($res);

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 .

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

StopListening Method (MCPSDK_MCPServer Class)

Instructs the class to stop listening for new connections.

Object Oriented Interface

public function doStopListening();

Procedural Interface

mcpsdk_mcpserver_do_stoplistening($res);

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.

UnregisterPrompt Method (MCPSDK_MCPServer Class)

Unregisters an existing prompt.

Object Oriented Interface

public function doUnregisterPrompt($name);

Procedural Interface

mcpsdk_mcpserver_do_unregisterprompt($res, $name);

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");

UnregisterResource Method (MCPSDK_MCPServer Class)

Unregisters an existing resource.

Object Oriented Interface

public function doUnregisterResource($uri);

Procedural Interface

mcpsdk_mcpserver_do_unregisterresource($res, $uri);

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:

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.

UnregisterTool Method (MCPSDK_MCPServer Class)

Unregisters an existing tool.

Object Oriented Interface

public function doUnregisterTool($name);

Procedural Interface

mcpsdk_mcpserver_do_unregistertool($res, $name);

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 Event (MCPSDK_MCPServer Class)

Fires when an error occurs during operation.

Object Oriented Interface

public function fireError($param);

Procedural Interface

mcpsdk_mcpserver_register_callback($res, 1, array($this, 'fireError'));

Parameter List

 'connectionid'
 'errorcode'
 'description'

Remarks

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

ConnectionId identifies the connection associated with the error.

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

Description contains a textual description of the error that occurred.

Log Event (MCPSDK_MCPServer Class)

Fires once for each log message.

Object Oriented Interface

public function fireLog($param);

Procedural Interface

mcpsdk_mcpserver_register_callback($res, 2, array($this, 'fireLog'));

Parameter List

 'loglevel'
 'message'
 'logtype'

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:

Message is the log message.

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

• NFS

PromptRequest Event (MCPSDK_MCPServer Class)

Fires when a prompt is requested by the client.

Object Oriented Interface

public function firePromptRequest($param);

Procedural Interface

mcpsdk_mcpserver_register_callback($res, 3, array($this, 'firePromptRequest'));

Parameter List

 'name'
 'description'

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.

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}"); };

ResourceRequest Event (MCPSDK_MCPServer Class)

Fires when a resource is requested by the client.

Object Oriented Interface

public function fireResourceRequest($param);

Procedural Interface

mcpsdk_mcpserver_register_callback($res, 4, array($this, 'fireResourceRequest'));

Parameter List

 'uri'

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:

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.

SessionEnd Event (MCPSDK_MCPServer Class)

Fires when the class ends a session.

Object Oriented Interface

public function fireSessionEnd($param);

Procedural Interface

mcpsdk_mcpserver_register_callback($res, 5, array($this, 'fireSessionEnd'));

Parameter List

 'sessionid'

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

Fires when the class starts a session.

Object Oriented Interface

public function fireSessionStart($param);

Procedural Interface

mcpsdk_mcpserver_register_callback($res, 6, array($this, 'fireSessionStart'));

Parameter List

 'sessionid'
 'resultcode'

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

Fires when a tool is requested by the client.

Object Oriented Interface

public function fireToolRequest($param);

Procedural Interface

mcpsdk_mcpserver_register_callback($res, 7, array($this, 'fireToolRequest'));

Parameter List

 'connectionid'
 'name'
 'description'
 'iserror'

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); } };

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

Base Config Settings

Trappable Errors (MCPServer Class)

MCPServer Errors