Let an agent or a terminal edit a slate.
The slatebox command and a local MCP server with 17 tools work on the slates in your account, with the permissions of the account that issued the token. A change is previewed before it is saved, and a teammate can open the slate and answer on it.
Any registered account
The button opens a private slate with the three steps this replay starts from, drawn from one typed line. The share ID the commands take is the part of its address after /canvas/.
$ npx --no-install slatebox read \
"$SLATEBOX_SHARE_ID"
# the slate’s shareId and a summary of it
$ npx --no-install slatebox preview \
"$SLATEBOX_SHARE_ID" \
retention-question.json
# the operation report: one note would be
# added. Nothing is saved.
$ edit_key=$(node -p 'crypto.randomUUID()')
npx --no-install slatebox apply \
"$SLATEBOX_SHARE_ID" \
retention-question.json \
--idempotency-key "$edit_key"
# the saved result as JSON
$ npx --no-install slatebox read \
"$SLATEBOX_SHARE_ID" --full
# the full slate, with the answer Dev added
A slate shows three steps of an upload review. From a terminal an engineer reads the slate, previews a plan that adds one note, and applies it with an idempotency key. The note “Who owns deletion of the retained copy?” is saved on the slate. Dev opens the slate, joins the question to “Keep a copy for 30 days” and adds the answer beside it: “Data team, weekly job”. The terminal reads the slate again and has the answer.
How it works
A token, one package, two commands.
The package holds both executables: slatebox for a shell and slatebox-mcp for an MCP client. It needs Node.js 20 or later.
Create a token
In the app, open Profile, then Developer access. “Read slates” and “Create and edit slates” are ticked by default. Load the token into
SLATEBOX_API_TOKENfrom your secret manager.Install the tools
Download the package and its checksum from the docs, check one against the other, and install it in your project.
Terminal download=https://docs.slatebox.com/assets/downloads package=slatebox-mcp-0.2.6.tgz curl -fsSLO "$download/$package" curl -fsSLO "$download/$package.sha256" shasum -a 256 -c "$package.sha256" \ && npm install "./$package"Point your agent at it
An MCP client starts the server as a local process over standard input and output, and passes the token through its secret settings.
MCP client settings { "mcpServers": { "slatebox": { "command": "/absolute/path/to/project/ node_modules/.bin/slatebox-mcp" } } }
The MCP server
The 17 tools.
Every tool that edits takes dry_run. Leave it on and the reply is a report. Set it to false with an idempotency_key and the edit is saved once, however often the call is retried.
- Slates
- create_slate
- get_slate
- update_slate
- apply_slate_operations
Create a private diagram or decision map from a brief, read it, and apply a plan of several operations at once.
- Notes and arrows
- add_nodes
- update_nodes
- delete_nodes
- connect_nodes
- disconnect_nodes
- update_connections
- arrange_nodes
The same edits a person makes with a pointer, addressed by note id.
- Workshops and maps
- move_workshop_card
- add_map_branch
- update_map_outcome
- set_presentation_order
move_workshop_cardreads the same rules as the app, so a move the board would refuse is refused here too.- Sharing
- create_slate_invite
- revoke_slate_invite
Issue or withdraw the slate’s unlisted invitation link with a read, comment or edit role. Needs the
slates:sharescope.
The command line
Ten verbs in a shell.
A plan is a small JSON file: a message and a list of operations. preview returns the report and leaves the slate untouched. apply saves it. Pass - in place of the file name to read the plan from a pipe.
{
"message": "Add a question for the architecture review",
"operations": [
{ "kind": "add_nodes", "count": 1,
"shape": "rectangle",
"text": "Who owns deletion of the retained copy?" }
]
}| Command | What it does |
|---|---|
create | Saves a private decision map from a one-line brief. With --kind diagram it draws connected steps instead. |
read | Prints a summary of a slate, or all of it with --full. |
preview · apply | Reports what a plan file would change, then saves it. |
branch · outcome | Adds a station to a map with its arrival text, or changes the text at a station. |
move | Moves a card to a lane, under the rules of the workshop. |
order | Sets the order of a workshop’s presentation scenes. |
share · unshare | Creates or withdraws the slate’s unlisted invitation link. |
The map and workshop commands preview by default. To save, add --apply, the revision from the preview and a fresh idempotency key.
The plan this needs.
- Free
- Any registered account can create a personal token, the free plan included, and hold up to 10 active tokens. A brief of typed steps is drawn as connected notes.
- Pro and Team
- Nothing more is needed for this.
Next
More ways to build on it.
Give your agent the guide.
Every guide in the docs is also published as Markdown with a task to follow, listed in one index.