MCPServer Component

Properties Methods Events Config Settings Errors

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

Syntax

nsoftware.MCPSDK.MCPServer

Remarks

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

Supported Transport Mechanisms

The MCPServer component 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 component 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 component also supports HTTP as the transport layer, using standard HTTP requests and responses for communication. To accommodate different hosting needs, the component 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 component supports all major MCP functionality, including tools, prompts, resources, and sampling.

Tools

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

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


Listening	Whether the component is listening for incoming connections.
ProcessingMode	The mode in which the component 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 component.
RequestHeaders	The full set of headers of the HTTP request to be processed by the component.
Resources	A collection of registered resources.
Response	The body of the HTTP response generated after processing a request with the component.
ResponseHeaders	The full set of headers of the HTTP response generated after processing a request with the component.
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 component.
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 component 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 component 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 component to start listening for incoming connections.
StopListening	Instructs the component 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 component with short descriptions. Click on the links for further details.


ConnectionRequest	This event fires when a connection request comes from a remote host.
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 component ends a session.
SessionStart	Fires when the component 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 component 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.
AcceptEncoding	Used to tell the server which types of content encodings the client supports.
AllowHTTPCompression	This property enables HTTP compression for receiving data.
AllowHTTPFallback	Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.
AllowNTLMFallback	Whether to allow fallback from Negotiate to NTLM when authenticating.
Append	Whether to append data to LocalFile.
Authorization	The Authorization string to be sent to the server.
BytesTransferred	Contains the number of bytes transferred in the response data.
ChunkSize	Specifies the chunk size in bytes when using chunked encoding.
CompressHTTPRequest	Set to true to compress the body of a PUT or POST request.
EncodeURL	If set to True the URL will be encoded by the component.
FollowRedirects	Determines what happens when the server issues a redirect.
GetOn302Redirect	If set to True the component will perform a GET on the new location.
HTTP2HeadersWithoutIndexing	HTTP2 headers that should not update the dynamic header table with incremental indexing.
HTTPVersion	The version of HTTP used by the component.
IfModifiedSince	A date determining the maximum age of the desired document.
KeepAlive	Determines whether the HTTP connection is closed after completion of the request.
KerberosSPN	The Service Principal Name for the Kerberos Domain Controller.
LogLevel	The level of detail that is logged.
MaxHeaders	Instructs component to save the amount of headers specified that are returned by the server after a Header event has been fired.
MaxHTTPCookies	Instructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired.
MaxRedirectAttempts	Limits the number of redirects that are followed in a request.
NegotiatedHTTPVersion	The negotiated HTTP version.
OtherHeaders	Other headers as determined by the user (optional).
ProxyAuthorization	The authorization string to be sent to the proxy server.
ProxyAuthScheme	The authorization scheme to be used for the proxy.
ProxyPassword	A password if authentication is to be used for the proxy.
ProxyPort	Port for the proxy server (default 80).
ProxyServer	Name or IP address of a proxy server (optional).
ProxyUser	A user name if authentication is to be used for the proxy.
SentHeaders	The full set of headers as sent by the client.
StatusCode	The status code of the last response from the server.
StatusLine	The first line of the last response from the server.
TransferredData	The contents of the last response from the server.
TransferredDataLimit	The maximum number of incoming bytes to be stored by the component.
TransferredHeaders	The full set of headers as received from the server.
TransferredRequest	The full request as sent by the client.
UseChunkedEncoding	Enables or Disables HTTP chunked encoding for transfers.
UseIDNs	Whether to encode hostnames to internationalized domain names.
UsePlatformDeflate	Whether to use the platform implementation to decompress compressed responses.
UsePlatformHTTPClient	Whether or not to use the platform HTTP client.
UseProxyAutoConfigURL	Whether to use a Proxy auto-config file when attempting a connection.
UserAgent	Information about the user agent (browser).
CloseStreamAfterTransfer	If true, the component will close the upload or download stream after the transfer.
ConnectionTimeout	Sets a separate timeout value for establishing a connection.
FirewallAutoDetect	Tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHost	Name or IP address of firewall (optional).
FirewallListener	If true, the component binds to a SOCKS firewall as a server (TCPClient only).
FirewallPassword	Password to be used if authentication is to be used when connecting through the firewall.
FirewallPort	The TCP port for the FirewallHost;.
FirewallType	Determines the type of firewall to connect through.
FirewallUser	A user name if authentication is to be used connecting through a firewall.
KeepAliveInterval	The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTime	The inactivity time in milliseconds before a TCP keep-alive packet is sent.
Linger	When set to True, connections are terminated gracefully.
LingerTime	Time in seconds to have the connection linger.
LocalHost	The name of the local host through which connections are initiated or accepted.
LocalPort	The port in the local host where the component binds.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
MaxTransferRate	The transfer rate limit in bytes per second.
ProxyExceptionsList	A semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAlive	Determines whether or not the keep alive socket option is enabled.
TcpNoDelay	Whether or not to delay when sending packets.
UseIPv6	Whether to use IPv6.
UseNTLMv2	Whether to use NTLM V2.
CACertFilePaths	The paths to CA certificate files when using Mono on Unix/Linux.
LogSSLPackets	Controls whether SSL packets are logged when using the internal security API.
ReuseSSLSession	Determines if the SSL session is reused.
SSLCACerts	A newline separated list of CA certificates to be included when performing an SSL handshake.
SSLCheckCRL	Whether to check the Certificate Revocation List for the server certificate.
SSLCheckOCSP	Whether to use OCSP to check the status of the server certificate.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLClientCACerts	A newline separated list of CA certificates to use during SSL client certificate validation.
SSLEnabledCipherSuites	The cipher suite to be used in an SSL negotiation.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
SSLEnableRenegotiation	Whether the renegotiation_info SSL extension is supported.
SSLIncludeCertChain	Whether the entire certificate chain is included in the SSLServerAuthentication event.
SSLKeyLogFile	The location of a file where per-session secrets are written for debugging purposes.
SSLNegotiatedCipher	Returns the negotiated cipher suite.
SSLNegotiatedCipherStrength	Returns the negotiated cipher suite strength.
SSLNegotiatedCipherSuite	Returns the negotiated cipher suite.
SSLNegotiatedKeyExchange	Returns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrength	Returns the negotiated key exchange algorithm strength.
SSLNegotiatedVersion	Returns the negotiated protocol version.
SSLSecurityFlags	Flags that control certificate verification.
SSLServerCACerts	A newline separated list of CA certificates to use during SSL server certificate validation.
TLS12SignatureAlgorithms	Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.
TLS12SupportedGroups	The supported groups for ECC.
TLS13KeyShareGroups	The groups for which to pregenerate key shares.
TLS13SignatureAlgorithms	The allowed certificate signature algorithms.
TLS13SupportedGroups	The supported groups for (EC)DHE key exchange.
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallData	Used to send extra data to the firewall.
InBufferSize	The size in bytes of the incoming queue of the socket.
OutBufferSize	The size in bytes of the outgoing queue of the socket.
BuildInfo	Information about the product's build.
GUIAvailable	Whether or not a message loop is available for processing events.
LicenseInfo	Information about the current license.
MaskSensitiveData	Whether sensitive data is masked in log messages.
UseInternalSecurityAPI	Whether or not to use the system security libraries or an internal implementation.

Listening Property (MCPServer Component)

Whether the component is listening for incoming connections.

public bool Listening { get; }

Public ReadOnly Property Listening As Boolean

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 component is listening for connections on the port specified by the LocalPort property.

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

This property is read-only.

ProcessingMode Property (MCPServer Component)

The mode in which the component will be hosted.

Syntax

C#
VB.NET

public MCPServerProcessingModes ProcessingMode { get; set; }

enum MCPServerProcessingModes {
  modeEmbeddedServer,
  modeExternalServer,
  modeOffline
}

Public Property ProcessingMode As McpserverProcessingModes

Enum MCPServerProcessingModes
  modeEmbeddedServer
  modeExternalServer
  modeOffline
End Enum

Default Value

Remarks

When the Transport property is set to ttHTTP, this property governs whether the component 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.

Prompts Property (MCPServer Component)

A collection of registered prompts.

Syntax

C#
VB.NET

public PromptList Prompts { get; }

Public ReadOnly Property Prompts As PromptList

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.

