Bool

Edit a file in a Bool project with find-and-replace. An edit fails unless its old_str matches exactly one place in the file, so include a few lines of surrounding context. Pass several edits in one call to apply them in order.

edit_file

The public connection descriptor a local bool-sdk client needs to use this project as its backend: slug, appOrigin, the project's schema, and the shared Supabase URL plus anon key. The anon key has no data grants; the gateway holds the real credential. Pair with `bool link` or hand-write bool.config.json from this. Create admin data keys in Bool's project settings rather than exposing credentials through an AI conversation.

get_project_connection

Check whether an AI turn is currently running for a project and get its current live URL, visibility, and deployment state. Use this to poll after `prompt_project` until the turn finishes and the project is deployed.

get_project_status

Fetch a project's live URL and its deployment history (every version, which one is currently live). The public URL is stable across versions. Use update_project to change visibility or other project details.

get_project

Return the build guide for a Bool project: the instructions Bool's own builder follows for that project. It covers the Bool SDK APIs the project has, how data, sign-in and files work, which files are locked, the design rules, and how the file, build and version tools fit together.

get_build_guide

List a project's declared entities (data models): each entity's name, access mode ("private" = per-user rows via row-level security, "public" = one shared table), and fields (name, type, required, enum values). Entities are how a Bool project stores data — apps read/write them via `bool.entities.<name>` (SDK) or the record tools here. Use define_entity to create or extend one.

list_entities

List every file in a Bool project with its size.

list_files

List the Bool projects across all your workspaces (personal and shared). Returns each project's id, name, slug, workspace, whether it's deployed, and its visibility (`liveAccess` — who can view the deployed app: "link" public, "workspace", or "restricted"; and `editorAccess` — who can open it in the editor). Pass `workspace_id` (from list_workspaces) to limit to one workspace. (A workspace-bound access token always lists only the workspace it's bound to.)

list_projects

Read rows from one of a project's entities (or any table in its database). Returns the matching rows plus the total count. Supports column filters (eq, neq, contains, starts_with, gt/gte/lt/lte, is_null/is_not_null — all AND-ed), a sort, and limit/offset paging (limit caps at 500). This reads as the project admin: it sees ALL rows, including every end-user's rows on a private entity.

list_records

List the starter templates you can pass to `create_project`'s `template` parameter. Defaults to `vite-react`.

list_templates

List the workspaces you can act in, including your original workspace and any additional workspaces you belong to. Each entry includes `plan` (the workspace's plan tier) and `paid` (true for a paid plan, which lifts the free deployed-bool cap). Use a workspace's `id` as the `workspace_id` argument to other tools (create_project, list_projects, publish_project, fork_project, move_project) to target it. A workspace-bound access token sees only the workspace it is bound to.

list_workspaces

Move an existing project to a different workspace. Only the project owner can move it. The project keeps its current visibility and editor settings; if the current visibility is not allowed in the new workspace, use `update_project` to change visibility first. The project's folder is cleared so it lands at the root of the new workspace. Use this to fix workspace placement, e.g. when a work project was created in a personal workspace.

move_project

Send a prompt to an existing project's AI and run a headless turn in the background. The AI reads the project, edits files, runs `build_app`, and — unless `auto_publish` is false — publishes the result when the turn completes. Before prompting, check the project's current workspace. If the prompt is clearly for the wrong workspace (e.g. a work request on a project that lives in a personal workspace), move it to the right workspace with `move_project` first. Use this to iteratively build and refine a website or app. Poll `get_project_status` to wait for the turn to finish.

prompt_project

Build and publish a project (or a specific snapshot) so it goes live at its deployed URL, governed by the project's current access setting. If no `snapshot_id` is given, the project's current source is published, including any edits made with create_file or edit_file. A clear error is returned if the workspace's deployed-bool cap is reached. Before publishing, consider whether the project is in the right workspace for its content. If it looks like a work project in a personal workspace, use `move_project` to relocate it to a shared/company workspace first.

publish_project

Return Bool's plugin settings, their current values, and their layout.

settings_read

Read a text file from a Bool project. Long files come back in pages; pass nextOffset to read the next page. Binary files return their size instead of their bytes.

read_file

Remix an existing project: create a copy of it in your workspace. By default the project's structure (entities, files, and code) is copied; set `with_data` to true to also copy all database rows, including private end-user rows. `with_data` requires owner access.

fork_project

Run SQL in the Bool project's own database schema, inside a transaction, and return any result rows. On failure the result includes Postgres's error detail and hint. To create tables, define_entity is usually the better choice.

run_db_migration

Run a command, such as npm install, in the Bool project's own sandbox and return its exit code and output. The dev server is already running, and background commands are not supported.

run_command

Save the project's current source as a version in its version history, after build_app passes. The user sees it in the editor's version list and can restore it later. Does nothing if the source hasn't changed since the last version. Does not publish; use publish_project for that.

save_version

Make an image the app's icon, the one browsers and home screens show, replacing the current icon. Bool writes every icon size from it. Use a square image, such as one the user shared or one you generated.

set_project_icon

Render an interactive status card for one Bool project: build status, the live app and editor links, and follow-up controls. It's for clients that can't show the Bool editor; in ChatGPT, save_version and open_bool_editor already show the project. The card refreshes itself, so one call is enough.

render_project_widget

Return the session the Bool editor panel uses to load the editor. Called by the panel, not the model.

get_editor_session

Stop the AI turn currently building or editing a project. This can leave partial edits from the interrupted turn, so use it only when the user asks to stop or cancel the active build.

cancel_project_turn

Change Bool's plugin settings.

settings_update

Patch one row of a project's entity by id: sets the given fields, leaves the rest untouched. Returns the updated row.

update_record

Rename a project, set its description, or change its visibility. Setting visibility to `link` can make a deployed app publicly reachable. Owner-only. Visibility changes are gated by the workspace's plan, the same way as the dashboard.

update_project