@karmaniverous/jeeves
    Preparing search index...

    Interface PluginToolsetOptions<C>

    Options for createPluginToolset.

    interface PluginToolsetOptions<C extends Catalog = Catalog> {
        api?: PluginApi;
        apiUrl?: string | PluginApiUrlResolver;
        auth?: ClientAuth;
        catalog?: C;
        tools?: Partial<
            Record<
                C["entries"][number]["name"],
                | true
                | {
                    catalogMode?: "direct-only";
                    description?: string;
                    inputAliases?: Record<string, string>;
                },
            >,
        >;
    }

    Type Parameters

    Index
    api? apiUrl? auth? catalog? tools?
    api?: PluginApi

    Plugin API: when set, the descriptor's customPluginTools(api) result is appended (#141).

    apiUrl?: string | PluginApiUrlResolver

    Service base URL (e.g. http://127.0.0.1:1936), or a resolver evaluated per tool call. Unset, empty, or a resolver returning undefined falls back to http://127.0.0.1:<defaultPort>.

    auth?: ClientAuth

    Credential for catalog-built tools and, when catalog is passed, the standard tools; attached only to entries whose auth lists a matching scheme. Without it no credentials are sent, as in 0.7.0.

    catalog?: C

    The component's endpoint catalog. Enables tools; its status, config and configApply entries (with their real auth) back the standard tools.

    tools?: Partial<
        Record<
            C["entries"][number]["name"],
            | true
            | {
                catalogMode?: "direct-only";
                description?: string;
                inputAliases?: Record<string, string>;
            },
        >,
    >

    Catalog entries to expose as tools (true or settings), keyed by entry name; unselected entries get no tool. Requires catalog.

    Settings
    Member Visibility

    On This Page
    Properties