Please refer to the Prompt type for a complete list of fields.

RegisteredPromptArgs Property (MCPServer Component)

A collection of prompt arguments to be registered.

Syntax

C#
VB.NET

public PromptArgList RegisteredPromptArgs { get; }

Public Property RegisteredPromptArgs As PromptArgList

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.

Please refer to the PromptArg type for a complete list of fields.

RegisteredToolParams Property (MCPServer Component)

A collection of tool parameters to be registered.

Syntax

C#
VB.NET

public ToolParamList RegisteredToolParams { get; }

Public Property RegisteredToolParams As ToolParamList

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.

Please refer to the ToolParam type for a complete list of fields.

Request Property (MCPServer Component)

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

Syntax

C#
VB.NET

public string Request { get; set; }
public byte[] RequestB { get; set; }

Public Property Request As String
Public Property RequestB As Byte()

Default Value

Remarks

When the Transport property is set to ttHTTP and the ProcessingMode property is set to modeOffline, the component 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 component will begin processing the request when the ProcessRequest method is called.

RequestHeaders Property (MCPServer Component)

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

Syntax

C#
VB.NET

public string RequestHeaders { get; set; }

Public Property RequestHeaders As String

Default Value

Remarks

When the Transport property is set to ttHTTP and the ProcessingMode property is set to modeOffline, the component 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 component will begin processing the request when the ProcessRequest method is called.

Resources Property (MCPServer Component)

A collection of registered resources.

Syntax

C#
VB.NET

public ResourceList Resources { get; }

Public ReadOnly Property Resources As ResourceList

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.

Please refer to the Resource type for a complete list of fields.

Response Property (MCPServer Component)

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

Syntax

C#
VB.NET

public string Response { get; set; }
public byte[] ResponseB { get; set; }

Public Property Response As String
Public Property ResponseB As Byte()

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 component simply populates this property along with the ResponseHeaders property.

ResponseHeaders Property (MCPServer Component)

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

Syntax

C#
VB.NET

public string ResponseHeaders { get; set; }

Public Property ResponseHeaders As String

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 component simply populates this property along with the Response property.

SamplingMessages Property (MCPServer Component)

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

Syntax

C#
VB.NET

public SamplingMessageList SamplingMessages { get; }

Public Property SamplingMessages As SamplingMessageList

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.

Please refer to the SamplingMessage type for a complete list of fields.

ServerCert Property (MCPServer Component)

The certificate used during SSL negotiation.

Syntax

C#
VB.NET

public Certificate ServerCert { get; set; }

Public Property ServerCert As Certificate

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 component will use during SSL negotiation.

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

Please refer to the Certificate type for a complete list of fields.

ServerSettings Property (MCPServer Component)

The embedded HTTP server settings used by the component.

Syntax

C#
VB.NET

public ServerSettings ServerSettings { get; set; }

Public Property ServerSettings As ServerSettings

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.

Please refer to the ServerSettings type for a complete list of fields.

SystemPrompt Property (MCPServer Component)

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

Syntax

C#
VB.NET

public string SystemPrompt { get; set; }

Public Property SystemPrompt As String

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

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

Tools Property (MCPServer Component)

A collection of registered tools.

Syntax

C#
VB.NET

public ToolList Tools { get; }

Public ReadOnly Property Tools As ToolList

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.

Please refer to the Tool type for a complete list of fields.

Transport Property (MCPServer Component)

The transport mechanism used for communication.

Syntax

C#
VB.NET

public MCPServerTransports Transport { get; set; }

enum MCPServerTransports {
  ttStdio,
  ttHTTP
}

Public Property Transport As McpserverTransports

Enum MCPServerTransports
  ttStdio
  ttHTTP
End Enum

Default Value

Remarks

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

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

This property is not available at design time.

AddPromptMessage Method (MCPServer Component)

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

Syntax

C#
VB.NET

public void AddPromptMessage(int role, string text);

Async Version
public async Task AddPromptMessage(int role, string text);
public async Task AddPromptMessage(int role, string text, CancellationToken cancellationToken);

Public Sub AddPromptMessage(ByVal role As Integer, ByVal text As String)

Async Version
Public Sub AddPromptMessage(ByVal role As Integer, ByVal text As String) As Task
Public Sub AddPromptMessage(ByVal role As Integer, ByVal text As String, cancellationToken As CancellationToken) As Task

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

AddResourceContent Method (MCPServer Component)

Adds data to be returned during a resource request.

Syntax

C#
VB.NET

public void AddResourceContent(string uri, string text, string mimeType);

Async Version
public async Task AddResourceContent(string uri, string text, string mimeType);
public async Task AddResourceContent(string uri, string text, string mimeType, CancellationToken cancellationToken);

Public Sub AddResourceContent(ByVal uri As String, ByVal text As String, ByVal mimeType As String)

Async Version
Public Sub AddResourceContent(ByVal uri As String, ByVal text As String, ByVal mimeType As String) As Task
Public Sub AddResourceContent(ByVal uri As String, ByVal text As String, ByVal mimeType As String, cancellationToken As CancellationToken) As Task

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

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

Syntax

C#
VB.NET

public void AddToolMessage(int messageType, string value);

Async Version
public async Task AddToolMessage(int messageType, string value);
public async Task AddToolMessage(int messageType, string value, CancellationToken cancellationToken);

Public Sub AddToolMessage(ByVal messageType As Integer, ByVal value As String)

Async Version
Public Sub AddToolMessage(ByVal messageType As Integer, ByVal value As String) As Task
Public Sub AddToolMessage(ByVal messageType As Integer, ByVal value As String, cancellationToken As CancellationToken) As Task

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.

Config Method (MCPServer Component)

Sets or retrieves a configuration setting.

Syntax

C#
VB.NET

public string Config(string configurationString);

Async Version
public async Task<string> Config(string configurationString);
public async Task<string> Config(string configurationString, CancellationToken cancellationToken);

Public Function Config(ByVal ConfigurationString As String) As String

Async Version
Public Function Config(ByVal ConfigurationString As String) As Task(Of String)
Public Function Config(ByVal ConfigurationString As String, cancellationToken As CancellationToken) As Task(Of String)

Remarks

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

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

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

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

DoEvents Method (MCPServer Component)

Processes events from the internal queue.

Syntax

C#
VB.NET

public void DoEvents();

Async Version
public async Task DoEvents();
public async Task DoEvents(CancellationToken cancellationToken);

Public Sub DoEvents()

Async Version
Public Sub DoEvents() As Task
Public Sub DoEvents(cancellationToken As CancellationToken) As Task

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

Retrieves the value of an existing prompt parameter.

Syntax

C#
VB.NET

public string GetPromptParamValue(string name);

Async Version
public async Task<string> GetPromptParamValue(string name);
public async Task<string> GetPromptParamValue(string name, CancellationToken cancellationToken);

Public Function GetPromptParamValue(ByVal Name As String) As String

Async Version
Public Function GetPromptParamValue(ByVal Name As String) As Task(Of String)
Public Function GetPromptParamValue(ByVal Name As String, cancellationToken As CancellationToken) As Task(Of String)

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

Retrieves the value of an existing tool parameter.

Syntax

C#
VB.NET

public string GetToolParamValue(string name);

Async Version
public async Task<string> GetToolParamValue(string name);
public async Task<string> GetToolParamValue(string name, CancellationToken cancellationToken);

Public Function GetToolParamValue(ByVal Name As String) As String

Async Version
Public Function GetToolParamValue(ByVal Name As String) As Task(Of String)
Public Function GetToolParamValue(ByVal Name As String, cancellationToken As CancellationToken) As Task(Of String)

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

Processes the request and sends the result.

Syntax

C#
VB.NET

public void ProcessRequest(object Context);

Async Version
public async Task ProcessRequest();
public async Task ProcessRequest(CancellationToken cancellationToken);

Public Sub ProcessRequest(ByVal Context As Object)

Async Version
Public Sub ProcessRequest() As Task
Public Sub ProcessRequest(cancellationToken As CancellationToken) As Task

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 component and is used to process a specific request. This method should not be called when the component is running in the modeEmbeddedServer mode.

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

When using the modeExternalServer mode, Context must be set to an instance of the HttpContext class that corresponds to the request to be handled.

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

