Class SumUpAgentToolkit

Readonlyserver

close

• close(): Promise<void>

  Closes the connection.

  Returns Promise<void>

connect

• connect(transport: Transport): Promise<void>

  Attaches to the given transport, starts it, and starts listening for messages.

  The server object assumes ownership of the Transport, replacing any callbacks that have already been set, and expects that it is the only user of the Transport instance going forward.

  Parameters

  • transport: Transport

  Returns Promise<void>

isConnected

• isConnected(): boolean

  Checks if the server is connected to a transport.

  Returns boolean

  True if the server is connected

prompt

• prompt(
      name: string,
      cb: (
          extra: RequestHandlerExtra<ServerRequest, ServerNotification>,
      ) =>
          | {
              _meta?: { [key: string]: unknown };
              description?: string;
              messages: {
                  content:
                      | { text: string; type: "text"; [key: string]: unknown }
                      | {
                          data: string;
                          mimeType: string;
                          type: "image";
                          [key: string]: unknown;
                      }
                      | {
                          data: string;
                          mimeType: string;
                          type: "audio";
                          [key: string]: unknown;
                      }
                      | {
                          resource: | {
                              mimeType?: string;
                              text: string;
                              uri: string;
                              [key: string]: unknown;
                          }
                          | {
                              blob: string;
                              mimeType?: string;
                              uri: string;
                              [key: string]: unknown;
                          };
                          type: "resource";
                          [key: string]: unknown;
                      };
                  role: "user"
                  | "assistant";
                  [key: string]: unknown;
              }[];
              [key: string]: unknown;
          }
          | Promise<
              {
                  _meta?: { [key: string]: unknown };
                  description?: string;
                  messages: {
                      content:
                          | { text: string; type: "text"; [key: string]: unknown }
                          | {
                              data: string;
                              mimeType: string;
                              type: "image";
                              [key: string]: unknown;
                          }
                          | {
                              data: string;
                              mimeType: string;
                              type: "audio";
                              [key: string]: unknown;
                          }
                          | {
                              resource: | {
                                  mimeType?: (...)
                                  | (...);
                                  text: string;
                                  uri: string;
                                  [key: string]: unknown;
                              }
                              | {
                                  blob: string;
                                  mimeType?: (...)
                                  | (...);
                                  uri: string;
                                  [key: string]: unknown;
                              };
                              type: "resource";
                              [key: string]: unknown;
                          };
                      role: "user"
                      | "assistant";
                      [key: string]: unknown;
                  }[];
                  [key: string]: unknown;
              },
          >,
  ): RegisteredPrompt

  Registers a zero-argument prompt name, which will run the given function when the client calls it.

  Parameters

  • name: string
  • cb: (
        extra: RequestHandlerExtra<ServerRequest, ServerNotification>,
    ) =>
        | {
            _meta?: { [key: string]: unknown };
            description?: string;
            messages: {
                content:
                    | { text: string; type: "text"; [key: string]: unknown }
                    | {
                        data: string;
                        mimeType: string;
                        type: "image";
                        [key: string]: unknown;
                    }
                    | {
                        data: string;
                        mimeType: string;
                        type: "audio";
                        [key: string]: unknown;
                    }
                    | {
                        resource: | {
                            mimeType?: string;
                            text: string;
                            uri: string;
                            [key: string]: unknown;
                        }
                        | {
                            blob: string;
                            mimeType?: string;
                            uri: string;
                            [key: string]: unknown;
                        };
                        type: "resource";
                        [key: string]: unknown;
                    };
                role: "user"
                | "assistant";
                [key: string]: unknown;
            }[];
            [key: string]: unknown;
        }
        | Promise<
            {
                _meta?: { [key: string]: unknown };
                description?: string;
                messages: {
                    content:
                        | { text: string; type: "text"; [key: string]: unknown }
                        | {
                            data: string;
                            mimeType: string;
                            type: "image";
                            [key: string]: unknown;
                        }
                        | {
                            data: string;
                            mimeType: string;
                            type: "audio";
                            [key: string]: unknown;
                        }
                        | {
                            resource: | {
                                mimeType?: (...)
                                | (...);
                                text: string;
                                uri: string;
                                [key: string]: unknown;
                            }
                            | {
                                blob: string;
                                mimeType?: (...)
                                | (...);
                                uri: string;
                                [key: string]: unknown;
                            };
                            type: "resource";
                            [key: string]: unknown;
                        };
                    role: "user"
                    | "assistant";
                    [key: string]: unknown;
                }[];
                [key: string]: unknown;
            },
        >

  Returns RegisteredPrompt
