Bluestep JS Documentation
    Preparing search index...

    Interface AiToolAnnotations

    Advisory labels an AiTool's author attaches to it, read by the onToolCall hook. Never enforced by the platform.

    interface AiToolAnnotations {
        destructive?: boolean;
        idempotent?: boolean;
        readOnly?: boolean;
    }
    Index
    destructive?: boolean

    The tool may destroy or overwrite something a person would want back. Absent when the author did not say.

    idempotent?: boolean

    Calling the tool twice with the same arguments does what calling it once does. Absent when the author did not say.

    readOnly?: boolean

    The tool does not change anything. Absent when the author did not say.