ProcessRequests Method (MCPServer Component)

Instructs the component to start processing incoming requests.

Syntax

C#
VB.NET

public void ProcessRequests();

Async Version
public async Task ProcessRequests();
public async Task ProcessRequests(CancellationToken cancellationToken);

Public Sub ProcessRequests()

Async Version
Public Sub ProcessRequests() As Task
Public Sub ProcessRequests(cancellationToken As CancellationToken) As Task

Remarks

This method instructs the component to process requests.

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

RegisterPrompt Method (MCPServer Component)

Registers a prompt that can be requested by the client.

Syntax

C#
VB.NET

public void RegisterPrompt(string name, string description);

Async Version
public async Task RegisterPrompt(string name, string description);
public async Task RegisterPrompt(string name, string description, CancellationToken cancellationToken);

Public Sub RegisterPrompt(ByVal Name As String, ByVal Description As String)

Async Version
Public Sub RegisterPrompt(ByVal Name As String, ByVal Description As String) As Task
Public Sub RegisterPrompt(ByVal Name As String, ByVal Description As String, cancellationToken As CancellationToken) As Task

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 collection and may be requested by the client, causing the PromptRequest event to be fired. Additionally, the RegisteredPromptArgs collection is cleared, and all prompt arguments previously in the collection are applied to the prompt.

RegisterPromptArg Method (MCPServer Component)

Registers an argument for a prompt.

Syntax

C#
VB.NET

public void RegisterPromptArg(string name, string description, bool required);

Async Version
public async Task RegisterPromptArg(string name, string description, bool required);
public async Task RegisterPromptArg(string name, string description, bool required, CancellationToken cancellationToken);

Public Sub RegisterPromptArg(ByVal Name As String, ByVal Description As String, ByVal Required As Boolean)

Async Version
Public Sub RegisterPromptArg(ByVal Name As String, ByVal Description As String, ByVal Required As Boolean) As Task
Public Sub RegisterPromptArg(ByVal Name As String, ByVal Description As String, ByVal Required As Boolean, cancellationToken As CancellationToken) As Task

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 collection. All of the prompt arguments in this collection will be applied to the next prompt registered via RegisterPrompt, after which the collection is cleared.

RegisterResource Method (MCPServer Component)

Registers a resource that can be requested by the client.

Syntax

C#
VB.NET

public void RegisterResource(string uri, string name, string description);

Async Version
public async Task RegisterResource(string uri, string name, string description);
public async Task RegisterResource(string uri, string name, string description, CancellationToken cancellationToken);

Public Sub RegisterResource(ByVal Uri As String, ByVal Name As String, ByVal Description As String)

Async Version
Public Sub RegisterResource(ByVal Uri As String, ByVal Name As String, ByVal Description As String) As Task
Public Sub RegisterResource(ByVal Uri As String, ByVal Name As String, ByVal Description As String, cancellationToken As CancellationToken) As Task

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

RegisterTool Method (MCPServer Component)

Registers a tool that can be requested by the client.

Syntax

C#
VB.NET

public void RegisterTool(string name, string description);

Async Version
public async Task RegisterTool(string name, string description);
public async Task RegisterTool(string name, string description, CancellationToken cancellationToken);

Public Sub RegisterTool(ByVal Name As String, ByVal Description As String)

Async Version
Public Sub RegisterTool(ByVal Name As String, ByVal Description As String) As Task
Public Sub RegisterTool(ByVal Name As String, ByVal Description As String, cancellationToken As CancellationToken) As Task

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 collection and may be requested by the client, causing the ToolRequest event to be fired. Additionally, the RegisteredToolParams collection is cleared, and all tool parameters previously in the collection are applied to the tool.

RegisterToolParam Method (MCPServer Component)

Registers a parameter for a tool.

Syntax

C#
VB.NET

public void RegisterToolParam(string name, string description, bool required);

Async Version
public async Task RegisterToolParam(string name, string description, bool required);
public async Task RegisterToolParam(string name, string description, bool required, CancellationToken cancellationToken);

Public Sub RegisterToolParam(ByVal Name As String, ByVal Description As String, ByVal Required As Boolean)

Async Version
Public Sub RegisterToolParam(ByVal Name As String, ByVal Description As String, ByVal Required As Boolean) As Task
Public Sub RegisterToolParam(ByVal Name As String, ByVal Description As String, ByVal Required As Boolean, cancellationToken As CancellationToken) As Task

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.

Description specifies the tool parameter description, should be set to a brief, human-readable description of what the tool parameter is aboout.

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 collection. All of the tool parameters in this collection will be applied to the next tool registered via RegisterTool, after which the collection is cleared.

SendSamplingRequest Method (MCPServer Component)

Requests language model reasoning from the client.

Syntax

C#
VB.NET

public string SendSamplingRequest();

Async Version
public async Task<string> SendSamplingRequest();
public async Task<string> SendSamplingRequest(CancellationToken cancellationToken);

Public Function SendSamplingRequest() As String

Async Version
Public Function SendSamplingRequest() As Task(Of String)
Public Function SendSamplingRequest(cancellationToken As CancellationToken) As Task(Of String)

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

StartListening Method (MCPServer Component)

Instructs the component to start listening for incoming connections.

Syntax

C#
VB.NET

public void StartListening();

Async Version
public async Task StartListening();
public async Task StartListening(CancellationToken cancellationToken);

Public Sub StartListening()

Async Version
Public Sub StartListening() As Task
Public Sub StartListening(cancellationToken As CancellationToken) As Task

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 component to start listening for incoming connections on the port specified by LocalPort.

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

StopListening Method (MCPServer Component)

Instructs the component to stop listening for new connections.

Syntax

C#
VB.NET

public void StopListening();

Async Version
public async Task StopListening();
public async Task StopListening(CancellationToken cancellationToken);

Public Sub StopListening()

Async Version
Public Sub StopListening() As Task
Public Sub StopListening(cancellationToken As CancellationToken) As Task

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 component 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 (MCPServer Component)

Unregisters an existing prompt.

Syntax

C#
VB.NET

public void UnregisterPrompt(string name);

Async Version
public async Task UnregisterPrompt(string name);
public async Task UnregisterPrompt(string name, CancellationToken cancellationToken);

Public Sub UnregisterPrompt(ByVal Name As String)

Async Version
Public Sub UnregisterPrompt(ByVal Name As String) As Task
Public Sub UnregisterPrompt(ByVal Name As String, cancellationToken As CancellationToken) As Task

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 collection 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 (MCPServer Component)

Unregisters an existing resource.

Syntax

C#
VB.NET

public void UnregisterResource(string uri);

Async Version
public async Task UnregisterResource(string uri);
public async Task UnregisterResource(string uri, CancellationToken cancellationToken);

Public Sub UnregisterResource(ByVal Uri As String)

Async Version
Public Sub UnregisterResource(ByVal Uri As String) As Task
Public Sub UnregisterResource(ByVal Uri As String, cancellationToken As CancellationToken) As Task

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 collection 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

UnregisterTool Method (MCPServer Component)

Unregisters an existing tool.

Syntax

C#
VB.NET

public void UnregisterTool(string name);

Async Version
public async Task UnregisterTool(string name);
public async Task UnregisterTool(string name, CancellationToken cancellationToken);

Public Sub UnregisterTool(ByVal Name As String)

Async Version
Public Sub UnregisterTool(ByVal Name As String) As Task
Public Sub UnregisterTool(ByVal Name As String, cancellationToken As CancellationToken) As Task

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

ConnectionRequest Event (MCPServer Component)

This event fires when a connection request comes from a remote host.

Syntax

C#
VB.NET

public event OnConnectionRequestHandler OnConnectionRequest;

public delegate void OnConnectionRequestHandler(object sender, MCPServerConnectionRequestEventArgs e);

public class MCPServerConnectionRequestEventArgs : EventArgs {
  public string Address { get; }
  public int Port { get; }
  public bool Accept { get; set; }
}

Public Event OnConnectionRequest As OnConnectionRequestHandler

Public Delegate Sub OnConnectionRequestHandler(sender As Object, e As MCPServerConnectionRequestEventArgs)

Public Class MCPServerConnectionRequestEventArgs Inherits EventArgs
  Public ReadOnly Property Address As String
  Public ReadOnly Property Port As Integer
  Public Property Accept As Boolean
