Interface McpClientToolProps

Source
interface McpClientToolProps {
    alwaysOutputData?: boolean;
    disabled?: boolean;
    executeOnce?: boolean;
    httpBearerAuthCredentials?: Credentials<
        HttpBearerAuthCredentials,
    >;
    httpHeaderAuthCredentials?: Credentials<
        HttpHeaderAuthCredentials,
    >;
    httpMultipleHeadersAuthCredentials?: Credentials<
        HttpMultipleHeadersAuthCredentials,
    >;
    label?: string;
    maxTries?: number;
    mcpOAuth2ApiCredentials?: Credentials<
        McpOAuth2ApiCredentials,
    >;
    notes?: string;
    notesInFlow?: boolean;
    onError?: | "continueRegularOutput"
    | "continueErrorOutput";
    outputSchema?: Type<unknown, {}>;
    parameters?: McpClientToolNodeParameters;
    position?: NodePosition;
    retryOnFail?: boolean;
}

Properties§

§alwaysOutputData?: boolean
§disabled?: boolean

If true, the node won't run but subsequent nodes WILL be executed

default
false
§executeOnce?: boolean

If active, the node executes only once, with data from the first item it receives

default
false
§readonly httpBearerAuthCredentials?: Credentials<HttpBearerAuthCredentials>
§readonly httpHeaderAuthCredentials?: Credentials<HttpHeaderAuthCredentials>
§readonly httpMultipleHeadersAuthCredentials?: Credentials<HttpMultipleHeadersAuthCredentials>
§label?: string
§maxTries?: number

Number of times to attempt to execute the node before failing the execution Enabled if retryOnFail is true

default
3
§readonly mcpOAuth2ApiCredentials?: Credentials<McpOAuth2ApiCredentials>
§notes?: string

Optional note to save with the node

default
undefined
§notesInFlow?: boolean
§onError?: "continueRegularOutput" | "continueErrorOutput"

Action to take when the node execution fails When undefined, an error will stop the workflow execution

default
undefined
§readonly outputSchema?: Type<unknown, {}>

{@inheritDoc OutputSchema}

§readonly parameters?: McpClientToolNodeParameters
§position?: NodePosition
§retryOnFail?: boolean

If active, the node tries to execute again when it fails

default
false