• prompt(
      name: string,
      description: string,
      cb: (
          extra: RequestHandlerExtra<ServerRequest, ServerNotification>,
      ) =>
          | {
              _meta?: { [key: string]: unknown };
              description?: string;
              messages: {
                  content:
                      | { text: string; type: "text"; [key: string]: unknown }
                      | {
                          data: string;
                          mimeType: string;
                          type: "image";
                          [key: string]: unknown;
                      }
                      | {
                          data: string;
                          mimeType: string;
                          type: "audio";
                          [key: string]: unknown;
                      }
                      | {
                          resource: | {
                              mimeType?: string;
                              text: string;
                              uri: string;
                              [key: string]: unknown;
                          }
                          | {
                              blob: string;
                              mimeType?: string;
                              uri: string;
                              [key: string]: unknown;
                          };
                          type: "resource";
                          [key: string]: unknown;
                      };
                  role: "user"
                  | "assistant";
                  [key: string]: unknown;
              }[];
              [key: string]: unknown;
          }
          | Promise<
              {
                  _meta?: { [key: string]: unknown };
                  description?: string;
                  messages: {
                      content:
                          | { text: string; type: "text"; [key: string]: unknown }
                          | {
                              data: string;
                              mimeType: string;
                              type: "image";
                              [key: string]: unknown;
                          }
                          | {
                              data: string;
                              mimeType: string;
                              type: "audio";
                              [key: string]: unknown;
                          }
                          | {
                              resource: | {
                                  mimeType?: (...)
                                  | (...);
                                  text: string;
                                  uri: string;
                                  [key: string]: unknown;
                              }
                              | {
                                  blob: string;
                                  mimeType?: (...)
                                  | (...);
                                  uri: string;
                                  [key: string]: unknown;
                              };
                              type: "resource";
                              [key: string]: unknown;
                          };
                      role: "user"
                      | "assistant";
                      [key: string]: unknown;
                  }[];
                  [key: string]: unknown;
              },
          >,
  ): RegisteredPrompt

  Registers a zero-argument prompt name (with a description) which will run the given function when the client calls it.

  Parameters

  • name: string
  • description: string
  • cb: (
        extra: RequestHandlerExtra<ServerRequest, ServerNotification>,
    ) =>
        | {
            _meta?: { [key: string]: unknown };
            description?: string;
            messages: {
                content:
                    | { text: string; type: "text"; [key: string]: unknown }
                    | {
                        data: string;
                        mimeType: string;
                        type: "image";
                        [key: string]: unknown;
                    }
                    | {
                        data: string;
                        mimeType: string;
                        type: "audio";
                        [key: string]: unknown;
                    }
                    | {
                        resource: | {
                            mimeType?: string;
                            text: string;
                            uri: string;
                            [key: string]: unknown;
                        }
                        | {
                            blob: string;
                            mimeType?: string;
                            uri: string;
                            [key: string]: unknown;
                        };
                        type: "resource";
                        [key: string]: unknown;
                    };
                role: "user"
                | "assistant";
                [key: string]: unknown;
            }[];
            [key: string]: unknown;
        }
        | Promise<
            {
                _meta?: { [key: string]: unknown };
                description?: string;
                messages: {
                    content:
                        | { text: string; type: "text"; [key: string]: unknown }
                        | {
                            data: string;
                            mimeType: string;
                            type: "image";
                            [key: string]: unknown;
                        }
                        | {
                            data: string;
                            mimeType: string;
                            type: "audio";
                            [key: string]: unknown;
                        }
                        | {
                            resource: | {
                                mimeType?: (...)
                                | (...);
                                text: string;
                                uri: string;
                                [key: string]: unknown;
                            }
                            | {
                                blob: string;
                                mimeType?: (...)
                                | (...);
                                uri: string;
                                [key: string]: unknown;
                            };
                            type: "resource";
                            [key: string]: unknown;
                        };
                    role: "user"
                    | "assistant";
                    [key: string]: unknown;
                }[];
                [key: string]: unknown;
            },
        >

  Returns RegisteredPrompt