End Class

Remarks

This event indicates an incoming connection. The connection is accepted by default. Address and Port will contain information about the remote host requesting the inbound connection. If you want to refuse it, you can set the Accept parameter to False.

Error Event (MCPServer Component)

Fires when an error occurs during operation.

Syntax

C#
VB.NET

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, MCPServerErrorEventArgs e);

public class MCPServerErrorEventArgs : EventArgs {
  public string ConnectionId { get; }
  public int ErrorCode { get; }
  public string Description { get; }
}

Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As MCPServerErrorEventArgs)

Public Class MCPServerErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As String
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

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

ConnectionId identifies the connection associated with the error.

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

Description contains a textual description of the error that occurred.

Log Event (MCPServer Component)

Fires once for each log message.

Syntax

C#
VB.NET

public event OnLogHandler OnLog;

public delegate void OnLogHandler(object sender, MCPServerLogEventArgs e);

public class MCPServerLogEventArgs : EventArgs {
  public int LogLevel { get; }
  public string Message { get; }
  public string LogType { get; }
}

Public Event OnLog As OnLogHandler

Public Delegate Sub OnLogHandler(sender As Object, e As MCPServerLogEventArgs)

Public Class MCPServerLogEventArgs Inherits EventArgs
  Public ReadOnly Property LogLevel As Integer
  Public ReadOnly Property Message As String
  Public ReadOnly Property LogType As String
End Class

Remarks

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

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


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

Fires when a prompt is requested by the client.

Syntax

C#
VB.NET

public event OnPromptRequestHandler OnPromptRequest;

public delegate void OnPromptRequestHandler(object sender, MCPServerPromptRequestEventArgs e);

public class MCPServerPromptRequestEventArgs : EventArgs {
  public string Name { get; }
  public string Description { get; }
}

Public Event OnPromptRequest As OnPromptRequestHandler

Public Delegate Sub OnPromptRequestHandler(sender As Object, e As MCPServerPromptRequestEventArgs)

Public Class MCPServerPromptRequestEventArgs Inherits EventArgs
  Public ReadOnly Property Name As String
  Public ReadOnly Property Description As String
End Class

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

Fires when a resource is requested by the client.

Syntax

C#
VB.NET

public event OnResourceRequestHandler OnResourceRequest;

public delegate void OnResourceRequestHandler(object sender, MCPServerResourceRequestEventArgs e);

public class MCPServerResourceRequestEventArgs : EventArgs {
  public string Uri { get; }
}

Public Event OnResourceRequest As OnResourceRequestHandler

Public Delegate Sub OnResourceRequestHandler(sender As Object, e As MCPServerResourceRequestEventArgs)

Public Class MCPServerResourceRequestEventArgs Inherits EventArgs
  Public ReadOnly Property Uri As String
End Class

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

Fires when the component ends a session.

Syntax

C#
VB.NET

public event OnSessionEndHandler OnSessionEnd;

public delegate void OnSessionEndHandler(object sender, MCPServerSessionEndEventArgs e);

public class MCPServerSessionEndEventArgs : EventArgs {
  public string SessionId { get; }
}

Public Event OnSessionEnd As OnSessionEndHandler

Public Delegate Sub OnSessionEndHandler(sender As Object, e As MCPServerSessionEndEventArgs)

Public Class MCPServerSessionEndEventArgs Inherits EventArgs
  Public ReadOnly Property SessionId As String
End Class

Remarks

When the Transport property is set to ttHTTP, this event fires when the component ends a previously started session. The component 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 Component)

Fires when the component starts a session.

Syntax

C#
VB.NET

public event OnSessionStartHandler OnSessionStart;

public delegate void OnSessionStartHandler(object sender, MCPServerSessionStartEventArgs e);

public class MCPServerSessionStartEventArgs : EventArgs {
  public string SessionId { get; }
  public int ResultCode { get; set; }
}

Public Event OnSessionStart As OnSessionStartHandler

Public Delegate Sub OnSessionStartHandler(sender As Object, e As MCPServerSessionStartEventArgs)

Public Class MCPServerSessionStartEventArgs Inherits EventArgs
  Public ReadOnly Property SessionId As String
  Public Property ResultCode As Integer
End Class

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

Fires when a tool is requested by the client.

Syntax

C#
VB.NET

public event OnToolRequestHandler OnToolRequest;

public delegate void OnToolRequestHandler(object sender, MCPServerToolRequestEventArgs e);

public class MCPServerToolRequestEventArgs : EventArgs {
  public string ConnectionId { get; }
  public string Name { get; }
  public string Description { get; }
  public bool IsError { get; set; }
}

Public Event OnToolRequest As OnToolRequestHandler

Public Delegate Sub OnToolRequestHandler(sender As Object, e As MCPServerToolRequestEventArgs)

Public Class MCPServerToolRequestEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As String
  Public ReadOnly Property Name As String
  Public ReadOnly Property Description As String
  Public Property IsError As Boolean
End Class

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.

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
string (read-only)
Default: ""

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
string (read-only)
Default: ""

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
string (read-only)
Default: ""

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

Fingerprint
string (read-only)
Default: ""

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
string (read-only)
Default: ""

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
string (read-only)
Default: ""

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
string (read-only)
Default: ""

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

PrivateKey
string (read-only)
Default: ""

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
bool (read-only)
Default: 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
string (read-only)
Default: ""

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

PublicKey
string (read-only)
Default: ""

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

PublicKeyAlgorithm
string (read-only)
Default: ""

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

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

SerialNumber
string (read-only)
Default: ""

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
string (read-only)
Default: ""

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
string
Default: "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).

StoreB
byte []
Default: "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.

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.

StorePassword
string
Default: ""

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

StoreType
CertStoreTypes
Default: 0

The type of certificate store for this certificate.

The component supports both public and private keys in a variety of formats. When the cstAuto value is used, the component 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 component. 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
string (read-only)
Default: ""

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

ThumbprintMD5
string (read-only)
Default: ""

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
string (read-only)
Default: ""

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
string (read-only)
Default: ""

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
string (read-only)
Default: ""

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: 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
string (read-only)
Default: ""

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

Subject
string
Default: ""

The subject of the certificate used for client authentication.

This field will be populated with the full subject of the loaded certificate. When loading a certificate, the subject is used to locate the certificate in the store.

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
string
Default: ""

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.

EncodedB
byte []
Default: ""

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.

Constructors

C#
VB.NET

public Certificate();

Public Certificate()

Creates a instance whose properties can be set.

C#
VB.NET

public Certificate(string certificateFile);

Public Certificate(ByVal CertificateFile As String)

Opens CertificateFile and reads out the contents as an X.509 public key.

C#
VB.NET

public Certificate(byte[] encoded);

Public Certificate(ByVal Encoded As Byte())

Parses Encoded as an X.509 public key.

C#
VB.NET

public Certificate(CertStoreTypes storeType, string store, string storePassword, string subject);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String)

StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a file containing the certificate store. 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.

C#
VB.NET

public Certificate(CertStoreTypes storeType, string store, string storePassword, string subject, string configurationString);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

ConfigurationString is a newline-separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CryptoAPI option. The default value is True (the key is persisted). "Thumbprint" - an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to the cstUser , cstMachine , cstPublicKeyFile , and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations.

C#
VB.NET

public Certificate(CertStoreTypes storeType, string store, string storePassword, byte[] encoded);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Encoded As Byte())

After the store has been successfully opened, the component will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.

C#
VB.NET

public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, string subject);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Subject As String)

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.

C#
VB.NET

public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, string subject, string configurationString);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

C#
VB.NET

public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, byte[] encoded);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Encoded As Byte())

After the store has been successfully opened, the component will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.

Prompt Type

A registered prompt.

Remarks

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

The following fields are available:

Description
Name

Fields

Description
string
Default: ""

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
string
Default: ""

The unique name associated with the prompt.

This field identifies the unique name associated with the prompt.

Constructors

C#
VB.NET

public Prompt();

Public Prompt()

PromptArg Type

A prompt argument to be registered.

Remarks

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

The following fields are available:

Description
Name
Required

Fields

Description
string
Default: ""

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
string
Default: ""

The unique name associated with the prompt argument.

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

Required
bool
Default: 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

C#
VB.NET

