Tools reference/Brain admin

Company brain admin

These tools bring workspaces, projects, folders and documents into the company brain or take them out, and start rebuilds. Each change is previewed first, showing what will enter or leave the brain and what it will cost, then confirmed with the preview's token. They need the key's knowledge graph capability and the Enterprise plan, and switching the brain on waits until an owner or admin has accepted the Brain terms in the app.

The live list

Your AI tool can call searchTools with category: "kg_admin" for the current list of these tools with every input. This page is the readable copy.

The tools

Every tool below keeps to the access of the key or sign-in that calls it, and to the person’s own role. A tool only sees the tools it may use.

  • applyKgScopeChange

    Apply a previewed scope change (atomic, idempotent).

  • cancelAllKgInScope

    Cancel all in-flight KG operations in scope.

  • cancelKgBuildBatch

    Cancel an in-progress build batch.

  • getKgScopeTree

    Read the current scope state for the org/workspace.

  • previewKgRebuild

    Preview a rebuild of the brain (cost + ETA).

  • previewKgScopeChange

    Preview a scope change: credit cost, ETA, what changes.

  • resetDocumentInBrain

    Force-rebuild a single document's KG presence.

  • setKgDocumentScope

    Toggle document scope state.

  • setKgFolderScope

    Toggle folder scope state.

  • setKgProjectVisibility

    Set project visibility mode (strict / permissive / open).

  • setKgWorkspaceScope

    Toggle workspace scope (on / off / inherit). No re-ingest.

  • triggerKgRebuild

    Trigger a brain rebuild (consumes confirmation token).