• prompt<Args extends PromptArgsRawShape>(
      name: string,
      argsSchema: Args,
      cb: PromptCallback<Args>,
  ): RegisteredPrompt

  Registers a prompt name accepting the given arguments, which must be an object containing named properties associated with Zod schemas. When the client calls it, the function will be run with the parsed and validated arguments.

  Type Parameters

  • Args extends PromptArgsRawShape

  Parameters

  • name: string
  • argsSchema: Args
  • cb: PromptCallback<Args>

  Returns RegisteredPrompt
• prompt<Args extends PromptArgsRawShape>(
      name: string,
      description: string,
      argsSchema: Args,
      cb: PromptCallback<Args>,
  ): RegisteredPrompt

  Registers a prompt name (with a description) accepting the given arguments, which must be an object containing named properties associated with Zod schemas. When the client calls it, the function will be run with the parsed and validated arguments.

  Type Parameters

  • Args extends PromptArgsRawShape

  Parameters

  • name: string
  • description: string
  • argsSchema: Args
  • cb: PromptCallback<Args>

  Returns RegisteredPrompt

resource

• resource(
      name: string,
      uri: string,
      readCallback: ReadResourceCallback,
  ): RegisteredResource

  Registers a resource name at a fixed URI, which will use the given callback to respond to read requests.

  Parameters

  • name: string
  • uri: string
  • readCallback: ReadResourceCallback

  Returns RegisteredResource
• resource(
      name: string,
      uri: string,
      metadata: ResourceMetadata,
      readCallback: ReadResourceCallback,
  ): RegisteredResource

  Registers a resource name at a fixed URI with metadata, which will use the given callback to respond to read requests.

  Parameters

  • name: string
  • uri: string
  • metadata: ResourceMetadata
  • readCallback: ReadResourceCallback

  Returns RegisteredResource
• resource(
      name: string,
      template: ResourceTemplate,
      readCallback: ReadResourceTemplateCallback,
  ): RegisteredResourceTemplate

  Registers a resource name with a template pattern, which will use the given callback to respond to read requests.

  Parameters

  • name: string
  • template: ResourceTemplate
  • readCallback: ReadResourceTemplateCallback

  Returns RegisteredResourceTemplate
• resource(
      name: string,
      template: ResourceTemplate,
      metadata: ResourceMetadata,
      readCallback: ReadResourceTemplateCallback,
  ): RegisteredResourceTemplate

  Registers a resource name with a template pattern and metadata, which will use the given callback to respond to read requests.

  Parameters

  • name: string
  • template: ResourceTemplate
  • metadata: ResourceMetadata
  • readCallback: ReadResourceTemplateCallback

  Returns RegisteredResourceTemplate

sendPromptListChanged

• sendPromptListChanged(): void

  Sends a prompt list changed event to the client, if connected.

  Returns void

sendResourceListChanged

• sendResourceListChanged(): void

  Sends a resource list changed event to the client, if connected.

  Returns void

sendToolListChanged

• sendToolListChanged(): void

  Sends a tool list changed event to the client, if connected.

  Returns void

tool

