Updated doc in all tools
This commit is contained in:
parent
eed70bbbda
commit
7b8592538f
15 changed files with 15 additions and 15 deletions
|
|
@ -21,7 +21,7 @@ const config = {
|
|||
* The registered tool validates input arguments using the EchoSchema and
|
||||
* returns a response that echoes the message provided in the arguments.
|
||||
*
|
||||
* @param {McpServer} server - The server instance where the tool will be registered.
|
||||
* @param {McpServer} server - The McpServer instance where the tool will be registered.
|
||||
* @returns {void}
|
||||
*/
|
||||
export const registerEchoTool = (server: McpServer) => {
|
||||
|
|
|
|||
|
|
@ -33,7 +33,7 @@ const config = {
|
|||
* The response will have annotations and optionally contain an annotated image.
|
||||
*
|
||||
* @function
|
||||
* @param {McpServer} server - The MCP server instance where the tool is to be registered.
|
||||
* @param {McpServer} server - The McpServer instance where the tool will be registered.
|
||||
*/
|
||||
export const registerGetAnnotatedMessageTool = (server: McpServer) => {
|
||||
server.registerTool(name, config, async (args): Promise<CallToolResult> => {
|
||||
|
|
|
|||
|
|
@ -16,7 +16,7 @@ const config = {
|
|||
* The registered tool Retrieves and returns the environment variables
|
||||
* of the current process as a JSON-formatted string encapsulated in a text response.
|
||||
*
|
||||
* @param {McpServer} server - The MCP server instance where the tool is to be registered.
|
||||
* @param {McpServer} server - The McpServer instance where the tool will be registered.
|
||||
* @returns {void}
|
||||
*/
|
||||
export const registerGetEnvTool = (server: McpServer) => {
|
||||
|
|
|
|||
|
|
@ -36,7 +36,7 @@ const config = {
|
|||
|
||||
* The response contains a "text" introductory block and multiple "resource_link" blocks.
|
||||
*
|
||||
* @param {McpServer} server - An instance of the McpServer on which the tool will be registered.
|
||||
* @param {McpServer} server - The McpServer instance where the tool will be registered.
|
||||
*/
|
||||
export const registerGetResourceLinksTool = (server: McpServer) => {
|
||||
server.registerTool(name, config, async (args): Promise<CallToolResult> => {
|
||||
|
|
|
|||
|
|
@ -44,7 +44,7 @@ const config = {
|
|||
* 3. Constructs a URI for the resource based on its type (text or blob).
|
||||
* 4. Retrieves the resource and returns it in a content block.
|
||||
*
|
||||
* @param {McpServer} server - The server instance where the tool is registered.
|
||||
* @param {McpServer} server - The McpServer instance where the tool will be registered.
|
||||
*/
|
||||
export const registerGetResourceReferenceTool = (server: McpServer) => {
|
||||
server.registerTool(name, config, async (args): Promise<CallToolResult> => {
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@ const config = {
|
|||
* client. If for some reason the server never got the initial roots list, the tool will request the
|
||||
* list from the client again.
|
||||
*
|
||||
* @param {McpServer} server - The server instance interacting with the MCP client
|
||||
* @param {McpServer} server - The McpServer instance where the tool will be registered.
|
||||
*/
|
||||
export const registerGetRootsListTool = (server: McpServer) => {
|
||||
const clientSupportsRoots =
|
||||
|
|
|
|||
|
|
@ -41,7 +41,7 @@ const config = {
|
|||
* - `content`: An array of content blocks, presented as JSON stringified objects.
|
||||
* - `structuredContent`: A JSON structured representation of the weather data.
|
||||
*
|
||||
* @param {McpServer} server - The server instance to which the tool will be registered.
|
||||
* @param {McpServer} server - The McpServer instance where the tool will be registered.
|
||||
*/
|
||||
export const registerGetStructuredContentTool = (server: McpServer) => {
|
||||
server.registerTool(name, config, async (args): Promise<CallToolResult> => {
|
||||
|
|
|
|||
|
|
@ -27,7 +27,7 @@ const config = {
|
|||
*
|
||||
* The result is returned as a Promise resolving to an object containing the computed sum in a text format.
|
||||
*
|
||||
* @param {McpServer} server - The server instance where the sum tool will be registered.
|
||||
* @param {McpServer} server - The McpServer instance where the tool will be registered.
|
||||
*/
|
||||
export const registerGetSumTool = (server: McpServer) => {
|
||||
server.registerTool(name, config, async (args): Promise<CallToolResult> => {
|
||||
|
|
|
|||
|
|
@ -22,7 +22,7 @@ const config = {
|
|||
* The response structure includes textual content before and after the image.
|
||||
* The image is served as a PNG data type and represents the default MCP tiny image.
|
||||
*
|
||||
* @param server - An instance of McpServer where the tool will be registered.
|
||||
* @param server - The McpServer instance where the tool will be registered.
|
||||
*/
|
||||
export const registerGetTinyImageTool = (server: McpServer) => {
|
||||
server.registerTool(name, config, async (args): Promise<CallToolResult> => {
|
||||
|
|
|
|||
|
|
@ -62,7 +62,7 @@ const config = {
|
|||
*
|
||||
* If an unrecognized `outputType` is provided, the tool throws an error.
|
||||
*
|
||||
* @param {McpServer} server - The server instance where the tool will be registered.
|
||||
* @param {McpServer} server - The McpServer instance where the tool will be registered.
|
||||
* @throws {Error} Throws an error if an unknown output type is specified.
|
||||
*/
|
||||
export const registerGZipFileAsResourceTool = (server: McpServer) => {
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@ const clients: Set<string | undefined> = new Set<string | undefined>();
|
|||
* current state. If logging for the specified session is active, it will be stopped;
|
||||
* if it is inactive, logging will be started.
|
||||
*
|
||||
* @param {McpServer} server - The server instance to which the tool is registered.
|
||||
* @param {McpServer} server - The McpServer instance where the tool will be registered.
|
||||
*/
|
||||
export const registerToggleSimulatedLoggingTool = (server: McpServer) => {
|
||||
server.registerTool(
|
||||
|
|
|
|||
|
|
@ -29,7 +29,7 @@ const clients: Set<string | undefined> = new Set<string | undefined>();
|
|||
* The response provides feedback indicating whether simulated updates were started or stopped,
|
||||
* including the session ID.
|
||||
*
|
||||
* @param {McpServer} server - The MCP server instance on which the tool is registered.
|
||||
* @param {McpServer} server - The McpServer instance where the tool will be registered.
|
||||
*/
|
||||
export const registerToggleSubscriberUpdatesTool = (server: McpServer) => {
|
||||
server.registerTool(
|
||||
|
|
|
|||
|
|
@ -24,7 +24,7 @@ const config = {
|
|||
* which contains both user-submitted input data (if provided) and debugging information,
|
||||
* including raw results.
|
||||
*
|
||||
* @param {McpServer} server - The MCP server instance to which the tool will be registered.
|
||||
* @param {McpServer} server - TThe McpServer instance where the tool will be registered.
|
||||
*/
|
||||
export const registerTriggerElicitationRequestTool = (server: McpServer) => {
|
||||
server.registerTool(
|
||||
|
|
|
|||
|
|
@ -31,7 +31,7 @@ const config = {
|
|||
* 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 McpServer instance where the tool will be registered.
|
||||
*/
|
||||
export const registerTriggerLongRunningOperationTool = (server: McpServer) => {
|
||||
server.registerTool(
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@ const config = {
|
|||
* - Sends the request to the server for sampling.
|
||||
* - Formats and returns the sampling result content to the client.
|
||||
*
|
||||
* @param {McpServer} server - The instance of the MCP server where the tool will be registered.
|
||||
* @param {McpServer} server - The McpServer instance where the tool will be registered.
|
||||
*/
|
||||
export const registerTriggerSamplingRequestTool = (server: McpServer) => {
|
||||
server.registerTool(
|
||||
|
|
|
|||
Loading…
Reference in a new issue