public PromptArg();

Public PromptArg()

Resource Type

A registered resource.

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
string
Default: ""

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
string
Default: ""

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
string
Default: ""

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

The size of the resource content, in bytes.

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

Uri
string
Default: ""

The unique resource identifier associated with the resource.

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

Constructors

C#
VB.NET

public Resource();

Public Resource()

SamplingMessage Type

An individual message in a sampling request.

Remarks

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

The following fields are available:

Role
Text

Fields

Role
TRoles (read-only)
Default: 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
string
Default: ""

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

C#
VB.NET

public SamplingMessage();

Public SamplingMessage()

ServerSettings Type

The embedded HTTP server settings used by the component.

Remarks

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

The following fields are available:

AllowedAuthMethods
LocalHost
LocalPort
Timeout

Fields

AllowedAuthMethods
string
Default: "Anonymous,Basic,Digest,NTLM,Negotiate"

Specifies the authentication schemes that the component 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
string
Default: ""

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 component initiate connections (or accept in the case of server components) 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 component 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: 0

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

This field must be set before the component 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 components cannot be listening on the same port at the same time.

Timeout
int
Default: 60

Specifies the timeout in seconds for the component.

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

If this is set to a positive value, the component will wait for the operation to complete before returning control.

If the timeout expires, and the operation is not yet complete, the component 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

C#
VB.NET

public ServerSettings();

Public ServerSettings()

Creates an empty settings instance whose properties can be set.

Tool Type

A registered tool.

Remarks

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

The following fields are available:

Description
Name

Fields

Description
string
Default: ""

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
string
Default: ""

The unique name associated with the tool.

This field identifies the unique name associated with the tool.

Constructors

C#
VB.NET

public Tool();

Public Tool()

ToolParam Type

A tool parameter to be registered.

Remarks

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

The following fields are available:

ParamType
Value

Fields

ParamType
ToolParameterTypes
Default: 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
string
Default: ""

The value associated with the tool parameter.

This field contains the value associated with the tool parameter.

Constructors

C#
VB.NET

public ToolParam();

Public ToolParam()

Config Settings (MCPServer Component)

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

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.

HTTP Config Settings

AcceptEncoding: Used to tell the server which types of content encodings the client supports.

When AllowHTTPCompression is True, the component adds an Accept-Encoding header to the request being sent to the server. By default, this header's value is "gzip, deflate". This configuration setting allows you to change the value of the Accept-Encoding header. NOTE: The component only supports gzip and deflate decompression algorithms.

AllowHTTPCompression: This property enables HTTP compression for receiving data.

This configuration setting enables HTTP compression for receiving data. When set to True (default), the component will accept compressed data. It then will uncompress the data it has received. The component will handle data compressed by both gzip and deflate compression algorithms.

When True, the component adds an Accept-Encoding header to the outgoing request. The value for this header can be controlled by the AcceptEncoding configuration setting. The default value for this header is "gzip, deflate".

The default value is True.

AllowHTTPFallback: Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.

This configuration setting controls whether HTTP/2 connections are permitted to fall back to HTTP/1.1 when the server does not support HTTP/2. This setting is applicable only when HTTPVersion is set to "2.0".

If set to True (default), the component will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the component throws an exception if the server does not support HTTP/2.

The default value is True.

AllowNTLMFallback: Whether to allow fallback from Negotiate to NTLM when authenticating.

This configuration setting applies only when AuthScheme is set to Negotiate. If set to True, the component will automatically use New Technology LAN Manager (NTLM) if the server does not support Negotiate authentication. NOTE: The server must indicate that it supports NTLM authentication through the WWW-Authenticate header for the fallback from Negotiate to NTLM to take place. The default value is False.

Append: Whether to append data to LocalFile.

This configuration setting determines whether data will be appended when writing to LocalFile. When set to True, downloaded data will be appended to LocalFile. This may be used in conjunction with Range to resume a failed download. This is applicable only when LocalFile is set. The default value is False.

Authorization: The Authorization string to be sent to the server.

If the Authorization property contains a nonempty string, an Authorization HTTP request header is added to the request. This header conveys Authorization information to the server.

This property is provided so that the HTTP component can be extended with other security schemes in addition to the authorization schemes already implemented by the component.

The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

BytesTransferred: Contains the number of bytes transferred in the response data.

This configuration setting returns the raw number of bytes from the HTTP response data, before the component processes the data, whether it is chunked or compressed. This returns the same value as the Transfer event, by BytesTransferred.

ChunkSize: Specifies the chunk size in bytes when using chunked encoding.

This is applicable only when UseChunkedEncoding is True. This setting specifies the chunk size in bytes to be used when posting data. The default value is 16384.

CompressHTTPRequest: Set to true to compress the body of a PUT or POST request.

If set to True, the body of a PUT or POST request will be compressed into gzip format before sending the request. The "Content-Encoding" header is also added to the outgoing request.

The default value is False.

EncodeURL: If set to True the URL will be encoded by the component.

If set to True, the URL passed to the component will be URL encoded. The default value is False.

FollowRedirects: Determines what happens when the server issues a redirect.

This option determines what happens when the server issues a redirect. Normally, the component returns an error if the server responds with an "Object Moved" message. If this property is set to 1 (always), the new URL for the object is retrieved automatically every time.

If this property is set to 2 (Same Scheme), the new URL is retrieved automatically only if the URL Scheme is the same; otherwise, the component throws an exception.

Note: Following the HTTP specification, unless this option is set to 1 (Always), automatic redirects will be performed only for GET or HEAD requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities.

Furthermore, if either the new URL server or port are different from the existing one, User and Password are also reset to empty, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server.

A Redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the Redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters).

The default value is 0 (Never). In this case, redirects are never followed, and the component throws an exception instead.

Following are the valid options:

0 - Never
1 - Always
2 - Same Scheme

GetOn302Redirect: If set to True the component will perform a GET on the new location.

The default value is False. If set to True, the component will perform a GET on the new location. Otherwise, it will use the same HTTP method again.

HTTP2HeadersWithoutIndexing: HTTP2 headers that should not update the dynamic header table with incremental indexing.

HTTP/2 servers maintain a dynamic table of headers and values seen over the course of a connection. Typically, these headers are inserted into the table through incremental indexing (also known as HPACK, defined in RFC 7541). To tell the component not to use incremental indexing for certain headers, and thus not update the dynamic table, set this configuration option to a comma-delimited list of the header names.

HTTPVersion: The version of HTTP used by the component.

This property specifies the HTTP version used by the component. Possible values are as follows:

"1.0"
"1.1" (default)
"2.0"
"3.0"

When using HTTP/2 ("2.0") or HTTP/3 ("3.0"), additional restrictions apply. Please see the following notes for details.

HTTP/2 Notes

When using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error.

If the server does not support HTTP/2, the component will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check NegotiatedHTTPVersion after calling a method. The AllowHTTPFallback setting controls whether this behavior is allowed (default) or disallowed.

HTTP/2 is supported on all versions of Windows. If the Windows version is an earlier version than Windows 8.1/Windows Server 2012 R2, the internal security implementation will be used. If the Windows version is Window 8.1/Windows Server 2012 R2 or later, the system security libraries will be used by default.

HTTP/3 Notes

HTTP/3 is supported only in .NET and Java.

When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error.

IfModifiedSince: A date determining the maximum age of the desired document.

If this setting contains a nonempty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: if the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the component throws an exception

The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example: Sat, 29 Oct 2017 19:43:31 GMT.

KeepAlive: Determines whether the HTTP connection is closed after completion of the request.

If true, the component will not send the Connection: Close header. The absence of the Connection header indicates to the server that HTTP persistent connections should be used if supported. NOTE: Not all servers support persistent connections. If false, the connection will be closed immediately after the server response is received.

The default value for KeepAlive is false.

KerberosSPN: The Service Principal Name for the Kerberos Domain Controller.

If the Service Principal Name on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, the Service Principal Name should be set here.

LogLevel: The level of detail that is logged.

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


0 (None)	No events are logged.
1 (Info - default)	Informational events are logged.
2 (Verbose)	Detailed data are logged.
3 (Debug)	Debug data are logged.

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

MaxHeaders: Instructs component to save the amount of headers specified that are returned by the server after a Header event has been fired.