• tool(
      name: string,
      cb: (
          extra: RequestHandlerExtra<ServerRequest, ServerNotification>,
      ) =>
          | {
              _meta?: { [key: string]: unknown };
              content: (
                  | { text: string; type: "text"; [key: string]: unknown }
                  | {
                      data: string;
                      mimeType: string;
                      type: "image";
                      [key: string]: unknown;
                  }
                  | {
                      data: string;
                      mimeType: string;
                      type: "audio";
                      [key: string]: unknown;
                  }
                  | {
                      resource: | {
                          mimeType?: string;
                          text: string;
                          uri: string;
                          [key: string]: unknown;
                      }
                      | {
                          blob: string;
                          mimeType?: string;
                          uri: string;
                          [key: string]: unknown;
                      };
                      type: "resource";
                      [key: string]: unknown;
                  }
              )[];
              isError?: boolean;
              [key: string]: unknown;
          }
          | Promise<
              {
                  _meta?: { [key: string]: unknown };
                  content: (
                      | { text: string; type: "text"; [key: string]: unknown }
                      | {
                          data: string;
                          mimeType: string;
                          type: "image";
                          [key: string]: unknown;
                      }
                      | {
                          data: string;
                          mimeType: string;
                          type: "audio";
                          [key: string]: unknown;
                      }
                      | {
                          resource: | {
                              mimeType?: string;
                              text: string;
                              uri: string;
                              [key: string]: unknown;
                          }
                          | {
                              blob: string;
                              mimeType?: string;
                              uri: string;
                              [key: string]: unknown;
                          };
                          type: "resource";
                          [key: string]: unknown;
                      }
                  )[];
                  isError?: boolean;
                  [key: string]: unknown;
              },
          >,
  ): RegisteredTool

  Registers a zero-argument tool name, which will run the given function when the client calls it.

  Parameters

  • name: string
  • cb: (
        extra: RequestHandlerExtra<ServerRequest, ServerNotification>,
    ) =>
        | {
            _meta?: { [key: string]: unknown };
            content: (
                | { text: string; type: "text"; [key: string]: unknown }
                | {
                    data: string;
                    mimeType: string;
                    type: "image";
                    [key: string]: unknown;
                }
                | {
                    data: string;
                    mimeType: string;
                    type: "audio";
                    [key: string]: unknown;
                }
                | {
                    resource: | {
                        mimeType?: string;
                        text: string;
                        uri: string;
                        [key: string]: unknown;
                    }
                    | {
                        blob: string;
                        mimeType?: string;
                        uri: string;
                        [key: string]: unknown;
                    };
                    type: "resource";
                    [key: string]: unknown;
                }
            )[];
            isError?: boolean;
            [key: string]: unknown;
        }
        | Promise<
            {
                _meta?: { [key: string]: unknown };
                content: (
                    | { text: string; type: "text"; [key: string]: unknown }
                    | {
                        data: string;
                        mimeType: string;
                        type: "image";
                        [key: string]: unknown;
                    }
                    | {
                        data: string;
                        mimeType: string;
                        type: "audio";
                        [key: string]: unknown;
                    }
                    | {
                        resource: | {
                            mimeType?: string;
                            text: string;
                            uri: string;
                            [key: string]: unknown;
                        }
                        | {
                            blob: string;
                            mimeType?: string;
                            uri: string;
                            [key: string]: unknown;
                        };
                        type: "resource";
                        [key: string]: unknown;
                    }
                )[];
                isError?: boolean;
                [key: string]: unknown;
            },
        >

  Returns RegisteredTool
• tool(
      name: string,
      description: string,
      cb: (
          extra: RequestHandlerExtra<ServerRequest, ServerNotification>,
      ) =>
          | {
              _meta?: { [key: string]: unknown };
              content: (
                  | { text: string; type: "text"; [key: string]: unknown }
                  | {
                      data: string;
                      mimeType: string;
                      type: "image";
                      [key: string]: unknown;
                  }
                  | {
                      data: string;
                      mimeType: string;
                      type: "audio";
                      [key: string]: unknown;
                  }
                  | {
                      resource: | {
                          mimeType?: string;
                          text: string;
                          uri: string;
                          [key: string]: unknown;
                      }
                      | {
                          blob: string;
                          mimeType?: string;
                          uri: string;
                          [key: string]: unknown;
                      };
                      type: "resource";
                      [key: string]: unknown;
                  }
              )[];
              isError?: boolean;
              [key: string]: unknown;
          }
          | Promise<
              {
                  _meta?: { [key: string]: unknown };
                  content: (
                      | { text: string; type: "text"; [key: string]: unknown }
                      | {
                          data: string;
                          mimeType: string;
                          type: "image";
                          [key: string]: unknown;
                      }
                      | {
                          data: string;
                          mimeType: string;
                          type: "audio";
                          [key: string]: unknown;
                      }
                      | {
                          resource: | {
                              mimeType?: string;
                              text: string;
                              uri: string;
                              [key: string]: unknown;
                          }
                          | {
                              blob: string;
                              mimeType?: string;
                              uri: string;
                              [key: string]: unknown;
                          };
                          type: "resource";
                          [key: string]: unknown;
                      }
                  )[];
                  isError?: boolean;
                  [key: string]: unknown;
              },
          >,
  ): RegisteredTool

  Registers a zero-argument tool name (with a description) which will run the given function when the client calls it.

  Parameters

  • name: string
  • description: string
  • cb: (
        extra: RequestHandlerExtra<ServerRequest, ServerNotification>,
    ) =>
        | {
            _meta?: { [key: string]: unknown };
            content: (
                | { text: string; type: "text"; [key: string]: unknown }
                | {
                    data: string;
                    mimeType: string;
                    type: "image";
                    [key: string]: unknown;
                }
                | {
                    data: string;
                    mimeType: string;
                    type: "audio";
                    [key: string]: unknown;
                }
                | {
                    resource: | {
                        mimeType?: string;
                        text: string;
                        uri: string;
                        [key: string]: unknown;
                    }
                    | {
                        blob: string;
                        mimeType?: string;
                        uri: string;
                        [key: string]: unknown;
                    };
                    type: "resource";
                    [key: string]: unknown;
                }
            )[];
            isError?: boolean;
            [key: string]: unknown;
        }
        | Promise<
            {
                _meta?: { [key: string]: unknown };
                content: (
                    | { text: string; type: "text"; [key: string]: unknown }
                    | {
                        data: string;
                        mimeType: string;
                        type: "image";
                        [key: string]: unknown;
                    }
                    | {
                        data: string;
                        mimeType: string;
                        type: "audio";
                        [key: string]: unknown;
                    }
                    | {
                        resource: | {
                            mimeType?: string;
                            text: string;
                            uri: string;
                            [key: string]: unknown;
                        }
                        | {
                            blob: string;
                            mimeType?: string;
                            uri: string;
                            [key: string]: unknown;
                        };
                        type: "resource";
                        [key: string]: unknown;
                    }
                )[];
                isError?: boolean;
                [key: string]: unknown;
            },
        >

  Returns RegisteredTool
