OpenFairyGUI API
    Preparing search index...

    Variable OPENFAIRYGUI_BACKEND_TOOL_DEFINITIONSConst

    OPENFAIRYGUI_BACKEND_TOOL_DEFINITIONS: readonly [
        {
            annotations: {
                idempotentHint: true;
                openWorldHint: false;
                readOnlyHint: true;
            };
            backendMethod: "getCapabilities";
            description: "Return the OpenFairyGUI backend capability, version, and service-plane snapshot.";
            inputSchema: ZodObject<{}, $strip>;
            name: "openfairygui_backend_get_capabilities";
            outputSchema: ZodObject<
                {
                    backendResult: ZodObject<
                        {
                            data: ZodOptional<ZodUnknown>;
                            error: ZodOptional<ZodUnknown>;
                            meta: ZodOptional<ZodUnknown>;
                            ok: ZodBoolean;
                        },
                        $loose,
                    >;
                },
                $strip,
            >;
            title: "Get Backend Capabilities";
        },
        {
            annotations: {
                idempotentHint: false;
                openWorldHint: false;
                readOnlyHint: false;
            };
            backendMethod: "openSession";
            description: "Open a FairyGUI project through BackendRuntime and acquire its backend-local session lock.";
            inputSchema: ZodObject<{ projectPath: ZodString }, $strip>;
            name: "openfairygui_backend_open_session";
            outputSchema: ZodObject<
                {
                    backendResult: ZodObject<
                        {
                            data: ZodOptional<ZodUnknown>;
                            error: ZodOptional<ZodUnknown>;
                            meta: ZodOptional<ZodUnknown>;
                            ok: ZodBoolean;
                        },
                        $loose,
                    >;
                },
                $strip,
            >;
            title: "Open Backend Session";
        },
        {
            annotations: {
                idempotentHint: false;
                openWorldHint: false;
                readOnlyHint: false;
            };
            backendMethod: "openProjectSession";
            description: "Open a browser-safe backend session from an already loaded UAM project without filesystem access.";
            inputSchema: ZodObject<
                {
                    canonicalPathKey: ZodOptional<ZodString>;
                    canonicalProjectPath: ZodOptional<ZodString>;
                    project: ZodUnknown;
                    sessionId: ZodOptional<ZodString>;
                },
                $strip,
            >;
            name: "openfairygui_backend_open_project_session";
            outputSchema: ZodObject<
                {
                    backendResult: ZodObject<
                        {
                            data: ZodOptional<ZodUnknown>;
                            error: ZodOptional<ZodUnknown>;
                            meta: ZodOptional<ZodUnknown>;
                            ok: ZodBoolean;
                        },
                        $loose,
                    >;
                },
                $strip,
            >;
            title: "Open Project Session";
        },
        {
            annotations: {
                idempotentHint: true;
                openWorldHint: false;
                readOnlyHint: true;
            };
            backendMethod: "getSession";
            description: "Return a backend session snapshot by session id.";
            inputSchema: ZodObject<{ sessionId: ZodString }, $strip>;
            name: "openfairygui_backend_get_session";
            outputSchema: ZodObject<
                {
                    backendResult: ZodObject<
                        {
                            data: ZodOptional<ZodUnknown>;
                            error: ZodOptional<ZodUnknown>;
                            meta: ZodOptional<ZodUnknown>;
                            ok: ZodBoolean;
                        },
                        $loose,
                    >;
                },
                $strip,
            >;
            title: "Get Backend Session";
        },
        {
            annotations: {
                destructiveHint: true;
                idempotentHint: false;
                openWorldHint: false;
                readOnlyHint: false;
            };
            backendMethod: "applyTransaction";
            description: "Apply a backend revision-checked UAM operation batch without redefining selector or operation grammar.";
            inputSchema: ZodObject<
                {
                    expectedRevision: ZodNumber;
                    operations: ZodArray<ZodUnknown>;
                    sessionId: ZodString;
                },
                $strip,
            >;
            name: "openfairygui_backend_apply_transaction";
            outputSchema: ZodObject<
                {
                    backendResult: ZodObject<
                        {
                            data: ZodOptional<ZodUnknown>;
                            error: ZodOptional<ZodUnknown>;
                            meta: ZodOptional<ZodUnknown>;
                            ok: ZodBoolean;
                        },
                        $loose,
                    >;
                },
                $strip,
            >;
            title: "Apply UAM Transaction";
        },
        {
            annotations: {
                destructiveHint: true;
                idempotentHint: false;
                openWorldHint: false;
                readOnlyHint: false;
            };
            backendMethod: "saveSession";
            description: "Write the current backend session back through the backend coordinated non-atomic save path.";
            inputSchema: ZodObject<
                {
                    expectedRevision: ZodOptional<ZodNumber>;
                    force: ZodOptional<ZodBoolean>;
                    mode: ZodOptional<ZodLiteral<"materializeCleanSession">>;
                    sessionId: ZodString;
                    targetPath: ZodOptional<ZodString>;
                },
                $strip,
            >;
            name: "openfairygui_backend_save_session";
            outputSchema: ZodObject<
                {
                    backendResult: ZodObject<
                        {
                            data: ZodOptional<ZodUnknown>;
                            error: ZodOptional<ZodUnknown>;
                            meta: ZodOptional<ZodUnknown>;
                            ok: ZodBoolean;
                        },
                        $loose,
                    >;
                },
                $strip,
            >;
            title: "Save Backend Session";
        },
        {
            annotations: {
                destructiveHint: true;
                idempotentHint: false;
                openWorldHint: false;
                readOnlyHint: false;
            };
            backendMethod: "materializeSession";
            description: "Force materialize the current backend session project through the configured project storage without requiring a dirty edit revision.";
            inputSchema: ZodObject<
                {
                    expectedRevision: ZodOptional<ZodNumber>;
                    mode: ZodOptional<ZodLiteral<"fullProject">>;
                    reason: ZodOptional<ZodString>;
                    sessionId: ZodString;
                },
                $strip,
            >;
            name: "openfairygui_backend_materialize_session";
            outputSchema: ZodObject<
                {
                    backendResult: ZodObject<
                        {
                            data: ZodOptional<ZodUnknown>;
                            error: ZodOptional<ZodUnknown>;
                            meta: ZodOptional<ZodUnknown>;
                            ok: ZodBoolean;
                        },
                        $loose,
                    >;
                },
                $strip,
            >;
            title: "Materialize Backend Session";
        },
        {
            annotations: {
                idempotentHint: false;
                openWorldHint: false;
                readOnlyHint: false;
            };
            backendMethod: "closeSession";
            description: "Close a backend session and release its backend-local advisory lock.";
            inputSchema: ZodObject<{ sessionId: ZodString }, $strip>;
            name: "openfairygui_backend_close_session";
            outputSchema: ZodObject<
                {
                    backendResult: ZodObject<
                        {
                            data: ZodOptional<ZodUnknown>;
                            error: ZodOptional<ZodUnknown>;
                            meta: ZodOptional<ZodUnknown>;
                            ok: ZodBoolean;
                        },
                        $loose,
                    >;
                },
                $strip,
            >;
            title: "Close Backend Session";
        },
        {
            annotations: {
                idempotentHint: true;
                openWorldHint: false;
                readOnlyHint: true;
            };
            backendMethod: "getEvents";
            description: "Poll backend runtime events for a session using the backend P2 event cursor contract.";
            inputSchema: ZodObject<
                {
                    after: ZodOptional<ZodString>;
                    limit: ZodOptional<ZodNumber>;
                    sessionId: ZodString;
                },
                $strip,
            >;
            name: "openfairygui_backend_get_events";
            outputSchema: ZodObject<
                {
                    backendResult: ZodObject<
                        {
                            data: ZodOptional<ZodUnknown>;
                            error: ZodOptional<ZodUnknown>;
                            meta: ZodOptional<ZodUnknown>;
                            ok: ZodBoolean;
                        },
                        $loose,
                    >;
                },
                $strip,
            >;
            title: "Get Runtime Events";
        },
        {
            annotations: {
                idempotentHint: true;
                openWorldHint: false;
                readOnlyHint: true;
            };
            backendMethod: "getJob";
            description: "Return a backend runtime job snapshot by session and backend-local job id.";
            inputSchema: ZodObject<{ jobId: ZodString; sessionId: ZodString }, $strip>;
            name: "openfairygui_backend_get_job";
            outputSchema: ZodObject<
                {
                    backendResult: ZodObject<
                        {
                            data: ZodOptional<ZodUnknown>;
                            error: ZodOptional<ZodUnknown>;
                            meta: ZodOptional<ZodUnknown>;
                            ok: ZodBoolean;
                        },
                        $loose,
                    >;
                },
                $strip,
            >;
            title: "Get Runtime Job";
        },
        {
            annotations: {
                idempotentHint: true;
                openWorldHint: false;
                readOnlyHint: true;
            };
            backendMethod: "listJobs";
            description: "List backend runtime jobs for a session with backend P2 status/kind filters.";
            inputSchema: ZodObject<
                {
                    kind: ZodOptional<ZodLiteral<"cache.refresh">>;
                    limit: ZodOptional<ZodNumber>;
                    sessionId: ZodString;
                    status: ZodOptional<
                        ZodEnum<
                            {
                                active: "active";
                                cancelled: "cancelled";
                                completed: "completed";
                                failed: "failed";
                                queued: "queued";
                                running: "running";
                                terminal: "terminal";
                            },
                        >,
                    >;
                },
                $strip,
            >;
            name: "openfairygui_backend_list_jobs";
            outputSchema: ZodObject<
                {
                    backendResult: ZodObject<
                        {
                            data: ZodOptional<ZodUnknown>;
                            error: ZodOptional<ZodUnknown>;
                            meta: ZodOptional<ZodUnknown>;
                            ok: ZodBoolean;
                        },
                        $loose,
                    >;
                },
                $strip,
            >;
            title: "List Runtime Jobs";
        },
        {
            annotations: {
                idempotentHint: false;
                openWorldHint: false;
                readOnlyHint: false;
            };
            backendMethod: "cancelJob";
            description: "Request cooperative cancellation for a backend runtime job.";
            inputSchema: ZodObject<{ jobId: ZodString; sessionId: ZodString }, $strip>;
            name: "openfairygui_backend_cancel_job";
            outputSchema: ZodObject<
                {
                    backendResult: ZodObject<
                        {
                            data: ZodOptional<ZodUnknown>;
                            error: ZodOptional<ZodUnknown>;
                            meta: ZodOptional<ZodUnknown>;
                            ok: ZodBoolean;
                        },
                        $loose,
                    >;
                },
                $strip,
            >;
            title: "Cancel Runtime Job";
        },
        {
            annotations: {
                idempotentHint: true;
                openWorldHint: false;
                readOnlyHint: true;
            };
            backendMethod: "getCacheSnapshot";
            description: "Return the backend P2 derived read-only cache snapshot for a session.";
            inputSchema: ZodObject<{ sessionId: ZodString }, $strip>;
            name: "openfairygui_backend_get_cache_snapshot";
            outputSchema: ZodObject<
                {
                    backendResult: ZodObject<
                        {
                            data: ZodOptional<ZodUnknown>;
                            error: ZodOptional<ZodUnknown>;
                            meta: ZodOptional<ZodUnknown>;
                            ok: ZodBoolean;
                        },
                        $loose,
                    >;
                },
                $strip,
            >;
            title: "Get Cache Snapshot";
        },
        {
            annotations: {
                idempotentHint: false;
                openWorldHint: false;
                readOnlyHint: false;
            };
            backendMethod: "refreshCache";
            description: "Create a backend P2 cache.refresh job for the session cache snapshot.";
            inputSchema: ZodObject<
                {
                    reason: ZodOptional<
                        ZodEnum<
                            {
                                after_save: "after_save";
                                manual: "manual";
                                session_open: "session_open";
                            },
                        >,
                    >;
                    sessionId: ZodString;
                },
                $strip,
            >;
            name: "openfairygui_backend_refresh_cache";
            outputSchema: ZodObject<
                {
                    backendResult: ZodObject<
                        {
                            data: ZodOptional<ZodUnknown>;
                            error: ZodOptional<ZodUnknown>;
                            meta: ZodOptional<ZodUnknown>;
                            ok: ZodBoolean;
                        },
                        $loose,
                    >;
                },
                $strip,
            >;
            title: "Refresh Cache";
        },
    ] = ...