MCP Apps Kit - v0.5.0
    Preparing search index...

    Interface ToolBuilderConfigurable

    Options available once input is set.

    interface ToolBuilderConfigurable {
        destructive(): this;
        expensive(): this;
        fileParams(params: string[]): this;
        idempotent(): this;
        invokedMessage(message: string): this;
        invokingMessage(message: string): this;
        readOnly(): this;
        ui(path: string, options?: UIOptions): this;
        ui(definition: UIDef): this;
        uiRef(key: string): this;
        visibility(value: ToolVisibilityInput): this;
        widgetAccessible(value: boolean): this;
    }

    Hierarchy (View Summary)

    Index

    Methods

    destructive expensive fileParams idempotent invokedMessage invokingMessage readOnly ui uiRef visibility widgetAccessible

    Methods

    • Set file parameter names accepted by this tool (ChatGPT only).

      Parameters

      • params: string[]

      Returns this

    • Set the invoked message shown after completion (ChatGPT only).

      Parameters

      • message: string

      Returns this

    • Set the invoking message shown while executing (ChatGPT only).

      Parameters

      • message: string

      Returns this

    • Attach UI by HTML path, inline HTML, or a UI key reference.

      Strings that look like paths or HTML are treated as UI definitions. Use uiRef() to explicitly reference a UI key.

      Parameters

      • path: string
      • Optionaloptions: UIOptions

      Returns this

    • Attach a pre-defined UI definition.

      Parameters

      Returns this

    • Set tool visibility (model/app/both).

      Parameters

      • value: ToolVisibilityInput

      Returns this

    Settings

    Member Visibility

    On This Page

    Methods