This configuration setting should be set when the TransferredHeaders collection is to be populated when a Header event has been fired. This value represents the number of headers that are to be saved in the collection.

To save all items to the collection, set this configuration setting to -1. If no items are wanted, set this to 0, which will not save any items to the collection. The default for this configuration setting is -1, so all items will be included in the collection.

MaxHTTPCookies: Instructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired.

This configuration setting should be set when populating the Cookies collection as a result of an HTTP request. This value represents the number of cookies that are to be saved in the collection.

MaxRedirectAttempts: Limits the number of redirects that are followed in a request.

When FollowRedirects is set to any value other than frNever, the component will follow redirects until this maximum number of redirect attempts are made. The default value is 20.

NegotiatedHTTPVersion: The negotiated HTTP version.

This configuration setting may be queried after the request is complete to indicate the HTTP version used. When HTTPVersion is set to "2.0" (if the server does not support "2.0"), then the component will fall back to using "1.1" automatically. This setting will indicate which version was used.

OtherHeaders: Other headers as determined by the user (optional).

This configuration setting can be set to a string of headers to be appended to the HTTP request headers.

The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .

Use this configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail.

This configuration setting is useful for extending the functionality of the component beyond what is provided.

ProxyAuthorization: The authorization string to be sent to the proxy server.

This is similar to the Authorization configuration setting, but is used for proxy authorization. If this configuration setting contains a nonempty string, a Proxy-Authorization HTTP request header is added to the request. This header conveys proxy Authorization information to the server. If User and Password are specified, this value is calculated using the algorithm specified by AuthScheme.

ProxyAuthScheme: The authorization scheme to be used for the proxy.

This configuration setting is provided for use by components that do not directly expose Proxy properties.

ProxyPassword: A password if authentication is to be used for the proxy.

This configuration setting is provided for use by components that do not directly expose Proxy properties.

ProxyPort: Port for the proxy server (default 80).

This configuration setting is provided for use by components that do not directly expose Proxy properties.

ProxyServer: Name or IP address of a proxy server (optional).

This configuration setting is provided for use by components that do not directly expose Proxy properties.

ProxyUser: A user name if authentication is to be used for the proxy.

This configuration setting is provided for use by components that do not directly expose Proxy properties.

SentHeaders: The full set of headers as sent by the client.

This configuration setting returns the complete set of raw headers as sent by the client.

StatusCode: The status code of the last response from the server.

This configuration setting contains the result code of the last response from the server.

StatusLine: The first line of the last response from the server.

This setting contains the first line of the last response from the server. The format of the line will be [HTTP version] [Result Code] [Description].

TransferredData: The contents of the last response from the server.

This configuration setting contains the contents of the last response from the server.

TransferredDataLimit: The maximum number of incoming bytes to be stored by the component.

If TransferredDataLimit is set to 0 (default), no limits are imposed. Otherwise, this reflects the maximum number of incoming bytes that can be stored by the component.

TransferredHeaders: The full set of headers as received from the server.

This configuration setting returns the complete set of raw headers as received from the server.

TransferredRequest: The full request as sent by the client.

This configuration setting returns the full request as sent by the client. For performance reasons, the request is not normally saved. Set this configuration setting to ON before making a request to enable it. Following are examples of this request:

.NET Http http = new Http(); http.Config("TransferredRequest=on"); http.PostData = "body"; http.Post("http://someserver.com"); Console.WriteLine(http.Config("TransferredRequest")); C++ HTTP http; http.Config("TransferredRequest=on"); http.SetPostData("body", 5); http.Post("http://someserver.com"); printf("%s\r\n", http.Config("TransferredRequest"));

UseChunkedEncoding: Enables or Disables HTTP chunked encoding for transfers.

If UseChunkedEncoding is set to True, the component will use HTTP-chunked encoding when posting, if possible. HTTP-chunked encoding allows large files to be sent in chunks instead of all at once. If set to False, the component will not use HTTP-chunked encoding. The default value is False.

NOTE: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.

UseIDNs: Whether to encode hostnames to internationalized domain names.

This configuration setting specifies whether hostnames containing non-ASCII characters are encoded to internationalized domain names. When set to True, if a hostname contains non-ASCII characters, it is encoded using Punycode to an IDN (internationalized domain name).

The default value is False and the hostname will always be used exactly as specified.

UsePlatformDeflate: Whether to use the platform implementation to decompress compressed responses.

This configuration setting specifies whether the platform's deflate-algorithm implementation is used to decompress responses that use compression. If set to True (default), the platform implementation is used. If set to False, an internal implementation is used.

UsePlatformHTTPClient: Whether or not to use the platform HTTP client.

When using this configuration setting, if True, the component will use the default HTTP client for the platform (URLConnection in Java, WebRequest in .NET, or CFHTTPMessage in Mac/iOS) instead of the internal HTTP implementation. This is important for environments in which direct access to sockets is limited or not allowed (e.g., in the Google AppEngine).

UseProxyAutoConfigURL: Whether to use a Proxy auto-config file when attempting a connection.

This configuration specifies whether the component will attempt to use the Proxy auto-config URL when establishing a connection and AutoDetect is set to True.

When True (default), the component will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use.

UserAgent: Information about the user agent (browser).

This is the value supplied in the HTTP User-Agent header. The default setting is "IPWorks HTTP Component - www.nsoftware.com".

Override the default with the name and version of your software.

TCPClient Config Settings

CloseStreamAfterTransfer: If true, the component will close the upload or download stream after the transfer.

This configuration setting determines whether the input or output stream is closed after the transfer completes. When set to True (default), all streams will be closed after a transfer is completed. To keep streams open after the transfer of data, set this to False. The default value is True.

ConnectionTimeout: Sets a separate timeout value for establishing a connection.

When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the component will use Timeout for establishing a connection and transmitting/receiving data.

FirewallAutoDetect: Tells the component whether or not to automatically detect and use firewall system settings, if available.

This configuration setting is provided for use by components that do not directly expose Firewall properties.

FirewallHost: Name or IP address of firewall (optional).

If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.

If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.

NOTE: This setting is provided for use by components that do not directly expose Firewall properties.

FirewallListener: If true, the component binds to a SOCKS firewall as a server (TCPClient only).

This entry is for TCPClient only and does not work for other components that descend from TCPClient.

If this entry is set, the component acts as a server. RemoteHost and RemotePort are used to tell the SOCKS firewall in which address and port to listen to. The firewall rules may ignore RemoteHost, and it is recommended that RemoteHost be set to empty string in this case.

RemotePort is the port in which the firewall will listen to. If set to 0, the firewall will select a random port. The binding (address and port) is provided through the ConnectionStatus event.

The connection to the firewall is made by calling the Connect method.

FirewallPassword: Password to be used if authentication is to be used when connecting through the firewall.

If FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the given firewall. If the authentication fails, the component throws an exception.

NOTE: This setting is provided for use by components that do not directly expose Firewall properties.

FirewallPort: The TCP port for the FirewallHost;.

The FirewallPort is set automatically when FirewallType is set to a valid value.

NOTE: This configuration setting is provided for use by components that do not directly expose Firewall properties.

FirewallType: Determines the type of firewall to connect through.

Possible values are as follows:


0	No firewall (default setting).
1	Connect through a tunneling proxy. FirewallPort is set to 80.
2	Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
3	Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.
10	Connect through a SOCKS4A Proxy. FirewallPort is set to 1080.

NOTE: This setting is provided for use by components that do not directly expose Firewall properties.

FirewallUser: A user name if authentication is to be used connecting through a firewall.

If the FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the Firewall. If the authentication fails, the component throws an exception.

NOTE: This setting is provided for use by components that do not directly expose Firewall properties.

KeepAliveInterval: The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.

When set, TCPKeepAlive will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by KeepAliveTime. If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second.

NOTE: This value is not applicable in macOS.

KeepAliveTime: The inactivity time in milliseconds before a TCP keep-alive packet is sent.

When set, TCPKeepAlive will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds.

Linger: When set to True, connections are terminated gracefully.

This property controls how a connection is closed. The default is True.

In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.

In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.

The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the component returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).

Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.

LingerTime: Time in seconds to have the connection linger.

LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout.

LocalHost: The name of the local host through which connections are initiated or accepted.

