Update doc in tools/trigger-elicitation-request.ts and trigger-long-running-operation.ts

This commit is contained in:
cliffhall 2025-12-13 15:16:37 -05:00
commit b8074f9b9c
2 changed files with 9 additions and 8 deletions

View file

@ -21,8 +21,8 @@ const config = {
* the elicitation input arguments at runtime. * the elicitation input arguments at runtime.
* *
* The elicitation dialog response is returned, formatted into a structured result, * The elicitation dialog response is returned, formatted into a structured result,
* which contains both user-submitted input data (if provided) and debugging * which contains both user-submitted input data (if provided) and debugging information,
* information, including raw results. * including raw results.
* *
* @param {McpServer} server - The MCP server instance to which the tool will be registered. * @param {McpServer} server - The MCP server instance to which the tool will be registered.
*/ */

View file

@ -22,13 +22,14 @@ const config = {
/** /**
* Registers the 'trigger-tong-running-operation' tool with the provided McpServer instance. * Registers the 'trigger-tong-running-operation' tool with the provided McpServer instance.
* *
* This function defines and registers a tool with the provided server instance that performs a * The registered tool starts a long-running operation defined by a specific duration and
* long-running operation defined by a specific duration and number of steps. The progress * number of steps.
* of the operation is reported back to the client through notifications.
* *
* Progress notifications are sent back to the client at each step, if a `progressToken` * Progress notifications are sent back to the client at each step if a `progressToken`
* is provided in the metadata. At the end of the operation, the tool returns a message * is provided in the metadata.
* indicating the completion of the operation, including the total duration and steps. *
* At the end of the operation, the tool returns a message indicating the completion of the
* operation, including the total duration and steps.
* *
* @param {McpServer} server - The server instance where the tool should be registered. * @param {McpServer} server - The server instance where the tool should be registered.
*/ */