Updated doc in all tools

This commit is contained in:
cliffhall
2025-12-13 15:55:07 -05:00
parent 7b8592538f
commit 20527e4175
15 changed files with 16 additions and 16 deletions

View File

@@ -16,7 +16,7 @@ const config = {
};
/**
* Registers the 'echo' Tool with the provided McpServer instance.
* Registers the 'echo' tool.
*
* The registered tool validates input arguments using the EchoSchema and
* returns a response that echoes the message provided in the arguments.

View File

@@ -24,7 +24,7 @@ const config = {
};
/**
* Registers the 'get-annotated-message' tool with the provided McpServer instance.
* Registers the 'get-annotated-message' tool.
*
* The registered tool generates and sends messages with specific types, such as error,
* success, or debug, carrying associated annotations like priority level and intended

View File

@@ -11,7 +11,7 @@ const config = {
};
/**
* Registers the 'get-env' tool with the given MCP server.
* Registers the 'get-env' tool.
*
* The registered tool Retrieves and returns the environment variables
* of the current process as a JSON-formatted string encapsulated in a text response.

View File

@@ -28,7 +28,7 @@ const config = {
};
/**
* Registers the 'get-resource-reference' tool with the provided McpServer instance.
* Registers the 'get-resource-reference' tool.
*
* The registered tool retrieves a specified number of resource links and their metadata.
* Resource links are dynamically generated as either text or binary blob resources,

View File

@@ -31,7 +31,7 @@ const config = {
};
/**
* Registers the 'get-resource-reference' tool with the provided McpServer instance.
* Registers the 'get-resource-reference' tool.
*
* The registered tool validates and processes arguments for retrieving a resource
* reference. Supported resource types include predefined `RESOURCE_TYPE_TEXT` and

View File

@@ -12,7 +12,7 @@ const config = {
};
/**
* Registers the 'get-roots-list' tool with the given MCP server.
* Registers the 'get-roots-list' tool.
*
* If the client does not support the roots capability, the tool is not registered.
*

View File

@@ -30,7 +30,7 @@ const config = {
};
/**
* Registers the 'get-structured-content' tool with the provided McpServer instance.
* Registers the 'get-structured-content' tool.
*
* The registered tool processes incoming arguments using a predefined input schema,
* generates structured content with weather information including temperature,

View File

@@ -17,7 +17,7 @@ const config = {
};
/**
* Registers the 'get-sum' tool with the provided McpServer instance.
* Registers the 'get-sum' tool.
**
* The registered tool processes input arguments, validates them using a predefined schema,
* calculates the sum of two numeric values, and returns the result in a content block.

View File

@@ -14,7 +14,7 @@ const config = {
};
/**
* Registers the "get-tiny-image" tool with the provided McpServer instance.
* Registers the "get-tiny-image" tool.
*
* The registered tool returns a response containing a small image alongside some
* descriptive text.

View File

@@ -51,7 +51,7 @@ const config = {
};
/**
* Registers the `gzip-file-as-resource` tool with the provided MCP server.
* Registers the `gzip-file-as-resource` tool.
*
* The registered tool compresses input data using gzip, and makes the resulting file accessible
* as a resource for the duration of the session.

View File

@@ -17,7 +17,7 @@ const config = {
const clients: Set<string | undefined> = new Set<string | undefined>();
/**
* Registers the `toggle-simulated-logging` tool with the provided MCP server.
* Registers the `toggle-simulated-logging` tool.
*
* The registered tool enables or disables the sending of periodic, random-leveled
* logging messages the connected client.

View File

@@ -17,7 +17,7 @@ const config = {
const clients: Set<string | undefined> = new Set<string | undefined>();
/**
* Registers the `toggle-subscriber-updates` tool with the provided MCP server.
* Registers the `toggle-subscriber-updates` tool.
*
* The registered tool enables or disables the sending of periodic, simulated resource
* update messages the connected client for any subscriptions they have made.

View File

@@ -11,7 +11,7 @@ const config = {
};
/**
* Registers the 'trigger-elicitation-request' tool within the provided McpServer instance.
* Registers the 'trigger-elicitation-request' tool.
*
* The registered tool sends an elicitation request for the user to provide information
* based on a pre-defined schema of fields including text inputs, booleans, numbers,

View File

@@ -20,7 +20,7 @@ const config = {
};
/**
* Registers the 'trigger-tong-running-operation' tool with the provided McpServer instance.
* Registers the 'trigger-tong-running-operation' tool.
*
* The registered tool starts a long-running operation defined by a specific duration and
* number of steps.

View File

@@ -24,10 +24,10 @@ const config = {
};
/**
* Registers the 'trigger-sampling-request' tool within the provided McpServer instance.
* Registers the 'trigger-sampling-request' tool.
*
* The registered tool performs the following operations:
* - Validates incoming arguments using `SampleLLMSchema`.
* - Validates incoming arguments using `TriggerSamplingRequestSchema`.
* - Constructs a `sampling/createMessage` request object using provided prompt and maximum tokens.
* - Sends the request to the server for sampling.
* - Formats and returns the sampling result content to the client.