The LocalHost setting 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 value of an interface will make the component initiate connections (or accept in the case of server components) only through that interface.

If the component is connected, the LocalHost setting 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).

LocalPort: The port in the local host where the component binds.

This configuration setting must be set before a connection is attempted. It instructs the component to bind to a specific port (or communication endpoint) in the local machine.

Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.

LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.

This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems.

MaxLineLength: The maximum amount of data to accumulate when no EOL is found.

MaxLineLength is the size of an internal buffer, which holds received data while waiting for an EOL string.

If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn event is fired with the EOL parameter set to True, and the buffer is reset.

If no EOL is found, and MaxLineLength bytes are accumulated in the buffer, the DataIn event is fired with the EOL parameter set to False, and the buffer is reset.

The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.

MaxTransferRate: The transfer rate limit in bytes per second.

This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit.

ProxyExceptionsList: A semicolon separated list of hosts and IPs to bypass when using a proxy.

This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance:

www.google.com;www.example.com

TCPKeepAlive: Determines whether or not the keep alive socket option is enabled.

If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set KeepAliveTime and KeepAliveInterval to configure the timing of the keep-alive packets.

NOTE: This value is not applicable in Java.

TcpNoDelay: Whether or not to delay when sending packets.

When set to True, the socket will send all data that are ready to send at once. When set to False, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this configuration setting is set to False.

UseIPv6: Whether to use IPv6.

When set to 0 (default), the component will use IPv4 exclusively. When set to 1, the component will use IPv6 exclusively. To instruct the component to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to 2. The default value is 0. Possible values are as follows:


0	IPv4 only
1	IPv6 only
2	IPv6 with IPv4 fallback

UseNTLMv2: Whether to use NTLM V2.

When authenticating with NTLM, this setting specifies whether NTLM V2 is used. By default this value is True and NTLM V2 will be used. Set this to False to use NTLM V1.

SSL Config Settings

CACertFilePaths: The paths to CA certificate files when using Mono on Unix/Linux.

This configuration setting specifies the paths on disk to certificate authority (CA) certificate files when using Mono on Unix/Linux. It is not applicable in any other circumstances.

The value is formatted as a list of paths separated by semicolons. The component will check for the existence of each file in the order specified. When a file is found, the CA certificates within the file will be loaded and used to determine the validity of server or client certificates.

The default value is as follows:

/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem

LogSSLPackets: Controls whether SSL packets are logged when using the internal security API.

When SSLProvider is set to Internal, this configuration setting controls whether Secure Sockets Layer (SSL) packets should be logged. By default, this configuration setting is False, as it is useful only for debugging purposes.

When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received.

Enabling this configuration setting has no effect if SSLProvider is set to Platform.

ReuseSSLSession: Determines if the SSL session is reused.

If set to True, the component will reuse the context if and only if the following criteria are met:

The target host name is the same.
The system cache entry has not expired (default timeout is 10 hours).
The application process that calls the function is the same.
The logon session is the same.
The instance of the component is the same.

SSLCACerts: A newline separated list of CA certificates to be included when performing an SSL handshake.

When SSLProvider is set to Internal, this configuration setting specifies one or more CA certificates to be included with the SSLCert property. Some servers or clients require the entire chain, including CA certificates, to be presented when performing SSL authentication. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

SSLCheckCRL: Whether to check the Certificate Revocation List for the server certificate.

This configuration setting specifies whether the component will check the Certificate Revocation List (CRL) specified by the server certificate. If set to 1 or 2, the component will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The component will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the component throws an exception.

When set to 0 (default), the CRL check will not be performed by the component. When set to 1, it will attempt to perform the CRL check, but it will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported.

This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.

SSLCheckOCSP: Whether to use OCSP to check the status of the server certificate.

This configuration setting specifies whether the component will use OCSP to check the validity of the server certificate. If set to 1 or 2, the component will first obtain the Online Certificate Status Protocol (OCSP) URL from the server certificate's OCSP extension. The component will then locate the issuing certificate and make an HTTP request to the OCSP endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation, the component throws an exception.

When set to 0 (default), the component will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but it will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported.

This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.

SSLCipherStrength: The minimum cipher strength used for bulk encryption.

This minimum cipher strength is largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated.

NOTE: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the SSLStatus event.

Use this configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.

When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList configuration setting.

SSLClientCACerts: A newline separated list of CA certificates to use during SSL client certificate validation.

This configuration setting is only applicable to server components (e.g., TCPServer) see SSLServerCACerts for client components (e.g., TCPClient). This setting can be used to optionally specify one or more CA certificates to be used when verifying the client certificate that is presented by the client during the SSL handshake when SSLAuthenticateClients is enabled. When verifying the client's certificate, the certificates trusted by the system will be used as part of the verification process. If the client's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the client's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

SSLEnabledCipherSuites: The cipher suite to be used in an SSL negotiation.

This configuration setting enables the cipher suites to be used in SSL negotiation.

By default, the enabled cipher suites will include all available ciphers ("*").

The special value "*" means that the component will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.

Multiple cipher suites are separated by semicolons.

Example values when SSLProvider is set to Platform include the following: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); Possible values when SSLProvider is set to Platform include the following:

CALG_3DES
CALG_3DES_112
CALG_AES
CALG_AES_128
CALG_AES_192
CALG_AES_256
CALG_AGREEDKEY_ANY
CALG_CYLINK_MEK
CALG_DES
CALG_DESX
CALG_DH_EPHEM
CALG_DH_SF
CALG_DSS_SIGN
CALG_ECDH
CALG_ECDH_EPHEM
CALG_ECDSA
CALG_ECMQV
CALG_HASH_REPLACE_OWF
CALG_HUGHES_MD5
CALG_HMAC
CALG_KEA_KEYX
CALG_MAC
CALG_MD2
CALG_MD4
CALG_MD5
CALG_NO_SIGN
CALG_OID_INFO_CNG_ONLY
CALG_OID_INFO_PARAMETERS
CALG_PCT1_MASTER
CALG_RC2
CALG_RC4
CALG_RC5
CALG_RSA_KEYX
CALG_RSA_SIGN
CALG_SCHANNEL_ENC_KEY
CALG_SCHANNEL_MAC_KEY
CALG_SCHANNEL_MASTER_HASH
CALG_SEAL
CALG_SHA
CALG_SHA1
CALG_SHA_256
CALG_SHA_384
CALG_SHA_512
CALG_SKIPJACK
CALG_SSL2_MASTER
CALG_SSL3_MASTER
CALG_SSL3_SHAMD5
CALG_TEK
CALG_TLS1_MASTER
CALG_TLS1PRF

Example values when SSLProvider is set to Internalinclude the following:

obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_ECDH_RSA_WITH_AES_128_CBC_SHA");

Possible values when SSLProvider is set to Internal include the following:

TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
TLS_RSA_WITH_AES_256_GCM_SHA384
TLS_RSA_WITH_AES_128_GCM_SHA256
TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
TLS_RSA_WITH_AES_256_CBC_SHA256
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
TLS_RSA_WITH_AES_128_CBC_SHA256
TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
TLS_RSA_WITH_AES_256_CBC_SHA
TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
TLS_DHE_RSA_WITH_AES_256_CBC_SHA
TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
TLS_DHE_DSS_WITH_AES_256_CBC_SHA
TLS_RSA_WITH_AES_128_CBC_SHA
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
TLS_DHE_RSA_WITH_AES_128_CBC_SHA
TLS_DHE_DSS_WITH_AES_128_CBC_SHA
TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
TLS_RSA_WITH_3DES_EDE_CBC_SHA
TLS_RSA_WITH_DES_CBC_SHA
TLS_DHE_RSA_WITH_DES_CBC_SHA
TLS_DHE_DSS_WITH_DES_CBC_SHA
TLS_RSA_WITH_RC4_128_MD5
TLS_RSA_WITH_RC4_128_SHA

When TLS 1.3 is negotiated (see SSLEnabledProtocols), only the following cipher suites are supported:

TLS_AES_256_GCM_SHA384
TLS_CHACHA20_POLY1305_SHA256
TLS_AES_128_GCM_SHA256

SSLEnabledCipherSuites is used together with SSLCipherStrength.

SSLEnabledProtocols: Used to enable/disable the supported security protocols.

This configuration setting is used to enable or disable the supported security protocols.

