DocsConnect

llms.txt

A map of these docs for language models, at scaffold.llc/llms.txt. Every page is also Markdown: add .md to its address, or use Copy page.

llms.txt
# Scaffold > Scaffold is where AI assistants plan work and ship it: tasks, pages and databases, plus hosting with Postgres, sign-in, email and Stripe. Every command is an MCP tool action, an SDK method and an HTTP endpoint. MCP server: https://scaffold.llc/mcpSDK: npm install @scaffold-llc/sdkAPI: https://scaffold.llc/v1 ## Guides- [Quickstart](https://scaffold.llc/docs/quickstart.md): Create a task and a project and hand the task off, from one TypeScript file.- [Connect an assistant](https://scaffold.llc/docs/connect.md): Add Scaffold's MCP server to Claude Code, Claude, ChatGPT, Cursor or VS Code.- [Authentication](https://scaffold.llc/docs/oauth.md): Personal tokens for scripts, OAuth for assistants, and the access each one has.- [TypeScript SDK](https://scaffold.llc/docs/sdk.md): Install the SDK, create a client and call any command as a typed method.- [MCP server](https://scaffold.llc/docs/mcp.md): The MCP server's tools, how a session looks and when agents ask first.- [Command map](https://scaffold.llc/docs/commands.md): Every command as an MCP tool action, an SDK method and an HTTP route.- [Errors and limits](https://scaffold.llc/docs/errors.md): Error codes, rate limits, pagination and safe retries. ## Commands- `account.get`: GET /v1/account, MCP account_get in account_read. Show the person you act for: name, email, signup time, how they sign in, the request's console session and any pending deletion. An ended console session answers 401 with why in the error's details.- `image.get`: GET /v1/images/{image_id}, MCP image_get in account_read. Read a logo or avatar by the image id ending its URL.- `workspace.create`: POST /v1/workspaces, MCP workspace_create in workspace_irreversible. Create a workspace on Free with you as its owner, named 1 to 80 characters and unlike your other workspaces. Each person owns one Free workspace: while you own one, upgrade it before creating another. Your first workspace gets your 50 starter credits once your email is verified.- `workspace.rename`: POST /v1/workspaces/{workspace_id}/rename, MCP workspace_rename in workspace_write. Rename a workspace you own. Its slug stays the same.- `workspace.logo_set`: POST /v1/workspaces/{workspace_id}/logo, MCP workspace_logo_set in workspace_write. Set or clear the logo of a workspace you own.- `workspace.delete`: DELETE /v1/workspaces/{workspace_id}, MCP workspace_delete in workspace_write. Delete a workspace you own, unless a paid plan renews.- `workspace.restore`: POST /v1/workspaces/{workspace_id}/restore, MCP workspace_restore in workspace_write. Undo workspace.delete within 24 hours. A Free one waits while you own another Free workspace, as each person owns one.- `workspace.export_start`: POST /v1/workspaces/{workspace_id}/exports, MCP workspace_export_start in workspace_irreversible. Zip a workspace you own. workspace.export_get shows its progress and workspace.export_download returns the zip once it is ready.- `workspace.export_get`: GET /v1/workspaces/{workspace_id}/export, MCP workspace_export_get in workspace_read. An export's progress; the latest by default.- `workspace.export_download`: GET /v1/workspaces/{workspace_id}/exports/{export_id}/download, MCP workspace_export_download in workspace_read. A ready export's zip, as base64. Needs write access, since it holds every project's database.- `workspace.list`: GET /v1/workspaces, MCP workspace_list in workspace_read. List your workspaces and your role in each.- `workspace.member_invite`: POST /v1/workspaces/{workspace_id}/invites, MCP workspace_member_invite in workspace_irreversible. Invite an email to a workspace you own. Pass on the invite link secret it answers, shown only once.- `workspace.invite_revoke`: DELETE /v1/invites/{invite_id}, MCP workspace_invite_revoke in workspace_write. Revoke an open invite to a workspace you own, by its id from workspace.member_list.- `workspace.invite_restore`: POST /v1/invites/{invite_id}/restore, MCP workspace_invite_restore in workspace_write. Undo a revoke before the invite expires.- `workspace.invite_dismiss`: POST /v1/invites/{invite_id}/dismiss, MCP workspace_invite_dismiss in workspace_irreversible. Hide a declined invite that workspace.member_list shows.- `workspace.invite_accept`: POST /v1/invites/accept, MCP workspace_invite_accept in workspace_write. Join a workspace by an invite sent to your account's email.- `workspace.invite_decline`: POST /v1/invites/decline, MCP workspace_invite_decline in workspace_irreversible. Turn down an invite sent to your account's email, by its secret.- `workspace.invite_get`: POST /v1/invites/preview, MCP workspace_invite_get in workspace_read. Show an invite from its link secret, signed in or not, and whether it is still open.- `workspace.member_list`: GET /v1/workspaces/{workspace_id}/members, MCP workspace_member_list in workspace_read. List a workspace's members with roles, avatars and last activity, and its open invites.- `workspace.ownership_transfer`: POST /v1/workspaces/{workspace_id}/transfer-ownership, MCP workspace_ownership_transfer in workspace_irreversible. Make a member the owner of a workspace you own. The plan stops using your card and billing details; the new owner adds theirs in the billing portal.- `workspace.member_remove`: DELETE /v1/workspaces/{workspace_id}/members/{person_id}, MCP workspace_member_remove in workspace_irreversible. Remove a member from a workspace you own, or leave one with your own person_id. Revokes their tokens there.- `project.create`: POST /v1/projects, MCP project_create in project_write. Create a project in a workspace. Refused while a deleted one with the slug can be restored, unless ignore_restorable. A Free workspace holds 2 projects; server templates need the Paid plan.- `project.list`: GET /v1/projects, MCP project_list in project_read. List a workspace's projects, leaving out deleted ones.- `project.get`: GET /v1/projects/{project_id}, MCP project_get in project_read. Show a live project with its runtime, its newest deploy and, while Scaffold has it suspended, why and the statement of reasons to appeal.- `project.metrics_get`: GET /v1/projects/{project_id}/metrics, MCP project_metrics_get in project_read. Show a project's app users over 30 days and its costs this month: the credits of runs started for it, the hours its apps ran and what it stores.- `project.address_check`: GET /v1/projects/address-check, MCP project_address_check in project_read. Show the address a new project with this name would get and whether it is free. If not, project.create adds 4 random characters.- `project.delete`: DELETE /v1/projects/{project_id}, MCP project_delete in project_write. Owner only: delete a project after a 24 hour grace period.- `project.restore`: POST /v1/projects/{project_id}/restore, MCP project_restore in project_write. Owner only: restore a deleted project within 24 hours of deleting it, unless its Free workspace holds its 2 projects already.- `project.erase`: POST /v1/projects/{project_id}/erase, MCP project_erase in project_irreversible. Owner only: erase a deleted project now instead of when its 24 hours run out, with its deploys, env, domains and database.- `env.set`: POST /v1/projects/{project_id}/env, MCP env_set in project_write. Set a project's env var, encrypted at rest. A live server app is redeployed with it at once, without a rebuild, unless deploy is false.- `env.list`: GET /v1/projects/{project_id}/env, MCP env_list in project_read. List a project's env vars. Secrets show their name, never their value.- `env.delete`: DELETE /v1/projects/{project_id}/env/{name}, MCP env_delete in project_irreversible. Delete a project's env var by name. A live server app is redeployed without it, unless deploy is false; deploys made before keep their value for a rollback until the project is erased.- `env.restore`: POST /v1/projects/{project_id}/env/{name}/restore, MCP env_restore in project_write. Undo a var's latest env.set: put back the value it replaced, or delete the var it created. A live server app is redeployed with that, unless deploy is false.- `source.upload`: PUT /v1/projects/{project_id}/sources, MCP source_upload in project_write. Upload a project's code as one zip, stored once by its hash. Only the newest 5 uploads are kept, and uploading one again makes it the newest. The app's files sit at the zip's root, not in a folder: index.html for a static site, or package.json with a start script or main file for a Node app, without node_modules.- `source.delete`: DELETE /v1/projects/{project_id}/sources/{sha256}, MCP source_delete in project_irreversible. Delete a project's upload and its file. source.list gives each upload's sha256.- `github.repository_list`: GET /v1/workspaces/{workspace_id}/github/repositories, MCP github_repository_list in project_read. List the GitHub repositories a workspace linked, which its members reach and gave Scaffold's GitHub App, for github.connect.- `github.connect`: POST /v1/projects/{project_id}/github, MCP github_connect in project_write. Connect a project to a GitHub repository, so each push to its branch deploys. Replaces the repository it followed.- `github.get`: GET /v1/projects/{project_id}/github, MCP github_get in project_read. Show a project's GitHub repository and branch, and its latest pushes with the deploy each started.- `github.branch_set`: PATCH /v1/projects/{project_id}/github, MCP github_branch_set in project_write. Change the branch whose pushes deploy a project connected to GitHub.- `github.release_command_set`: PUT /v1/projects/{project_id}/github/release_command, MCP github_release_command_set in project_write. Set the command, like a migration, that each pushed deploy of a project connected to GitHub runs before it goes live, after a dump of its database. Null for none.- `github.disconnect`: DELETE /v1/projects/{project_id}/github, MCP github_disconnect in project_write. Stop deploying a project from GitHub. Its uploads and deploys stay.- `github.deploy`: POST /v1/projects/{project_id}/github/deploy, MCP github_deploy in project_write. Deploy the head of a connected project's branch now, as a push would. github.get shows the deploy it starts.- `source.list`: GET /v1/projects/{project_id}/sources, MCP source_list in project_read. List a project's uploads of its code, newest first. An upload's sha256 is all deploy.create needs to build it.- `source.file_list`: GET /v1/projects/{project_id}/sources/{sha256}/files, MCP source_file_list in project_read. List the files in one of a project's uploads, by path. source.list or a deploy's source_sha256 gives the hash.- `source.file_get`: GET /v1/projects/{project_id}/sources/{sha256}/file, MCP source_file_get in project_read. Read one file of a project's upload. Text of at most 256 KB comes back whole; a binary or longer file comes back as its kind and size only.- `app_db.get`: GET /v1/projects/{project_id}/database, MCP app_db_get in project_read. Show a project's Postgres database: its state, version, stored size, and DATABASE_URL with the password masked.- `app_db.backup_list`: GET /v1/projects/{project_id}/database/backups, MCP app_db_backup_list in project_read. Paid plan: list a project database's backups, newest first: daily at 03:00 UTC, before each restore and before each deploy's migrations, each kept 6 days. Also its latest restore and dump.- `app_db.backup_restore`: POST /v1/projects/{project_id}/database/backups/{backup_id}/restore, MCP app_db_backup_restore in project_write. Paid plan, owners only: put a backup in place of everything in a project's database, which is read-only from when the restore starts until it ends. Rows written since are lost, so the current data is backed up first as undo_backup_id; restoring that backup undoes this. A restore that fails leaves the database as it was.- `cron.create`: POST /v1/projects/{project_id}/cron-jobs, MCP cron_create in project_write. Paid plan: POST to a path of the project's live app on a cron schedule, waking it if asleep. Each fire runs once, signed by a Scaffold-Signature JWT the project's JWKS verifies. A project sends 2 fires at once and a workspace 8; times that pass while it waits show as one missed fire, and the newest runs.- `cron.list`: GET /v1/projects/{project_id}/cron-jobs, MCP cron_list in project_read. List a project's cron jobs with their next time and newest fires.- `cron.update`: PATCH /v1/cron-jobs/{cron_job_id}, MCP cron_update in project_write. Change a cron job's schedule, timezone or path, or pause and resume it.- `cron.delete`: DELETE /v1/cron-jobs/{cron_job_id}, MCP cron_delete in project_write. Delete a cron job and its fires. It answers the job as it was.- `test_run.start`: POST /v1/projects/{project_id}/test-runs, MCP test_run_start in project_write. Start showing a test run of the project's code in the console, live: the command, who runs it and, when the runner knows, each test file and its test count. Report results with test_run.report as tests finish.- `test_run.report`: POST /v1/test-runs/{test_run_id}/results, MCP test_run_report in project_write. Report tests that finished in a test run's latest attempt, up to 1,000 at once, each with its file, name, status and duration. done ends the attempt. A test reported again in the same attempt replaces its result.- `test_run.fix`: PUT /v1/test-runs/{test_run_id}/fix, MCP test_run_fix in project_write. Show what you are doing to fix a test run's failures, over its graph: the test file, a short note and the files you changed with lines added and removed. Each call replaces the last.- `test_run.rerun`: POST /v1/test-runs/{test_run_id}/reruns, MCP test_run_rerun in project_write. Start the next attempt of a test run once the last ended, of every file or the files named, then report it with test_run.report. A run reruns 19 times at most.- `test_run.list`: GET /v1/projects/{project_id}/test-runs, MCP test_run_list in project_read. List a project's 20 newest test runs with their state and counts.- `test_run.get`: GET /v1/test-runs/{test_run_id}, MCP test_run_get in project_read. Get a test run with every test's result in each attempt, the agent's fix and the files it changed.- `test_run.delete`: DELETE /v1/test-runs/{test_run_id}, MCP test_run_delete in project_irreversible. Delete a test run and every result it holds.- `storage.list`: GET /v1/projects/{project_id}/storage, MCP storage_list in project_read. List the files a project's app stores, by name, or only those whose name starts with prefix, like avatars/.- `storage.usage_get`: GET /v1/workspaces/{workspace_id}/storage, MCP storage_usage_get in project_read. Show what the files of all a workspace's apps take together, and the cap its plan sets on them.- `storage.upload_sign`: POST /v1/projects/{project_id}/storage/upload-url, MCP storage_upload_sign in project_write. Sign a URL that uploads one file of up to 50 MB to a project, for 15 minutes or expires_in_seconds: PUT the bytes to it with their Content-Type, from the app's server or a user's browser. A name a file holds already is refused.- `storage.download_sign`: GET /v1/projects/{project_id}/storage/download-url, MCP storage_download_sign in project_read. Sign a URL that downloads one of a project's files, for 15 minutes or expires_in_seconds, up to a week: link to it or put it in an img tag.- `storage.delete`: DELETE /v1/projects/{project_id}/storage, MCP storage_delete in project_irreversible. Delete a project's stored file by name, so signed URLs answer not found and its bytes no longer count toward the workspace's cap.- `token.create`: POST /v1/tokens, MCP token_create in account_write. Create a token for a workspace, or a test one for your sandbox. Its secret is shown once.- `token.list`: GET /v1/tokens, MCP token_list in account_read. List the tokens of a workspace, revoked ones included, without secrets.- `token.revoke`: DELETE /v1/tokens/{token_id}, MCP token_revoke in account_irreversible. Revoke a token and every token it created, so their next request fails. A member may revoke only their own tokens, an owner any in the workspace.- `oauth.grant_list`: GET /v1/oauth/grants, MCP oauth_grant_list in account_read. List the OAuth apps you approved, and as an owner every app in your workspaces.- `oauth.grant_revoke`: DELETE /v1/oauth/grants/{grant_id}, MCP oauth_grant_revoke in account_irreversible. Revoke an OAuth app you approved, or as an owner any app in your workspace, so its next request fails. oauth.grant_list gives each grant_id.- `credit.balance_get`: GET /v1/workspaces/{workspace_id}/credits, MCP credit_balance_get in billing_read. Show a workspace's credits: balance, held, available and the monthly cap.- `credit.ledger_list`: GET /v1/workspaces/{workspace_id}/credits/ledger, MCP credit_ledger_list in billing_read. List a workspace's latest 200 credit entries, newest first.- `credit.cap_set`: POST /v1/workspaces/{workspace_id}/credits/cap, MCP credit_cap_set in billing_write. Set or remove a workspace's monthly spending cap. Owners only.- `credit.pack_list`: GET /v1/credits/packs, MCP credit_pack_list in billing_read. List the credit packs a top-up can buy, with their prices.- `credit.top_up_start`: POST /v1/workspaces/{workspace_id}/credits/top-ups, MCP credit_top_up_start in billing_irreversible. Buy the credit pack of a Stripe price with the card the plan is paid with. Owners only.- `credit.top_up_get`: GET /v1/workspaces/{workspace_id}/credits/top-ups/{top_up_id}, MCP credit_top_up_get in billing_read. Show whether a top-up was added, failed or still waits for the bank.- `credit.top_up_request`: POST /v1/workspaces/{workspace_id}/credits/top-up-requests, MCP credit_top_up_request in billing_irreversible. Ask the workspace's owners to top up, in their inbox. Members only, once a day.- `credit.top_up_withdraw`: POST /v1/workspaces/{workspace_id}/credits/top-ups/{top_up_id}/withdraw, MCP credit_top_up_withdraw in billing_irreversible. Withdraw from a top-up within 14 days and refund its unused credits, once any dispute ends. Owners only.- `billing.get`: GET /v1/workspaces/{workspace_id}/billing, MCP billing_get in billing_read. Show a workspace's plan, Free or Paid: price, card, renewal or end, a failed renewal's fix-by date, withdrawal deadlines and any unpaid payment page.- `billing.prices_get`: GET /v1/billing/prices, MCP billing_prices_get in billing_read. Show yearly and monthly Paid plan prices before tax, the credits each grants a month (null when it grants none), and the 14-day withdrawal charge per credit.- `billing.subscribe_start`: POST /v1/workspaces/{workspace_id}/billing/subscribe, MCP billing_subscribe_start in billing_write. Open a Stripe payment page for the paid plan, yearly or monthly, which grants nothing before Stripe confirms. Owners only, on the free plan.- `billing.subscribe_cancel`: POST /v1/workspaces/{workspace_id}/billing/subscribe/cancel, MCP billing_subscribe_cancel in billing_irreversible. Give up on the plan's unpaid Stripe payment page, so it can no longer be paid. Owners only.- `billing.cancel`: POST /v1/workspaces/{workspace_id}/billing/cancel, MCP billing_cancel in billing_write. End the Paid plan when its paid period ends. Owners only.- `billing.resume`: POST /v1/workspaces/{workspace_id}/billing/resume, MCP billing_resume in billing_write. Keep a cancelled Paid plan, so it renews again. Owners only, before its period ends.- `billing.portal_open`: POST /v1/workspaces/{workspace_id}/billing/portal, MCP billing_portal_open in billing_irreversible. Open Stripe's billing portal to change or cancel the plan. Owners only, once the workspace subscribed.- `billing.withdraw`: POST /v1/workspaces/{workspace_id}/billing/withdraw, MCP billing_withdraw in billing_irreversible. Withdraw from the paid plan within 14 days of subscribing: cancel it now and refund it, less the credits used if the owner asked to start at once, once any dispute ends. Owners only.- `change.list`: GET /v1/workspaces/{workspace_id}/changes, MCP change_list in workspace_read. List what changed in a workspace, newest first, 100 at a time. Pass the last position you saw as after to catch up oldest first.- `change.command_get`: GET /v1/commands/{command_id}/changes, MCP change_command_get in workspace_read. List the record versions one command made, before and after.- `change.export`: GET /v1/workspaces/{workspace_id}/changes/export, MCP change_export in workspace_read. Export a workspace's changes as CSV. Owners only.- `trash.list`: GET /v1/workspaces/{workspace_id}/trash, MCP trash_list in workspace_read. List what was deleted in a workspace and can still be restored.- `database.create`: POST /v1/workspaces/{workspace_id}/databases, MCP database_create in database_write. Create a database, which keeps a Title field; add each field asked for with field.create.- `database.list`: GET /v1/workspaces/{workspace_id}/databases, MCP database_list in database_read. List a workspace's databases with their fields and option ids.- `database.rename`: POST /v1/databases/{database_id}/rename, MCP database_rename in database_write. Rename a database.- `database.archive`: POST /v1/databases/{database_id}/archive, MCP database_archive in database_write. Archive a database, hiding it from database.list unless include_archived. It is erased after 30 days, and relation fields lose their links to it.- `database.restore`: POST /v1/databases/{database_id}/restore, MCP database_restore in database_write. Restore an archived database.- `field.create`: POST /v1/databases/{database_id}/fields, MCP field_create in database_write. Add a typed field to a database; its kind cannot change later. A select or multi_select takes options, a relation its relation_database_id.- `field.rename`: POST /v1/fields/{field_id}/rename, MCP field_rename in database_write. Rename a field. Record values stay keyed by its id.- `field.options_set`: POST /v1/fields/{field_id}/options, MCP field_options_set in database_write. Set a select or multi_select field's options in order: keep or rename one by id, add one without. One left out is removed, refused while any record holds it, archived ones too.- `field.relation_set`: POST /v1/fields/{field_id}/relation, MCP field_relation_set in database_write. Set the database a relation field links to, refused while records link through it, and two_way: whether that database shows its links back.- `field.archive`: POST /v1/fields/{field_id}/archive, MCP field_archive in database_write. Archive a field, hiding its values. Search stops finding a text field's values within moments.- `field.restore`: POST /v1/fields/{field_id}/restore, MCP field_restore in database_write. Restore an archived field and show its values again. Search finds a text field's values again within moments.- `record.create`: POST /v1/databases/{database_id}/records, MCP record_create in record_write. Add a record to a database, with values keyed by field id.- `record.query`: POST /v1/databases/{database_id}/query, MCP record_query in record_read. Filter, sort and page a database's records.- `record.get`: GET /v1/records/{record_id}, MCP record_get in record_read. Show a record with its version, live field values and subtasks.- `record.update`: POST /v1/records/{record_id}, MCP record_update in record_write. Change a record's values at the version you read.- `record.subtasks_set`: POST /v1/records/{record_id}/subtasks, MCP record_subtasks_set in record_write. Replace a record's subtasks with this checklist.- `record.archive`: POST /v1/records/{record_id}/archive, MCP record_archive in record_write. Archive a record at the version you read.- `record.restore`: POST /v1/records/{record_id}/restore, MCP record_restore in record_write. Restore an archived record at the version you read.- `record.bulk_update`: POST /v1/databases/{database_id}/records/bulk-update, MCP record_bulk_update in record_write. Change records of one database in one command, each update shaped like record.update's input.- `record.bulk_create`: POST /v1/databases/{database_id}/records/bulk-create, MCP record_bulk_create in record_write. Add records to one database in one command.- `record.bulk_archive`: POST /v1/databases/{database_id}/records/bulk-archive, MCP record_bulk_archive in record_write. Archive records of one database in one command.- `record.bulk_restore`: POST /v1/databases/{database_id}/records/bulk-restore, MCP record_bulk_restore in record_write. Restore archived records of one database in one command.- `record.history`: GET /v1/records/{record_id}/history, MCP record_history in record_read. List a record's versions, newest first, 100 at a time, each with who made it, its command_id and each changed field before and after.- `record.undo`: POST /v1/record-commands/{command_id}/undo, MCP record_undo in record_write. Undo one command's record changes by its command_id. Refused as a conflict if any of its records changed since. Undoing an undo redoes it.- `card.move`: POST /v1/records/{record_id}/move, MCP card_move in record_write. Move a record at the version you read, like a board card, after or before another of its database, setting values in the same write. Without after or before it stays put.- `card.assigned_list`: GET /v1/workspaces/{workspace_id}/records/assigned, MCP card_assigned_list in record_read. List a workspace's open or done records that name you in a person field, across its databases.- `task.list`: GET /v1/tasks, MCP task_list in task_read. List a workspace's tasks, newest first.- `task.create`: POST /v1/tasks, MCP task_create in task_write. Add a task. New labels stay after its undo.- `task.update`: PATCH /v1/tasks/{task_id}, MCP task_update in task_write. Change a task's title, assignee or due date; null clears one.- `task.move`: POST /v1/tasks/{task_id}/move, MCP task_move in task_write. Move a task to a column, at a position in it.- `view.create`: POST /v1/databases/{database_id}/views, MCP view_create in view_write. Save a view of a database. A board needs group_by, a timeline its dates, a sprint view its sprint source.- `view.list`: GET /v1/databases/{database_id}/views, MCP view_list in view_read. List a database's views with their settings, oldest first.- `view.update`: POST /v1/views/{view_id}, MCP view_update in view_write. Replace a view's settings; its name stays.- `view.rename`: POST /v1/views/{view_id}/rename, MCP view_rename in view_write. Rename a view.- `view.archive`: POST /v1/views/{view_id}/archive, MCP view_archive in view_write. Archive a view, hiding it from view.list unless include_archived.- `view.restore`: POST /v1/views/{view_id}/restore, MCP view_restore in view_write. Restore an archived view.- `view.record_list`: GET /v1/views/{view_id}/records, MCP view_record_list in view_read. Page a view's records as its settings show them: a board column by group, a timeline from and to, my tasks for you, or the current sprint's records with that sprint.- `page.create`: POST /v1/workspaces/{workspace_id}/pages, MCP page_create in page_write. Create a page in a workspace, or a record's body with record_id.- `page.list`: GET /v1/workspaces/{workspace_id}/pages, MCP page_list in page_read. List a workspace's pages, oldest first, without blocks.- `page.get`: GET /v1/pages/{page_id}, MCP page_get in page_read. Read a page as Markdown, or with format blocks as blocks with stable ids, types, props, styled text and children, which page.edit targets.- `page.rename`: POST /v1/pages/{page_id}/rename, MCP page_rename in page_write. Set a standalone page's title. A record's body has no title, since the record names it.- `page.archive`: POST /v1/pages/{page_id}/archive, MCP page_archive in page_write. Archive a page: it leaves page.list, takes no edits and is erased after 30 days. A record's body goes with its record through record.archive instead.- `page.restore`: POST /v1/pages/{page_id}/restore, MCP page_restore in page_write. Restore an archived page with the content it had.- `page.edit`: POST /v1/pages/{page_id}/edit, MCP page_edit in page_write. Change a page's blocks by id with 1 to 100 ops that insert, update or delete blocks. An edit of over 10 blocks, or with preview true, changes nothing and answers each block before and after with a confirm token; send the same ops with it to apply them. It answers new block ids and the ops that undo it. An edit that could not be undone is refused, like deleting over about 256 KiB at once, so delete big sections in steps.- `page.append`: POST /v1/pages/{page_id}/blocks, MCP page_append in page_write. Add Markdown at the end of a page or after a block. <@usr_...> mentions a member; an image alone in its paragraph adds an image block.- `page.propose`: POST /v1/pages/{page_id}/proposals, MCP page_propose in page_write. Propose a rewrite of a page with ops as page.edit takes them, for a person to accept or discard in the console. Nothing changes until they accept it, so propose rewrites a person should see first.- `page.proposal_get`: GET /v1/pages/{page_id}/proposals/{proposal_id}, MCP page_proposal_get in page_read. Read a proposed rewrite of a page. While it is open it answers the page's blocks now and as accepting it would leave them, or that it is stale since a block it rewrites changed.- `page.proposal_list`: GET /v1/pages/{page_id}/proposals, MCP page_proposal_list in page_read. List the proposed rewrites of a page that wait for a person, oldest first.- `page.proposal_discard`: POST /v1/pages/{page_id}/proposals/{proposal_id}/discard, MCP page_proposal_discard in page_write. Discard a proposed rewrite of a page and leave the page as it is. It answers the proposal's ops, which page.propose takes to propose it again.- `model.list`: GET /v1/models, MCP model_list in run_read. List the models runs may use, their token prices now in millicredits per million, and the price version.- `command.describe`: GET /v1/commands/{name}, MCP command_describe in command_read. Describe a command by its catalog or MCP name: its MCP tool and action, what it does, how to undo it and the JSON schema of its input.- `app_auth.user_list`: GET /v1/projects/{project_id}/auth/users, MCP app_auth_user_list in project_read. List a project's app users in id order, a page at a time, with their status, last sign-in and live sessions, filtered by name or email and status. Counts the matches and all users.- `app_auth.user_show`: GET /v1/projects/{project_id}/auth/users/{user_id}, MCP app_auth_user_show in project_read. Show one app user: status, lock end, sign-up, last sign-in, sign-in methods and, while unconfirmed, when they are deleted.- `app_auth.user_unlock`: POST /v1/projects/{project_id}/auth/users/{user_id}/unlock, MCP app_auth_user_unlock in project_irreversible. Owners only: end the 15-minute lock five wrong passwords put on an app user's email.- `app_auth.user_email_send`: POST /v1/projects/{project_id}/auth/users/{user_id}/email, MCP app_auth_user_email_send in project_irreversible. Email an app user a password reset, or their unconfirmed address's confirmation again. At most one of each a minute, counted like the user's own requests: 3 auth emails an hour per address, and the workspace's monthly quota while the address is unproven.- `app_auth.user_session_list`: GET /v1/projects/{project_id}/auth/users/{user_id}/sessions, MCP app_auth_user_session_list in project_read. List an app user's live sessions with the device and place each signed in from.- `app_auth.user_session_revoke`: DELETE /v1/projects/{project_id}/auth/users/{user_id}/sessions/{session_id}, MCP app_auth_user_session_revoke in project_irreversible. End one of an app user's sessions.- `app_auth.user_sign_out_everywhere`: POST /v1/projects/{project_id}/auth/users/{user_id}/sign-out, MCP app_auth_user_sign_out_everywhere in project_irreversible. End every session of an app user.- `app_auth.sign_in_event_list`: GET /v1/projects/{project_id}/auth/sign-ins, MCP app_auth_sign_in_event_list in project_read. List a project's app sign-in events of the last 90 days, newest first, 100 at a time: sign-ups, sign-ins, wrong passwords, locks, emails and sign-outs, with place and IP.- `app_auth.user_delete`: DELETE /v1/projects/{project_id}/auth/users/{user_id}, MCP app_auth_user_delete in project_irreversible. Owners only: delete an app user. Their email, password and sign-in history are erased and every session ends.- `app_auth.settings_get`: GET /v1/projects/{project_id}/auth/settings, MCP app_auth_settings_get in project_read. Show where a project's auth emails may link to.- `app_auth.settings_update`: POST /v1/projects/{project_id}/auth/settings, MCP app_auth_settings_update in project_write. Replace the site URL a project's auth emails link to and the other URLs they may.- `app_auth.email_usage_get`: GET /v1/projects/{project_id}/auth/email-usage, MCP app_auth_email_usage_get in project_read. Show the emails a project's app queued this month, its workspace's total against the plan's monthly quota, and its hourly email.send limit.- `app_auth.email_suppression_list`: GET /v1/projects/{project_id}/auth/email-suppressions, MCP app_auth_email_suppression_list in project_read. List the addresses a project's app no longer emails, after a bounce, a spam complaint or by hand.- `app_auth.email_suppression_add`: POST /v1/projects/{project_id}/auth/email-suppressions, MCP app_auth_email_suppression_add in project_write. Stop a project's app emailing an address: auth emails and email.send skip it.- `app_auth.email_suppression_remove`: POST /v1/projects/{project_id}/auth/email-suppressions/remove, MCP app_auth_email_suppression_remove in project_write. Let a project's app email a suppressed address again.- `app_auth.sender_get`: GET /v1/projects/{project_id}/auth/sender, MCP app_auth_sender_get in project_read. Show who a project's emails come from: its name beside the address every app sends from.- `email.send`: POST /v1/projects/{project_id}/email, MCP email_send in project_irreversible. Email one person from a project's app, like a receipt or a reminder, with the project's name as the sender. It counts against the workspace's monthly quota and the project's 100 an hour.- `app_payments.connect_start`: POST /v1/projects/{project_id}/payments/connect, MCP app_payments_connect_start in project_write. Link a project's app to a Stripe account its customer owns and answer its setup page. Rerun for a new page.- `app_payments.account_get`: GET /v1/projects/{project_id}/payments/account, MCP app_payments_account_get in project_read. Show if a project's Stripe account can charge and pay out, and what Stripe needs.- `app_payments.revenue_get`: GET /v1/projects/{project_id}/payments/revenue, MCP app_payments_revenue_get in project_read. Show what a project's Stripe account took over 30 days, per currency.- `app_payments.disconnect`: DELETE /v1/projects/{project_id}/payments/account, MCP app_payments_disconnect in project_write. Unlink a project's app from its Stripe account; the customer keeps it.- `app_payments.dashboard_link`: GET /v1/projects/{project_id}/payments/dashboard, MCP app_payments_dashboard_link in project_read. Link to the Stripe Dashboard of a project's Stripe account.- `app_payments.webhook_delivery_list`: GET /v1/projects/{project_id}/payments/deliveries, MCP app_payments_webhook_delivery_list in project_read. List the Stripe events forwarded to a project's app, with each try.- `app_payments.webhook_delivery_resend`: POST /v1/projects/{project_id}/payments/deliveries/{event_id}/resend, MCP app_payments_webhook_delivery_resend in project_irreversible. Forward a Stripe event to a project's app again now.- `realtime.publish`: POST /v1/projects/{project_id}/realtime/channels/{channel}/messages, MCP realtime_publish in project_irreversible. Send JSON to a channel of a project's app, reaching each of its signed-in users subscribed to the channel now. Nothing is stored, so a later subscriber never gets it. Any signed-in user of the app can subscribe to any of its channels, so never publish one user's private data to a guessable channel; per-user private channels are not built yet.- `realtime.channel_list`: GET /v1/projects/{project_id}/realtime/channels, MCP realtime_channel_list in project_read. List the realtime channels of a project's app that its users subscribe to now, with each one's subscriptions and the project's cap.- `run.create`: POST /v1/runs, MCP run_create in run_write. Start a run of an agent. It holds the top of its estimate, or its first model call's cost if more, from the workspace's credits and gives back what it does not spend.- `run.quote`: POST /v1/runs/quote, MCP run_quote in run_read. Price a run: its estimate, what run.create would hold, the credits available and which cap, limit or shortfall would refuse it.- `run.list`: GET /v1/runs, MCP run_list in run_read. List agent runs, newest first.- `run.get`: GET /v1/runs/{run_id}, MCP run_get in run_read. Read an agent run: status, steps with what each spent, credits, approvals and edits an undo keeps.- `run.stop`: POST /v1/runs/{run_id}/stop, MCP run_stop in run_write. Stop a running or waiting run. Its edits stay until run.undo.- `run.approval_list`: GET /v1/workspaces/{workspace_id}/approvals, MCP run_approval_list in run_read. List the changes waiting for your approval: your runs', and every member's for a workspace owner.- `run.deny`: POST /v1/runs/{run_id}/deny, MCP run_deny in run_write. Deny the change a run waits on and stop the run.- `run.resume`: POST /v1/runs/{run_id}/resume, MCP run_resume in run_write. Resume a run stopped by a person, a limit or its credits.- `run.follow_up`: POST /v1/runs/{run_id}/follow-up, MCP run_follow_up in run_write. Ask a done or denied run more; its agent goes on in the same run.- `run.undo`: POST /v1/runs/{run_id}/undo, MCP run_undo in run_irreversible. Take back every edit of an ended run as one change. Refused while run.get lists later edits, unless keep_changed.- `agent.list`: GET /v1/workspaces/{workspace_id}/agents, MCP agent_list in run_read. List a workspace's agents, their settings and whether each is paused or working. Which models agents may use and what they cost is model.list's answer.- `agent.get`: GET /v1/agents/{agent_id}, MCP agent_get in run_read. Read an agent: what it does, may do and asks before doing, and its settings.- `agent.update`: PATCH /v1/agents/{agent_id}, MCP agent_update in run_write. Owners only: change what an agent asks before doing, its default model or its monthly limit in millicredits.- `agent.pause`: POST /v1/agents/{agent_id}/pause, MCP agent_pause in run_write. Owners only: pause an agent. It starts no runs and skips its schedules; runs going now finish.- `agent.resume`: POST /v1/agents/{agent_id}/resume, MCP agent_resume in run_write. Owners only: resume a paused agent. A stopped run resumes by run.resume.- `schedule.list`: GET /v1/workspaces/{workspace_id}/schedules, MCP schedule_list in run_read. List a workspace's schedules, oldest first, with when each runs next.- `schedule.create`: POST /v1/workspaces/{workspace_id}/schedules, MCP schedule_create in run_write. Paid plan: run an agent on a repeating time, as you. A run it cannot start, as while the agent is paused, is skipped.- `schedule.update`: PATCH /v1/schedules/{schedule_id}, MCP schedule_update in run_write. Change a schedule. Only its maker and owners may, and only its maker its prompt or agent, as it runs as them.- `schedule.delete`: DELETE /v1/schedules/{schedule_id}, MCP schedule_delete in run_write. Delete a schedule. Only its maker and owners may.- `schedule.restore`: POST /v1/schedules/{schedule_id}/restore, MCP schedule_restore in run_write. Bring back a deleted schedule.- `schedule.run_now`: POST /v1/schedules/{schedule_id}/run, MCP schedule_run_now in run_write. Start a run of a schedule now, as you, without moving its next run.- `onboarding.get`: GET /v1/workspaces/{workspace_id}/onboarding, MCP onboarding_get in account_read. Show your setup checklist in a workspace and what ticked each step.- `onboarding.step_skip`: POST /v1/workspaces/{workspace_id}/onboarding/{step}/skip, MCP onboarding_step_skip in account_write. Put off a setup step that is not done. It still ticks if it happens.- `onboarding.step_resume`: POST /v1/workspaces/{workspace_id}/onboarding/{step}/resume, MCP onboarding_step_resume in account_write. Bring back a skipped setup step.- `notification.list`: GET /v1/workspaces/{workspace_id}/notifications, MCP notification_list in workspace_read. List your notifications in a workspace, newest first, by unread or source.- `notification.read`: POST /v1/workspaces/{workspace_id}/notifications/read, MCP notification_read in workspace_write. Mark your notifications read, answering those it changed.- `notification.unread`: POST /v1/workspaces/{workspace_id}/notifications/unread, MCP notification_unread in workspace_write. Mark your notifications unread, answering those it changed.- `notification.read_all`: POST /v1/workspaces/{workspace_id}/notifications/read-all, MCP notification_read_all in workspace_write. Mark up to 1000 unread notifications read, newest first, answering them.- `notification.unread_count`: GET /v1/workspaces/{workspace_id}/notifications/unread-count, MCP notification_unread_count in workspace_read. Count your unread notifications, in all and per source.- `notification.preferences_get`: GET /v1/workspaces/{workspace_id}/notifications/preferences, MCP notification_preferences_get in workspace_read. Show how each source reaches you: in app, and by email at 18:00 UTC.- `notification.preferences_set`: POST /v1/workspaces/{workspace_id}/notifications/preferences, MCP notification_preferences_set in workspace_write. Set whether a source reaches you in app and by email.- `search.query`: GET /v1/workspaces/{workspace_id}/search, MCP search_query in workspace_read. Find tasks, records, pages and runs by words or a record key, with counts per kind.- `comment.create`: POST /v1/records/{record_id}/comments, MCP comment_create in record_write. Comment on a record.- `comment.list`: GET /v1/records/{record_id}/comments, MCP comment_list in record_read. List a record's comments, oldest first.- `comment.delete`: DELETE /v1/comments/{comment_id}, MCP comment_delete in record_write. Delete your comment.- `comment.restore`: POST /v1/comments/{comment_id}/restore, MCP comment_restore in record_write. Bring back your deleted comment.- `status.get`: GET /v1/status, MCP status_get in project_read. Show Scaffold's status overall and per component, open incidents, planned maintenance and console notices. Needs no sign-in.- `status.version_get`: GET /v1/version, MCP status_version_get in project_read. Show which build of Scaffold answers: its git commit and when it was built. Needs no sign-in.- `status.incident_list`: GET /v1/status/incidents, MCP status_incident_list in project_read. List incidents and maintenance open in the last 90 days, newest first, with updates. Needs no sign-in.- `status.incident_get`: GET /v1/status/incidents/{incident_id}, MCP status_incident_get in project_read. Show one incident or maintenance window with every update and any write-up. Needs no sign-in.- `deploy.create`: POST /v1/projects/{project_id}/deploys, MCP deploy_create in project_write. Build a project's upload in a sandbox, a Node app or a static site, and put it live once it serves. It needs only the upload's sha256 from source.list, or none for the newest, and answers the deploy with its status and URL. The live deploy stays ready for deploy.rollback. A Node app needs the Paid plan and takes the env as it is now, plus DATABASE_URL; an optional release command runs first, after a dump of the database. A deploy of the project not yet live fails in its favour. package.json "scaffold": {"kind": "worker"} makes a worker: no web page, never sleeps, Paid only.- `deploy.list`: GET /v1/projects/{project_id}/deploys, MCP deploy_list in project_read. List a project's deploys, newest first.- `deploy.recent_list`: GET /v1/workspaces/{workspace_id}/deploys, MCP deploy_recent_list in project_read. List the newest deploy of each project in a workspace, newest first, with its status, so one read shows where every project stands.- `deploy.get`: GET /v1/deploys/{deploy_id}, MCP deploy_get in project_read. Show a deploy and its status: queued, building, starting, live, superseded, rolled_back or failed with its reason.- `deploy.rollback`: POST /v1/deploys/{deploy_id}/rollback, MCP deploy_rollback in project_write. Undo a deploy.create: put an earlier deploy of the project back live, without a rebuild, and its database too with restore_database, which only an owner on the Paid plan may ask. A static site goes back on any plan, a Node app needs the Paid plan. The deploy it replaces can be rolled back to in turn, and a deploy not yet live fails. While the database is put back, the project's address shows the maintenance page.- `domain.add`: POST /v1/projects/{project_id}/domains, MCP domain_add in project_write. Add a custom domain to a project's app. A Free workspace has 1 custom domain; more need the Paid plan. It waits for the DNS records it answers: a CNAME to Scaffold, or an A record at the apex, and a TXT record proving it is yours. Other projects' claims never block it, verified ones included: the project whose records verify the domain takes it from the rest, and a claim that never verifies expires after 7 days.- `domain.list`: GET /v1/projects/{project_id}/domains, MCP domain_list in project_read. List a project's custom domains, oldest first, with where each stands, the DNS records it needs and when its certificate renews.- `domain.check`: POST /v1/domains/{domain_id}/check, MCP domain_check in project_write. Check a custom domain's DNS now. Once it points at Scaffold with its TXT record it is verified: it serves the project's live deploy and gets its certificate on its first visit, other projects' unverified claims on it are removed, and one that held it verified goes back to waiting. A wrong or missing record is named with its fix. Scaffold rechecks verified domains daily: one whose records are gone 3 days goes back to waiting and stops serving. A verified domain whose records point away from Scaffold is marked so, with the problem found, and gets no new certificate until a check finds them pointing back.- `domain.remove`: DELETE /v1/domains/{domain_id}, MCP domain_remove in project_write. Remove a custom domain from its project. The app stops answering there at once, its certificate is deleted within a day and never renewed, and any project can add it again with domain.add.- `deploy.logs`: GET /v1/deploys/{deploy_id}/logs, MCP deploy_logs in project_read. Read a deploy's log a page at a time: its app's output, each line with its time and newest first read, or its build steps. range keeps the last 15m, 1h, 24h or 7d; pass next as after to read on. Over HTTP, follow it as a stream to get each new page as the log grows.- `project.health_get`: GET /v1/projects/{project_id}/health, MCP project_health_get in project_read. Show a project's requests, errors, p95 latency, unavailable requests and downtime per hour over the last 24 hours, all its deploys together.- `project.status_get`: GET /v1/projects/{project_id}/status, MCP project_status_get in project_read. Show whether each deploy a project's host keeps is awake, asleep or exited, with its wakes, sleeps, OOM kills and CPU.- `project.limits_get`: GET /v1/projects/{project_id}/limits, MCP project_limits_get in project_read. Show the CPU, memory, disk, processes and sleep window a project's app runs under on its plan, and what its live deploy uses now.- `webhook.endpoint_create`: POST /v1/projects/{project_id}/webhooks, MCP webhook_endpoint_create in project_write. Register an https endpoint for a project's deploy and app user events. Each is POSTed signed, under an event id to dedupe by. The signing secret is shown once.- `webhook.endpoint_list`: GET /v1/projects/{project_id}/webhooks, MCP webhook_endpoint_list in project_read. List a project's webhook endpoints, oldest first, without secrets.- `webhook.endpoint_update`: PATCH /v1/webhooks/{endpoint_id}, MCP webhook_endpoint_update in project_write. Change a webhook endpoint's URL or event types, or turn it off or on again. It keeps its signing secret.- `webhook.endpoint_delete`: DELETE /v1/webhooks/{endpoint_id}, MCP webhook_endpoint_delete in project_irreversible. Delete a webhook endpoint with its signing secret and delivery log. Nothing more is posted to it.- `webhook.delivery_list`: GET /v1/projects/{project_id}/webhook-deliveries, MCP webhook_delivery_list in project_read. List a project's webhook deliveries of the last 30 days, newest first, with each try and what the endpoint answered.- `webhook.delivery_resend`: POST /v1/webhook-deliveries/{delivery_id}/resend, MCP webhook_delivery_resend in project_irreversible. Try a webhook delivery that has not succeeded again now, with the same event id and body.- `project.alert_get`: GET /v1/projects/{project_id}/alerts, MCP project_alert_get in project_read. Show the error share that alerts a project's owners, 1, 2 or 5%, and the alert firing now with its errors since it started.- `project.alert_set`: PUT /v1/projects/{project_id}/alerts, MCP project_alert_set in project_write. Set the error share over 5 minutes, 1, 2 or 5%, above which a project's owners get an email and an inbox item. Owners only, on the Paid plan.- `project.maintenance_set`: PUT /v1/projects/{project_id}/maintenance, MCP project_maintenance_set in project_write. Turn a project's maintenance mode on or off, as its owner. While on, its address and domains show a maintenance page and its deploys keep running on their own addresses.- `project.move`: POST /v1/projects/{project_id}/move, MCP project_move in project_write. Move a project to another workspace, owning both. Its deploys, domains, env, database with its backups, files, source uploads, logs, cron jobs, webhooks and app users go with it and nothing goes offline. For someone else's workspace, make a claim link. A Free workspace takes no server code and holds 2 projects and 1 custom domain.- `project.credentials_rotate`: POST /v1/projects/{project_id}/credentials/rotate, MCP project_credentials_rotate in project_irreversible. Owners only: give a project's DATABASE_URL a new password and SCAFFOLD_STRIPE_WEBHOOK_SECRET a new value, so copies anyone kept stop working, and redeploy its live server app with them. Sessions opened with the old password end once a deploy with the new one is live, or within an hour. Removing a member and moving the project do this too.- `project.claim_link_create`: POST /v1/projects/{project_id}/claim-link, MCP project_claim_link_create in project_irreversible. Make a claim link for a project you own, in place of any open one. The owner of another workspace who opens it moves the project there, once, within 7 days, with its backups, source uploads and logs. Its secret is answered only once.- `project.claim_link_cancel`: DELETE /v1/projects/{project_id}/claim-link, MCP project_claim_link_cancel in project_irreversible. Cancel a project's open claim link, so it no longer moves the project. ## Optional- [Docs overview](https://scaffold.llc/docs.md): the command map and every resource- [Full docs in one file](https://scaffold.llc/llms-full.txt)