Deploy and share small apps with team login, persistent data, versioned updates and domains.
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Bearer followed by your Boat House account key. Use the account page advanced MCP settings; never publish this value.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
Everyone waiting to be let into one of this workspace's tools: request id, email, tier asked for, and their message. Owners and tool admins.
Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them.
This tool isn't marked read-only, so it may change something on the server or in an account you connected.
Everyone waiting to be let into one of this workspace's tools: request id, email, tier asked for, and their message. Owners and tool admins.
| Argument | Type | Description |
|---|---|---|
| workspace | string | Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them. |
{
"type": "object",
"required": [],
"properties": {
"workspace": {
"type": "string",
"description": "Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them."
}
}
}Let a waiting person in at the tier they asked for. Their tool grant is made and they get an email saying what to do next. Owners and tool admins.
| Argument | Type | Description |
|---|---|---|
| id* | string | The request id from access_requests. |
| workspace | string | Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them. |
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "The request id from access_requests."
},
"workspace": {
"type": "string",
"description": "Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them."
}
}
}The workspace's money: prepaid balance, whether it is paused, how fast running tools burn credit, how many days are left, whether a card is on file, and the last ledger lines.
| Argument | Type | Description |
|---|---|---|
| workspace | string | Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them. |
{
"type": "object",
"required": [],
"properties": {
"workspace": {
"type": "string",
"description": "Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them."
}
}
}Quote additional app storage. Show the maximum extra monthly price and get owner approval before confirming. No automatic upgrade. Owners only.
| Argument | Type | Description |
|---|---|---|
| tool* | string | The tool's short name, for example 'finance', or 'acme/finance' to select its workspace. |
| confirm | boolean | False or absent returns the quote and does nothing. True actually does it. |
| quote_id | string | The exact capacity quote the owner approved. |
| workspace | string | Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them. |
| storage_gb | integer | Requested total storage in whole GB; starts with a price quote. |
| max_extra_monthly_cents | integer | Maximum extra monthly price from the approved quote, in cents. |
{
"type": "object",
"required": [
"tool"
],
"properties": {
"tool": {
"type": "string",
"description": "The tool's short name, for example 'finance', or 'acme/finance' to select its workspace."
},
"confirm": {
"type": "boolean",
"description": "False or absent returns the quote and does nothing. True actually does it."
},
"quote_id": {
"type": "string",
"description": "The exact capacity quote the owner approved."
},
"workspace": {
"type": "string",
"description": "Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them."
},
"storage_gb": {
"type": "integer",
"description": "Requested total storage in whole GB; starts with a price quote."
},
"max_extra_monthly_cents": {
"type": "integer",
"description": "Maximum extra monthly price from the approved quote, in cents."
}
}
}A one-time link where a workspace owner types a card into Stripe. This is the only part of Boathouse that needs a browser. Owners only.
| Argument | Type | Description |
|---|---|---|
| workspace | string | Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them. |
{
"type": "object",
"required": [],
"properties": {
"workspace": {
"type": "string",
"description": "Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them."
}
}
}Delete a tool: its container, its releases and its sharing. By default the tool's database and files are kept. purge true also destroys them forever, and then requires purge_confirm true as well.
| Argument | Type | Description |
|---|---|---|
| tool* | string | The tool's short name, for example 'finance', or 'acme/finance' to select its workspace. |
| purge | boolean | Also destroy the tool's database and uploaded files. Irreversible. |
| workspace | string | Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them. |
| purge_confirm | boolean | Must be true alongside purge, as a second confirmation. |
{
"type": "object",
"required": [
"tool"
],
"properties": {
"tool": {
"type": "string",
"description": "The tool's short name, for example 'finance', or 'acme/finance' to select its workspace."
},
"purge": {
"type": "boolean",
"description": "Also destroy the tool's database and uploaded files. Irreversible."
},
"workspace": {
"type": "string",
"description": "Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them."
},
"purge_confirm": {
"type": "boolean",
"description": "Must be true alongside purge, as a second confirmation."
}
}
}Deploy a folder as a tool and make it live at https://<tool>.<workspace domain>. Send the whole folder in `files`, which MUST include a top-level Dockerfile whose process listens on $PORT (8080). Creates the tool on the first deploy; afterwards it replaces the running container. If you got these files from `pull`, pass the release number you pulled as `base` so a deploy someone else made in the meantime is not silently overwritten.
| Argument | Type | Description |
|---|---|---|
| base | integer | The release number these files were pulled from. The deploy is refused with STALE_BASE if a newer release is live. |
| name | string | Human name for the tool, used when it is created (e.g. 'CRCS Finance'). |
| note | string | Why this release exists; shown in the release list. |
| tool* | string | The tool's short name, for example 'finance', or 'acme/finance' to select its workspace. |
| files* | object | The folder: relative path -> the file's text content, e.g. {"Dockerfile": "FROM python:3.12-slim\n...", "app.py": "..."}. No leading slash and no '..' in paths. |
| base64 | object | Optional binary files: relative path -> base64 of the bytes. |
| workspace | string | Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them. |
Bring a domain the workspace already owns elsewhere: Boathouse starts answering on it and returns the DNS records to make at the current DNS host. Optionally point it at one tool at the same time. Owners only.
| Argument | Type | Description |
|---|---|---|
| tool | string | Optional: the tool the bare domain and www should open. |
| domain* | string | A full domain name you control, e.g. 'crcstools.com'. |
| workspace | string | Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them. |
{
"type": "object",
"required": [
"domain"
],
"properties": {
"tool": {
"type": "string",
"description": "Optional: the tool the bare domain and www should open."
},
"domain": {
"type": "string",
"description": "A full domain name you control, e.g. 'crcstools.com'."
},
"workspace": {
"type": "string",
"description": "Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them."
}
}
}Buy a domain through Boathouse's registrar and point it at this box, paid from the workspace's prepaid balance. Without confirm it only returns the quote (cost now, renewal price, your balance) and buys nothing. Owners only.
| Argument | Type | Description |
|---|---|---|
| domain* | string | The domain to buy, e.g. 'crcstools.com'. |
| confirm | boolean | False or absent returns the quote and does nothing. True actually does it. |
| quote_id | string | The quote_id from the dry run. Required to confirm; reuse it on retries. |
| workspace | string | Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them. |
| max_cost_cents | integer | Maximum approved total, including Boathouse's margin. Required to confirm. |
{
"type": "object",
"required": [
"domain"
],
"properties": {
"domain": {
"type": "string",
"description": "The domain to buy, e.g. 'crcstools.com'."
},
"confirm": {
"type": "boolean",
"description": "False or absent returns the quote and does nothing. True actually does it."
},
"quote_id": {
"type": "string",
"description": "The quote_id from the dry run. Required to confirm; reuse it on retries."
},
"workspace": {
"type": "string",
"description": "Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them."
},
"max_cost_cents": {
"type": "integer",
"minimum": 1,
"description": "Maximum approved total, including Boathouse's margin. Required to confirm."
}
}
}Ask the registrar whether a domain is free and what it costs per year. Buys nothing. total_cents is the price the workspace pays (registrar_cents plus Boathouse's margin_cents); show that one.
| Argument | Type | Description |
|---|---|---|
| domain* | string | A full domain name, e.g. 'crcstools.com'. |
| workspace | string | Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them. |
{
"type": "object",
"required": [
"domain"
],
"properties": {
"domain": {
"type": "string",
"description": "A full domain name, e.g. 'crcstools.com'."
},
"workspace": {
"type": "string",
"description": "Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them."
}
}
}Stop serving a domain. The registration itself is untouched and domain_attach brings it back. Owners only.
| Argument | Type | Description |
|---|---|---|
| domain* | string | A domain the workspace answers on. |
| workspace | string | Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them. |
{
"type": "object",
"required": [
"domain"
],
"properties": {
"domain": {
"type": "string",
"description": "A domain the workspace answers on."
},
"workspace": {
"type": "string",
"description": "Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them."
}
}
}The DNS records the registrar currently holds for a domain Boathouse bought or manages. Changes nothing.
| Argument | Type | Description |
|---|---|---|
| domain* | string | A domain the workspace answers on. |
| workspace | string | Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them. |
{
"type": "object",
"required": [
"domain"
],
"properties": {
"domain": {
"type": "string",
"description": "A domain the workspace answers on."
},
"workspace": {
"type": "string",
"description": "Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them."
}
}
}Make a domain (and its www) open one tool instead of the workspace's tool list. An empty tool clears it. Owners only.
| Argument | Type | Description |
|---|---|---|
| tool | string | The tool to open, or an empty string to show the tool list again. |
| domain* | string | A domain the workspace answers on. |
| workspace | string | Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them. |
{
"type": "object",
"required": [
"domain"
],
"properties": {
"tool": {
"type": "string",
"description": "The tool to open, or an empty string to show the tool list again."
},
"domain": {
"type": "string",
"description": "A domain the workspace answers on."
},
"workspace": {
"type": "string",
"description": "Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them."
}
}
}Make one of the workspace's domains the primary one: the address tool URLs and emails use. Owners only.
| Argument | Type | Description |
|---|---|---|
| domain* | string | A domain the workspace answers on. |
| workspace | string | Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them. |
{
"type": "object",
"required": [
"domain"
],
"properties": {
"domain": {
"type": "string",
"description": "A domain the workspace answers on."
},
"workspace": {
"type": "string",
"description": "Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them."
}
}
}Set automatic renewal and a maximum prepaid renewal charge. Quote the change first, then require explicit approval with confirm true. Turning renewal off lets the domain expire. Owners only.
| Argument | Type | Description |
|---|---|---|
| domain* | string | A domain owned through this organization, including detached domains. |
| confirm | boolean | False or absent returns the quote and does nothing. True actually does it. |
| enabled* | boolean | True renews from prepaid credit; false lets the domain expire. |
| workspace | string | Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them. |
| max_cost_cents | integer | Approved maximum per renewal including the service fee; required when enabling. |
{
"type": "object",
"required": [
"domain",
"enabled"
],
"properties": {
"domain": {
"type": "string",
"description": "A domain owned through this organization, including detached domains."
},
"confirm": {
"type": "boolean",
"description": "False or absent returns the quote and does nothing. True actually does it."
},
"enabled": {
"type": "boolean",
"description": "True renews from prepaid credit; false lets the domain expire."
},
"workspace": {
"type": "string",
"description": "Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them."
},
"max_cost_cents": {
"type": "integer",
"maximum": 100000,
"minimum": 1,
"description": "Approved maximum per renewal including the service fee; required when enabling."
}
}
}Read domain expiry dates, renewal status, spending limits and billing problems. Owners only.
| Argument | Type | Description |
|---|---|---|
| workspace | string | Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them. |
{
"type": "object",
"required": [],
"properties": {
"workspace": {
"type": "string",
"description": "Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them."
}
}
}Rewrite a Boathouse-managed domain's DNS records to point at this Boathouse again (after a move, or if someone changed them). Owners only.
| Argument | Type | Description |
|---|---|---|
| domain* | string | A domain the workspace answers on. |
| workspace | string | Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them. |
{
"type": "object",
"required": [
"domain"
],
"properties": {
"domain": {
"type": "string",
"description": "A domain the workspace answers on."
},
"workspace": {
"type": "string",
"description": "Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them."
}
}
}The addresses this workspace answers on: the free <workspace>.boathousecloud.com address, the primary domain, and every custom domain with its DNS state.
| Argument | Type | Description |
|---|---|---|
| workspace | string | Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them. |
{
"type": "object",
"required": [],
"properties": {
"workspace": {
"type": "string",
"description": "Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them."
}
}
}One tool in detail: URL, container state, current release, who it is visible to, and the list of people it has been shared with.
| Argument | Type | Description |
|---|---|---|
| tool* | string | The tool's short name, for example 'finance', or 'acme/finance' to select its workspace. |
| workspace | string | Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them. |
{
"type": "object",
"required": [
"tool"
],
"properties": {
"tool": {
"type": "string",
"description": "The tool's short name, for example 'finance', or 'acme/finance' to select its workspace."
},
"workspace": {
"type": "string",
"description": "Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them."
}
}
}Every tool in the workspace with its state (running/absent), current release, public URL and who can see it. A 'tool' is one small web app Boathouse runs behind the workspace login.
| Argument | Type | Description |
|---|---|---|
| workspace | string | Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them. |
{
"type": "object",
"required": [],
"properties": {
"workspace": {
"type": "string",
"description": "Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them."
}
}
}The tool container's recent log lines, newest last. Use this to find out why a tool is failing.
| Argument | Type | Description |
|---|---|---|
| tail | integer | How many lines from the end (default 200, max 5000). |
| tool* | string | The tool's short name, for example 'finance', or 'acme/finance' to select its workspace. |
| since | integer | Unix seconds: only lines after this moment. |
| workspace | string | Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them. |
{
"type": "object",
"required": [
"tool"
],
"properties": {
"tail": {
"type": "integer",
"description": "How many lines from the end (default 200, max 5000)."
},
"tool": {
"type": "string",
"description": "The tool's short name, for example 'finance', or 'acme/finance' to select its workspace."
},
"since": {
"type": "integer",
"description": "Unix seconds: only lines after this moment."
},
"workspace": {
"type": "string",
"description": "Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them."
}
}
}What Boathouse charges, in plain words: one organization plan for up to five lightweight tools, shared limits, storage, and the domain margin.
| Argument | Type | Description |
|---|---|---|
| workspace | string | Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them. |
{
"type": "object",
"required": [],
"properties": {
"workspace": {
"type": "string",
"description": "Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them."
}
}
}Fetch the exact source folder a release was built from, so you can edit it and deploy it back. Returns the release number and the files as text (binary files come back base64 encoded). Tool admins only.
| Argument | Type | Description |
|---|---|---|
| tool* | string | The tool's short name, for example 'finance', or 'acme/finance' to select its workspace. |
| release | integer | Which release to fetch. Defaults to the live one. |
| workspace | string | Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them. |
{
"type": "object",
"required": [
"tool"
],
"properties": {
"tool": {
"type": "string",
"description": "The tool's short name, for example 'finance', or 'acme/finance' to select its workspace."
},
"release": {
"type": "integer",
"description": "Which release to fetch. Defaults to the live one."
},
"workspace": {
"type": "string",
"description": "Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them."
}
}
}This person's referral code and link, the deal in words, and what each referred workspace has earned them so far (10% of usage charges, paid monthly in cash).
| Argument | Type | Description |
|---|---|---|
| workspace | string | Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them. |
{
"type": "object",
"required": [],
"properties": {
"workspace": {
"type": "string",
"description": "Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them."
}
}
}The last 20 releases of a tool: number, status (live/superseded/failed), when, who and the note. A failed release shows the last line of its build log.
| Argument | Type | Description |
|---|---|---|
| tool* | string | The tool's short name, for example 'finance', or 'acme/finance' to select its workspace. |
| workspace | string | Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them. |
{
"type": "object",
"required": [
"tool"
],
"properties": {
"tool": {
"type": "string",
"description": "The tool's short name, for example 'finance', or 'acme/finance' to select its workspace."
},
"workspace": {
"type": "string",
"description": "Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them."
}
}
}Ask to be let into a tool in someone else's workspace, at viewer, editor or admin. Its owners get an email with one Allow button; nobody there runs a command. The person is emailed when it is allowed.
| Argument | Type | Description |
|---|---|---|
| tier | string | Default viewer. |
| target* | string | <workspace>/<tool>, for example chloe/db. |
| message | string | One line the owners see, e.g. who you are and why. |
| workspace | string | Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them. |
{
"type": "object",
"required": [
"target"
],
"properties": {
"tier": {
"enum": [
"viewer",
"editor",
"admin"
],
"type": "string",
"description": "Default viewer."
},
"target": {
"type": "string",
"description": "<workspace>/<tool>, for example chloe/db."
},
"message": {
"type": "string",
"description": "One line the owners see, e.g. who you are and why."
},
"workspace": {
"type": "string",
"description": "Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them."
}
}
}Restart the tool's container with its current release and current secrets.
| Argument | Type | Description |
|---|---|---|
| tool* | string | The tool's short name, for example 'finance', or 'acme/finance' to select its workspace. |
| workspace | string | Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them. |
{
"type": "object",
"required": [
"tool"
],
"properties": {
"tool": {
"type": "string",
"description": "The tool's short name, for example 'finance', or 'acme/finance' to select its workspace."
},
"workspace": {
"type": "string",
"description": "Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them."
}
}
}Put an earlier release back in service. With no `to`, goes back to the release before the live one. This rolls back the software, never the database.
| Argument | Type | Description |
|---|---|---|
| to | integer | Release number to restore. Defaults to the previous one. |
| tool* | string | The tool's short name, for example 'finance', or 'acme/finance' to select its workspace. |
| workspace | string | Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them. |
{
"type": "object",
"required": [
"tool"
],
"properties": {
"to": {
"type": "integer",
"description": "Release number to restore. Defaults to the previous one."
},
"tool": {
"type": "string",
"description": "The tool's short name, for example 'finance', or 'acme/finance' to select its workspace."
},
"workspace": {
"type": "string",
"description": "Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them."
}
}
}Remove one secret from a tool. It disappears on the tool's next restart or deploy.
| Argument | Type | Description |
|---|---|---|
| name* | string | The secret's name. |
| tool* | string | The tool's short name, for example 'finance', or 'acme/finance' to select its workspace. |
| workspace | string | Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them. |
{
"type": "object",
"required": [
"tool",
"name"
],
"properties": {
"name": {
"type": "string",
"description": "The secret's name."
},
"tool": {
"type": "string",
"description": "The tool's short name, for example 'finance', or 'acme/finance' to select its workspace."
},
"workspace": {
"type": "string",
"description": "Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them."
}
}
}The names of a tool's secrets (API keys and the like), when each was last set and by whom. Values are never returned.
| Argument | Type | Description |
|---|---|---|
| tool* | string | The tool's short name, for example 'finance', or 'acme/finance' to select its workspace. |
| workspace | string | Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them. |
{
"type": "object",
"required": [
"tool"
],
"properties": {
"tool": {
"type": "string",
"description": "The tool's short name, for example 'finance', or 'acme/finance' to select its workspace."
},
"workspace": {
"type": "string",
"description": "Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them."
}
}
}Set one secret on a tool. It is injected as an environment variable of that name and the tool is restarted. Names are UPPER_SNAKE_CASE. Never echo the value back to the user.
| Argument | Type | Description |
|---|---|---|
| name* | string | UPPER_SNAKE_CASE environment variable name, e.g. STRIPE_KEY. |
| tool* | string | The tool's short name, for example 'finance', or 'acme/finance' to select its workspace. |
| value* | string | The secret value. |
| workspace | string | Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them. |
{
"type": "object",
"required": [
"tool",
"name",
"value"
],
"properties": {
"name": {
"type": "string",
"description": "UPPER_SNAKE_CASE environment variable name, e.g. STRIPE_KEY."
},
"tool": {
"type": "string",
"description": "The tool's short name, for example 'finance', or 'acme/finance' to select its workspace."
},
"value": {
"type": "string",
"description": "The secret value."
},
"workspace": {
"type": "string",
"description": "Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them."
}
}
}Set who a tool is open to by default: 'members' means anyone in the workspace (at the given tier), 'listed' means only the people it has been explicitly shared with. Use 'listed' for anything sensitive.
| Argument | Type | Description |
|---|---|---|
| mode* | string | members (anyone in the workspace), listed (only people shared with), or public (anyone on the internet may read; writes still need sign-in). |
| tier | string | The tier workspace members get when mode is 'members'. |
| tool* | string | The tool's short name, for example 'finance', or 'acme/finance' to select its workspace. |
| workspace | string | Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them. |
{
"type": "object",
"required": [
"tool",
"mode"
],
"properties": {
"mode": {
"enum": [
"members",
"listed",
"public"
],
"type": "string",
"description": "members (anyone in the workspace), listed (only people shared with), or public (anyone on the internet may read; writes still need sign-in)."
},
"tier": {
"enum": [
"viewer",
"editor",
"admin"
],
"type": "string",
"description": "The tier workspace members get when mode is 'members'."
},
"tool": {
"type": "string",
"description": "The tool's short name, for example 'finance', or 'acme/finance' to select its workspace."
},
"workspace": {
"type": "string",
"description": "Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them."
}
}
}Give one person access to one tool by email, at a tier: viewer (read only; the gateway blocks their writes), editor (may change the data), admin (may change the software, secrets, sharing). If the person is new, Boat House emails a secure invitation when email is configured. Check emailed in the result; if delivery failed, share the invitation page so the person can request their secure email.
| Argument | Type | Description |
|---|---|---|
| tier | string | viewer, editor or admin. Default viewer. |
| tool* | string | The tool's short name, for example 'finance', or 'acme/finance' to select its workspace. |
| email* | string | The person's email address. |
| labels | array | Optional app-specific words passed to the tool as headers (e.g. ['consultant']). Labels are not permissions. |
| workspace | string | Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them. |
{
"type": "object",
"required": [
"tool",
"email"
],
"properties": {
"tier": {
"enum": [
"viewer",
"editor",
"admin"
],
"type": "string",
"description": "viewer, editor or admin. Default viewer."
},
"tool": {
"type": "string",
"description": "The tool's short name, for example 'finance', or 'acme/finance' to select its workspace."
},
"email": {
"type": "string",
"description": "The person's email address."
},
"labels": {
"type": "array",
"items": {
"type": "string"
},
"description": "Optional app-specific words passed to the tool as headers (e.g. ['consultant']). Labels are not permissions."
},
"workspace": {
"type": "string",
"description": "Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them."
}
}
}Open secure Stripe checkout to add prepaid hosting credit; the owner completes payment there. Without confirm it only quotes and returns operation_id. Confirm the same cents and operation_id after user approval; reuse the ID on retries. Between $5.00 (500) and $1,000.00 (100000). Owners only.
| Argument | Type | Description |
|---|---|---|
| cents* | integer | Amount in cents, e.g. 2000 for $20.00. |
| confirm | boolean | False or absent returns the quote and does nothing. True actually does it. |
| workspace | string | Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them. |
| operation_id | string | The payment quote ID, required when confirming or retrying. |
{
"type": "object",
"required": [
"cents"
],
"properties": {
"cents": {
"type": "integer",
"description": "Amount in cents, e.g. 2000 for $20.00."
},
"confirm": {
"type": "boolean",
"description": "False or absent returns the quote and does nothing. True actually does it."
},
"workspace": {
"type": "string",
"description": "Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them."
},
"operation_id": {
"type": "string",
"description": "The payment quote ID, required when confirming or retrying."
}
}
}Take away one person's access to one tool. They keep their workspace account.
| Argument | Type | Description |
|---|---|---|
| tool* | string | The tool's short name, for example 'finance', or 'acme/finance' to select its workspace. |
| email* | string | The person's email address. |
| workspace | string | Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them. |
{
"type": "object",
"required": [
"tool",
"email"
],
"properties": {
"tool": {
"type": "string",
"description": "The tool's short name, for example 'finance', or 'acme/finance' to select its workspace."
},
"email": {
"type": "string",
"description": "The person's email address."
},
"workspace": {
"type": "string",
"description": "Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them."
}
}
}Check storage, memory, CPU and the reason an app is paused. Tool admins only.
| Argument | Type | Description |
|---|---|---|
| tool* | string | The tool's short name, for example 'finance', or 'acme/finance' to select its workspace. |
| workspace | string | Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them. |
{
"type": "object",
"required": [
"tool"
],
"properties": {
"tool": {
"type": "string",
"description": "The tool's short name, for example 'finance', or 'acme/finance' to select its workspace."
},
"workspace": {
"type": "string",
"description": "Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them."
}
}
}Add a person to the workspace, or change their role. owner = may spend money, buy domains and manage people, and is admin on every tool; member = may see tools open to members and deploy their own; guest = sees only what is explicitly shared with them. Returns a one-time invite link for someone new. Owners only.
| Argument | Type | Description |
|---|---|---|
| role | string | Default member. |
| email* | string | The person's email address. |
| workspace | string | Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them. |
{
"type": "object",
"required": [
"email"
],
"properties": {
"role": {
"enum": [
"member",
"owner",
"guest"
],
"type": "string",
"description": "Default member."
},
"email": {
"type": "string",
"description": "The person's email address."
},
"workspace": {
"type": "string",
"description": "Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them."
}
}
}Resend an invitation to someone in the workspace. New accounts confirm their mailbox through the emailed link; established accounts receive a normal sign-in URL. Password recovery is self-service on that page, and only the account holder's mailbox receives a reset link. Check emailed before offering a fallback.
| Argument | Type | Description |
|---|---|---|
| email* | string | The person's email address. |
| workspace | string | Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them. |
{
"type": "object",
"required": [
"email"
],
"properties": {
"email": {
"type": "string",
"description": "The person's email address."
},
"workspace": {
"type": "string",
"description": "Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them."
}
}
}Everyone in the workspace: role (owner, member or guest), name, and whether they have set a password yet.
| Argument | Type | Description |
|---|---|---|
| workspace | string | Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them. |
{
"type": "object",
"required": [],
"properties": {
"workspace": {
"type": "string",
"description": "Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them."
}
}
}Remove a person from the workspace. Their sessions, project keys, invites and tool grants stop working immediately. Owners only.
| Argument | Type | Description |
|---|---|---|
| email* | string | The person's email address. |
| workspace | string | Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them. |
{
"type": "object",
"required": [
"email"
],
"properties": {
"email": {
"type": "string",
"description": "The person's email address."
},
"workspace": {
"type": "string",
"description": "Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them."
}
}
}Who this project key belongs to: the email, the workspace, the domain its tools live on, and the prepaid balance. Call it first if you are not sure which workspace you are acting in.
| Argument | Type | Description |
|---|---|---|
| workspace | string | Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them. |
{
"type": "object",
"required": [],
"properties": {
"workspace": {
"type": "string",
"description": "Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them."
}
}
}{
"type": "object",
"required": [
"tool",
"files"
],
"properties": {
"base": {
"type": "integer",
"description": "The release number these files were pulled from. The deploy is refused with STALE_BASE if a newer release is live."
},
"name": {
"type": "string",
"description": "Human name for the tool, used when it is created (e.g. 'CRCS Finance')."
},
"note": {
"type": "string",
"description": "Why this release exists; shown in the release list."
},
"tool": {
"type": "string",
"description": "The tool's short name, for example 'finance', or 'acme/finance' to select its workspace."
},
"files": {
"type": "object",
"description": "The folder: relative path -> the file's text content, e.g. {\"Dockerfile\": \"FROM python:3.12-slim\\n...\", \"app.py\": \"...\"}. No leading slash and no '..' in paths.",
"additionalProperties": {
"type": "string"
}
},
"base64": {
"type": "object",
"description": "Optional binary files: relative path -> base64 of the bytes.",
"additionalProperties": {
"type": "string"
}
},
"workspace": {
"type": "string",
"description": "Workspace slug to act in. Use this when you belong to several workspaces; whoami lists them."
}
}
}