Not all supported protocols are enabled by default. The default value is 4032 for client components, and 3072 for server components. To specify a combination of enabled protocol versions set this config to the binary OR of one or more of the following values:


TLS1.3	12288 (Hex 3000)
TLS1.2	3072 (Hex C00) (Default - Client and Server)
TLS1.1	768 (Hex 300) (Default - Client)
TLS1	192 (Hex C0) (Default - Client)
SSL3	48 (Hex 30)
SSL2	12 (Hex 0C)

Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases.

SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:

By default when TLS 1.3 is enabled, the component will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.

In editions that are designed to run on Windows, SSLProvider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is supported only on Windows 11/Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.

If set to 1 (Platform provider), please be aware of the following notes:

The platform provider is available only on Windows 11/Windows Server 2022 and up.
SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2, these restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.

SSLEnabledProtocols: SSL2 and SSL3 Notes:

SSL 2.0 and 3.0 are not supported by the component when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform.

SSLEnableRenegotiation: Whether the renegotiation_info SSL extension is supported.

This configuration setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This configuration setting is false by default, but it can be set to true to enable the extension.

This configuration setting is applicable only when SSLProvider is set to Internal.

SSLIncludeCertChain: Whether the entire certificate chain is included in the SSLServerAuthentication event.

This configuration setting specifies whether the Encoded parameter of the SSLServerAuthentication event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the SSLServerAuthentication event.

If set to True, all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.

Note: When SSLProvider is set to Internal this value is automatically set to true. This is needed for proper validation when using the internal provider.

SSLKeyLogFile: The location of a file where per-session secrets are written for debugging purposes.

This configuration setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes.

When set, the component will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools, such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffic for debugging purposes. When writing to this file, the component will only append, it will not overwrite previous values.

NOTE: This configuration setting is applicable only when SSLProvider is set to Internal.

SSLNegotiatedCipher: Returns the negotiated cipher suite.

This configuration setting returns the cipher suite negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipher[connId]");

SSLNegotiatedCipherStrength: Returns the negotiated cipher suite strength.

This configuration setting returns the strength of the cipher suite negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherStrength[connId]");

SSLNegotiatedCipherSuite: Returns the negotiated cipher suite.

This configuration setting returns the cipher suite negotiated during the SSL handshake represented as a single string.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherSuite[connId]");

SSLNegotiatedKeyExchange: Returns the negotiated key exchange algorithm.

This configuration setting returns the key exchange algorithm negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedKeyExchange[connId]");

SSLNegotiatedKeyExchangeStrength: Returns the negotiated key exchange algorithm strength.

This configuration setting returns the strength of the key exchange algorithm negotiated during the SSL handshake.

SSLNegotiatedVersion: Returns the negotiated protocol version.

This configuration setting returns the protocol version negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedVersion[connId]");

SSLSecurityFlags: Flags that control certificate verification.

The following flags are defined (specified in hexadecimal notation). They can be ORed together to exclude multiple conditions:


0x00000001	Ignore time validity status of certificate.
0x00000002	Ignore time validity status of CTL.
0x00000004	Ignore non-nested certificate times.
0x00000010	Allow unknown certificate authority.
0x00000020	Ignore wrong certificate usage.
0x00000100	Ignore unknown certificate revocation status.
0x00000200	Ignore unknown CTL signer revocation status.
0x00000400	Ignore unknown certificate authority revocation status.
0x00000800	Ignore unknown root revocation status.
0x00008000	Allow test root certificate.
0x00004000	Trust test root certificate.
0x80000000	Ignore non-matching CN (certificate CN non-matching server name).

This functionality is currently not available in Java or when the provider is OpenSSL.

SSLServerCACerts: A newline separated list of CA certificates to use during SSL server certificate validation.

This configuration setting is only used by client components (e.g., TCPClient) see SSLClientCACerts for server components (e.g., TCPServer). This configuration setting can be used to optionally specify one or more CA certificates to be used when connecting to the server and verifying the server certificate. When verifying the server's certificate, the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

TLS12SignatureAlgorithms: Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.

This configuration setting specifies the allowed server certificate signature algorithms when SSLProvider is set to Internal and SSLEnabledProtocols is set to allow TLS 1.2.

When specified the component will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the component throws an exception.

The format of this value is a comma-separated list of hash-signature combinations. For instance: component.SSLProvider = TCPClientSSLProviders.sslpInternal; component.Config("SSLEnabledProtocols=3072"); //TLS 1.2 component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); The default value for this configuration setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.

To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.

TLS12SupportedGroups: The supported groups for ECC.

This configuration setting specifies a comma-separated list of named groups used in TLS 1.2 for ECC.

The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.

When using TLS 1.2 and SSLProvider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:

"ecdhe_secp256r1" (default)
"ecdhe_secp384r1" (default)
"ecdhe_secp521r1" (default)

TLS13KeyShareGroups: The groups for which to pregenerate key shares.

This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional roundtrip during the handshake if the group is supported by the server.

The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result, only some groups are included by default in this configuration setting.

NOTE: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group.

In most cases, this configuration setting does not need to be modified. This should be modified only if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072

The values are ordered from most preferred to least preferred. The following values are supported:

"ecdhe_x25519" (default)
"ecdhe_x448"
"ecdhe_secp256r1" (default)
"ecdhe_secp384r1" (default)
"ecdhe_secp521r1"
"ffdhe_2048" (default)
"ffdhe_3072" (default)
"ffdhe_4096"
"ffdhe_6144"
"ffdhe_8192"

TLS13SignatureAlgorithms: The allowed certificate signature algorithms.

This configuration setting holds a comma-separated list of allowed signature algorithms. Possible values include the following:

"ed25519" (default)
"ed448" (default)
"ecdsa_secp256r1_sha256" (default)
"ecdsa_secp384r1_sha384" (default)
"ecdsa_secp521r1_sha512" (default)
"rsa_pkcs1_sha256" (default)
"rsa_pkcs1_sha384" (default)
"rsa_pkcs1_sha512" (default)
"rsa_pss_sha256" (default)
"rsa_pss_sha384" (default)
"rsa_pss_sha512" (default)

The default value is rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448. This configuration setting is applicable only when SSLEnabledProtocols includes TLS 1.3.

TLS13SupportedGroups: The supported groups for (EC)DHE key exchange.

This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. This configuration setting should be modified only if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192

The values are ordered from most preferred to least preferred. The following values are supported:

"ecdhe_x25519" (default)
"ecdhe_x448" (default)
"ecdhe_secp256r1" (default)
"ecdhe_secp384r1" (default)
"ecdhe_secp521r1" (default)
"ffdhe_2048" (default)
"ffdhe_3072" (default)
"ffdhe_4096" (default)
"ffdhe_6144" (default)
"ffdhe_8192" (default)

Socket Config Settings

AbsoluteTimeout: Determines whether timeouts are inactivity timeouts or absolute timeouts.

If AbsoluteTimeout is set to True, any method that does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.

NOTE: This option is not valid for User Datagram Protocol (UDP) ports.

FirewallData: Used to send extra data to the firewall.

When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g., headers for custom authentication schemes).

InBufferSize: The size in bytes of the incoming queue of the socket.

This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the InBufferSize setting can provide significant improvements in performance.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the component is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

OutBufferSize: The size in bytes of the outgoing queue of the socket.

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. In some cases, increasing the value of the OutBufferSize setting can provide significant improvements in performance.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the component is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

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.

GUIAvailable: Whether or not a message loop is available for processing events.

In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The component will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation.

In some non-GUI applications, an invalid message loop may be discovered that will result in errant behavior. In these cases, setting GUIAvailable to false will ensure that the component does not attempt to process external events.

LicenseInfo: Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a component 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.

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

When set to false, the component will use the system security libraries by default to perform cryptographic functions where applicable. In this case, calls to unmanaged code will be made. In certain environments, this is not desirable. To use a completely managed security implementation, set this setting to true.

Setting this configuration setting to true tells the component 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.

NOTE: This setting is static. The value set is applicable to all components used in the application.

When this value is set, the product's system dynamic link library (DLL) is no longer required as a reference, as all unmanaged code is stored in that file.

Trappable Errors (MCPServer Component)

MCPServer Errors

104	The component is already listening.