• tool<Args extends ZodRawShape>(
      name: string,
      paramsSchemaOrAnnotations:
          | Args
          | {
              destructiveHint?: boolean;
              idempotentHint?: boolean;
              openWorldHint?: boolean;
              readOnlyHint?: boolean;
              title?: string;
              [key: string]: unknown;
          },
      cb: ToolCallback<Args>,
  ): RegisteredTool

  Registers a tool taking either a parameter schema for validation or annotations for additional metadata. This unified overload handles both tool(name, paramsSchema, cb) and tool(name, annotations, cb) cases.

  Note: We use a union type for the second parameter because TypeScript cannot reliably disambiguate between ToolAnnotations and ZodRawShape during overload resolution, as both are plain object types.

  Type Parameters

  • Args extends ZodRawShape

  Parameters

  • name: string
  • paramsSchemaOrAnnotations:
        | Args
        | {
            destructiveHint?: boolean;
            idempotentHint?: boolean;
            openWorldHint?: boolean;
            readOnlyHint?: boolean;
            title?: string;
            [key: string]: unknown;
        }
    • Args
    • {
          destructiveHint?: boolean;
          idempotentHint?: boolean;
          openWorldHint?: boolean;
          readOnlyHint?: boolean;
          title?: string;
          [key: string]: unknown;
      }

      • [key: string]: unknown

      • OptionaldestructiveHint?: boolean

        If true, the tool may perform destructive updates to its environment. If false, the tool performs only additive updates.

        (This property is meaningful only when readOnlyHint == false)

        Default: true

      • OptionalidempotentHint?: boolean

        If true, calling the tool repeatedly with the same arguments will have no additional effect on the its environment.

        (This property is meaningful only when readOnlyHint == false)

        Default: false

      • OptionalopenWorldHint?: boolean

        If true, this tool may interact with an "open world" of external entities. If false, the tool's domain of interaction is closed. For example, the world of a web search tool is open, whereas that of a memory tool is not.

        Default: true

      • OptionalreadOnlyHint?: boolean

        If true, the tool does not modify its environment.

        Default: false

      • Optionaltitle?: string

        A human-readable title for the tool.
  • cb: ToolCallback<Args>

  Returns RegisteredTool
• tool<Args extends ZodRawShape>(
      name: string,
      description: string,
      paramsSchemaOrAnnotations:
          | Args
          | {
              destructiveHint?: boolean;
              idempotentHint?: boolean;
              openWorldHint?: boolean;
              readOnlyHint?: boolean;
              title?: string;
              [key: string]: unknown;
          },
      cb: ToolCallback<Args>,
  ): RegisteredTool

  Registers a tool name (with a description) taking either parameter schema or annotations. This unified overload handles both tool(name, description, paramsSchema, cb) and tool(name, description, annotations, cb) cases.

  Note: We use a union type for the third parameter because TypeScript cannot reliably disambiguate between ToolAnnotations and ZodRawShape during overload resolution, as both are plain object types.

  Type Parameters

  • Args extends ZodRawShape

  Parameters

  • name: string
  • description: string
  • paramsSchemaOrAnnotations:
        | Args
        | {
            destructiveHint?: boolean;
            idempotentHint?: boolean;
            openWorldHint?: boolean;
            readOnlyHint?: boolean;
            title?: string;
            [key: string]: unknown;
        }
    • Args
    • {
          destructiveHint?: boolean;
          idempotentHint?: boolean;
          openWorldHint?: boolean;
          readOnlyHint?: boolean;
          title?: string;
          [key: string]: unknown;
      }

      • [key: string]: unknown

      • OptionaldestructiveHint?: boolean

        If true, the tool may perform destructive updates to its environment. If false, the tool performs only additive updates.

        (This property is meaningful only when readOnlyHint == false)

        Default: true

      • OptionalidempotentHint?: boolean

        If true, calling the tool repeatedly with the same arguments will have no additional effect on the its environment.

        (This property is meaningful only when readOnlyHint == false)

        Default: false

      • OptionalopenWorldHint?: boolean

        If true, this tool may interact with an "open world" of external entities. If false, the tool's domain of interaction is closed. For example, the world of a web search tool is open, whereas that of a memory tool is not.

        Default: true

      • OptionalreadOnlyHint?: boolean

        If true, the tool does not modify its environment.

        Default: false

      • Optionaltitle?: string

        A human-readable title for the tool.
  • cb: ToolCallback<Args>

  Returns RegisteredTool
