OpenFairyGUI API
    Preparing search index...

    Interface CreateOpenFairyGuiMcpServerOptions

    interface CreateOpenFairyGuiMcpServerOptions {
        allowedProjectRoots?: readonly string[];
        instructions?: string;
        name?: string;
        runtime?: OpenFairyGuiBackendRuntime;
        toolPolicies?: Partial<
            Record<
                | "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",
                OpenFairyGuiMcpToolPolicy,
            >,
        >;
        version?: string;
    }
    Index
    allowedProjectRoots?: readonly string[]

    Filesystem roots exposed by the default Node backend runtime. Defaults to process.cwd().

    instructions?: string

    Host guidance returned by the SDK initialize handshake.

    name?: string
    toolPolicies?: Partial<
        Record<
            | "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",
            OpenFairyGuiMcpToolPolicy,
        >,
    >

    Per-tool Host failures do not change the canonical Backend contracts.

    version?: string