@karmaniverous/jeeves
    Preparing search index...

    Interface PluginApi

    Canonical OpenClaw plugin API interface.

    This is the shape of the api object passed to plugins by the OpenClaw gateway at registration time. Fields are optional where the gateway may not provide them in all versions.

    interface PluginApi {
        config?: {
            agents?: { defaults?: { workspace?: string } };
            plugins?: {
                entries?: Record<string, { config?: Record<string, unknown> }>;
            };
        };
        lifecycle?: PluginLifecycleApi;
        logger?: { warn: (message: string) => void };
        pluginConfig?: Record<string, unknown>;
        resolvePath?: (input: string) => string;
        on?(
            hookName: "before_prompt_build",
            handler: PromptBuildHandler,
            opts?: HookRegistrationOptions,
        ): void;
        registerTool(tool: ToolDescriptor, options?: ToolRegistrationOptions): void;
    }
    Index
    config? lifecycle? logger? pluginConfig? resolvePath?
    on? registerTool
    config?: {
        agents?: { defaults?: { workspace?: string } };
        plugins?: {
            entries?: Record<string, { config?: Record<string, unknown> }>;
        };
    }

    OpenClaw configuration object.

    Type Declaration

    • Optionalagents?: { defaults?: { workspace?: string } }

      Agent configuration block.

      • Optionaldefaults?: { workspace?: string }

        Default agent settings.

        • Optionalworkspace?: string

          Absolute path to the workspace root directory.

    • Optionalplugins?: { entries?: Record<string, { config?: Record<string, unknown> }> }

      Installed plugin configuration.

      • Optionalentries?: Record<string, { config?: Record<string, unknown> }>

        Plugin entries keyed by plugin ID.

    lifecycle?: PluginLifecycleApi

    Plugin-owned lifecycle: disposal signal and cleanup registration. Present on OpenClaw 2026.9.x.

    logger?: { warn: (message: string) => void }

    Host logger, when provided.

    Type Declaration

    • warn: (message: string) => void

      Log a warning.

    pluginConfig?: Record<string, unknown>

    Plugin-scoped config (plugins.entries.<id>.config), when provided.

    resolvePath?: (input: string) => string

    Resolve a path relative to the OpenClaw workspace.

    Present on newer OpenClaw builds; optional for backwards compatibility.

    Settings
    Member Visibility

    On This Page
    Properties
    Methods