• tool<Args extends ZodRawShape>(
      name: string,
      paramsSchema: Args,
      annotations: {
          destructiveHint?: boolean;
          idempotentHint?: boolean;
          openWorldHint?: boolean;
          readOnlyHint?: boolean;
          title?: string;
          [key: string]: unknown;
      },
      cb: ToolCallback<Args>,
  ): RegisteredTool

  Registers a tool with both parameter schema and annotations.

  Type Parameters

  • Args extends ZodRawShape

  Parameters

  • name: string
  • paramsSchema: Args
  • annotations: {
        destructiveHint?: boolean;
        idempotentHint?: boolean;
        openWorldHint?: boolean;
        readOnlyHint?: boolean;
        title?: string;
        [key: string]: unknown;
    }

    • [key: string]: unknown

    • OptionaldestructiveHint?: boolean

      If true, the tool may perform destructive updates to its environment. If false, the tool performs only additive updates.

      (This property is meaningful only when readOnlyHint == false)

      Default: true

    • OptionalidempotentHint?: boolean

      If true, calling the tool repeatedly with the same arguments will have no additional effect on the its environment.

      (This property is meaningful only when readOnlyHint == false)

      Default: false

    • OptionalopenWorldHint?: boolean

      If true, this tool may interact with an "open world" of external entities. If false, the tool's domain of interaction is closed. For example, the world of a web search tool is open, whereas that of a memory tool is not.

      Default: true

    • OptionalreadOnlyHint?: boolean

      If true, the tool does not modify its environment.

      Default: false

    • Optionaltitle?: string

      A human-readable title for the tool.
  • cb: ToolCallback<Args>

  Returns RegisteredTool
• tool<Args extends ZodRawShape>(
      name: string,
      description: string,
      paramsSchema: Args,
      annotations: {
          destructiveHint?: boolean;
          idempotentHint?: boolean;
          openWorldHint?: boolean;
          readOnlyHint?: boolean;
          title?: string;
          [key: string]: unknown;
      },
      cb: ToolCallback<Args>,
  ): RegisteredTool

  Registers a tool with description, parameter schema, and annotations.

  Type Parameters

  • Args extends ZodRawShape

  Parameters

  • name: string
  • description: string
  • paramsSchema: Args
  • annotations: {
        destructiveHint?: boolean;
        idempotentHint?: boolean;
        openWorldHint?: boolean;
        readOnlyHint?: boolean;
        title?: string;
        [key: string]: unknown;
    }

    • [key: string]: unknown

    • OptionaldestructiveHint?: boolean

      If true, the tool may perform destructive updates to its environment. If false, the tool performs only additive updates.

      (This property is meaningful only when readOnlyHint == false)

      Default: true

    • OptionalidempotentHint?: boolean

      If true, calling the tool repeatedly with the same arguments will have no additional effect on the its environment.

      (This property is meaningful only when readOnlyHint == false)

      Default: false

    • OptionalopenWorldHint?: boolean

      If true, this tool may interact with an "open world" of external entities. If false, the tool's domain of interaction is closed. For example, the world of a web search tool is open, whereas that of a memory tool is not.

      Default: true

    • OptionalreadOnlyHint?: boolean

      If true, the tool does not modify its environment.

      Default: false

    • Optionaltitle?: string

      A human-readable title for the tool.
  • cb: ToolCallback<Args>

  Returns RegisteredTool