OpenFairyGUI API
    Preparing search index...

    Interface OpenFairyGuiBackendToolDefinition

    interface OpenFairyGuiBackendToolDefinition {
        annotations: {
            destructiveHint?: boolean;
            idempotentHint?: boolean;
            openWorldHint?: boolean;
            readOnlyHint?: boolean;
        };
        backendMethod: keyof BackendRuntime;
        description: string;
        inputSchema: ZodObject;
        maxResponseBytes?: number;
        name: | "openfairygui_backend_get_capabilities"
        | "openfairygui_backend_open_session"
        | "openfairygui_backend_open_project_session"
        | "openfairygui_backend_get_session"
        | "openfairygui_backend_get_project_outline"
        | "openfairygui_backend_query_entity"
        | "openfairygui_backend_read_session_state"
        | "openfairygui_backend_read_resource_bytes"
        | "openfairygui_backend_validate_session"
        | "openfairygui_backend_preflight_transaction"
        | "openfairygui_backend_apply_transaction"
        | "openfairygui_backend_save_session"
        | "openfairygui_backend_materialize_session"
        | "openfairygui_backend_close_session"
        | "openfairygui_backend_get_events"
        | "openfairygui_backend_get_cache_snapshot"
        | "openfairygui_backend_refresh_cache";
        outputSchema: ZodObject;
        title: string;
    }

    Hierarchy

    • BackendToolMetadata
      • OpenFairyGuiBackendToolDefinition
    Index
    annotations: {
        destructiveHint?: boolean;
        idempotentHint?: boolean;
        openWorldHint?: boolean;
        readOnlyHint?: boolean;
    }
    backendMethod: keyof BackendRuntime
    description: string
    inputSchema: ZodObject
    maxResponseBytes?: number

    Bound the complete CallToolResult JSON; bounded reads use compact text JSON.

    name:
        | "openfairygui_backend_get_capabilities"
        | "openfairygui_backend_open_session"
        | "openfairygui_backend_open_project_session"
        | "openfairygui_backend_get_session"
        | "openfairygui_backend_get_project_outline"
        | "openfairygui_backend_query_entity"
        | "openfairygui_backend_read_session_state"
        | "openfairygui_backend_read_resource_bytes"
        | "openfairygui_backend_validate_session"
        | "openfairygui_backend_preflight_transaction"
        | "openfairygui_backend_apply_transaction"
        | "openfairygui_backend_save_session"
        | "openfairygui_backend_materialize_session"
        | "openfairygui_backend_close_session"
        | "openfairygui_backend_get_events"
        | "openfairygui_backend_get_cache_snapshot"
        | "openfairygui_backend_refresh_cache"
    outputSchema: ZodObject
    title: string