MCP Tools Reference
Moira exposes workflow execution capabilities through MCP tools. The catalog below is the authoritative reference for tool names, actions, input schemas, and valid example inputs. The documentation build reads the same pure typed contract used by MCP registration and runtime help directly.
Tool descriptions and their supported agent/model variants are static parts of this catalog and cannot be overridden through database settings. Runtime system instructions are delivered separately through MCP initialization and never alter a tool description.
The server checks the tool-contract revision accepted by the authenticated MCP connection.
HTTP 426 upgrade_required requires reconnecting or reinitializing that connection to refresh
its tools. Successful MCP initialization accepts the current catalog for that credential;
reading help or calling an old tool does not bypass the check.
MCP tools
codespace
List actionable owned workspaces for one provider; explicitly select diagnostics or history for retained unavailable or deleted identities. Other providers and billing are not awaited. Discover repository targets and registered controllers for new work at one selected provider. Observe a workspace and return a fresh reference for a deliberate next action. Create one workspace from a returned target and branch. Start, stop or resume incomplete Local or GitHub setup using the captured workspace reference. Prepare an observed GitHub workspace at the explicitly selected registered controller. Permanently delete exactly the confirmed workspace observation. Explain the current missing setup requirement without provisioning. Explicitly prepare an owned external GitHub environment at its selected controller. Request owner-approved admission of a verified GitHub repository. Create a private repository under the selected installation and owner consent. Explicitly continue a retained private-repository setup using only its original repository-create handle; never rerun commands or create another repository. Collect the original operation or process without resubmitting any effect. Discover original owner receipts; ambiguous candidates are never selected or replayed automatically.
Actions: list, targets, observe, create, lifecycle, adopt, delete, setup_help, adopt_external, repository_admit, repository_create, resume, collect, find.
Input schema
{
"anyOf": [
{
"type": "object",
"properties": {
"provider": {
"type": "string",
"enum": [
"local-sandboxes",
"github-codespaces"
]
},
"view": {
"type": "string",
"enum": [
"actionable",
"diagnostics",
"history"
]
},
"action": {
"type": "string",
"const": "list"
}
},
"required": [
"provider",
"action"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"provider": {
"type": "string",
"enum": [
"local-sandboxes",
"github-codespaces"
]
},
"action": {
"type": "string",
"const": "targets"
}
},
"required": [
"provider",
"action"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"workspace": {
"type": "string",
"description": "Copy the returned workspace or workspace-identity reference; never manufacture or refresh it"
},
"action": {
"type": "string",
"const": "observe"
}
},
"required": [
"workspace",
"action"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"target": {
"type": "string",
"description": "Copy the returned target reference; never manufacture or refresh it"
},
"branch": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"devcontainer_path": {
"type": "string",
"minLength": 1,
"maxLength": 4096,
"description": "Path relative to the selected workspace repository root, for example moira-ws/task/file.md. File tools reject absolute paths, parent traversal and symlinks; use '.' for directory operations at the root"
},
"action": {
"type": "string",
"const": "create"
}
},
"required": [
"target",
"branch",
"action"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "lifecycle"
},
"workspace": {
"type": "string",
"description": "Copy the returned workspace reference; never manufacture or refresh it"
},
"operation": {
"type": "string",
"enum": [
"start",
"stop",
"resume_setup"
]
}
},
"required": [
"action",
"workspace",
"operation"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"workspace": {
"type": "string",
"description": "Copy the returned workspace reference; never manufacture or refresh it"
},
"controller": {
"type": "string",
"description": "Copy the returned controller reference; never manufacture or refresh it"
},
"action": {
"type": "string",
"const": "adopt"
}
},
"required": [
"workspace",
"controller",
"action"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"workspace": {
"type": "string",
"description": "Copy the returned workspace reference; never manufacture or refresh it"
},
"confirm_delete": {
"type": "boolean",
"const": true
},
"action": {
"type": "string",
"const": "delete"
}
},
"required": [
"workspace",
"confirm_delete",
"action"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"target": {
"type": "string",
"description": "Copy the returned target reference; never manufacture or refresh it"
},
"action": {
"type": "string",
"const": "setup_help"
}
},
"required": [
"action"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"controller": {
"type": "string",
"description": "Copy the returned controller reference; never manufacture or refresh it"
},
"name": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9-]*$"
},
"action": {
"type": "string",
"const": "adopt_external"
}
},
"required": [
"controller",
"name",
"action"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"controller": {
"type": "string",
"description": "Copy the returned controller reference; never manufacture or refresh it"
},
"repository": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
},
"action": {
"type": "string",
"const": "repository_admit"
}
},
"required": [
"controller",
"repository",
"action"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"controller": {
"type": "string",
"description": "Copy the returned controller reference; never manufacture or refresh it"
},
"installation": {
"type": "string",
"description": "Copy the returned installation reference; never manufacture or refresh it"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[A-Za-z0-9_.-]+$"
},
"action": {
"type": "string",
"const": "repository_create"
}
},
"required": [
"controller",
"installation",
"name",
"action"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"reference": {
"type": "string",
"description": "Copy the returned operation reference; never manufacture or refresh it"
},
"action": {
"type": "string",
"const": "resume"
}
},
"required": [
"reference",
"action"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"reference": {
"type": "string",
"description": "Copy the returned operation or process reference; never manufacture or refresh it"
},
"action": {
"type": "string",
"const": "collect"
}
},
"required": [
"reference",
"action"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"owner": {
"type": "string",
"description": "Copy the returned workspace or controller reference; never manufacture or refresh it"
},
"kind": {
"type": "string",
"enum": [
"command",
"file-change",
"lifecycle",
"repository",
"pull-request",
"delivery",
"session",
"unknown"
]
},
"query": {
"type": "string"
},
"cursor": {
"type": "string",
"minLength": 1
},
"action": {
"type": "string",
"const": "find"
}
},
"required": [
"owner",
"action"
],
"additionalProperties": false
}
],
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object"
}Result: Owner-produced data, native content or original operation references; unavailable observation does not prove absence. Owner-produced data, native content or original operation references; unavailable observation does not prove absence. Owner-produced data, native content or original operation references; unavailable observation does not prove absence. Owner-produced data, native content or original operation references; unavailable observation does not prove absence. Owner-produced data, native content or original operation references; unavailable observation does not prove absence. Owner-produced data, native content or original operation references; unavailable observation does not prove absence. Owner-produced data, native content or original operation references; unavailable observation does not prove absence. Owner-produced data, native content or original operation references; unavailable observation does not prove absence. Owner-produced data, native content or original operation references; unavailable observation does not prove absence. Owner-produced data, native content or original operation references; unavailable observation does not prove absence. Owner-produced data, native content or original operation references; unavailable observation does not prove absence. Owner-produced data, native content or original operation references; unavailable observation does not prove absence. Owner-produced data, native content or original operation references; unavailable observation does not prove absence. Owner-produced data, native content or original operation references; unavailable observation does not prove absence.
{
"action": "list",
"provider": "local-sandboxes"
}{
"action": "targets",
"provider": "local-sandboxes"
}{
"action": "observe",
"workspace": "moira-workspace:v1:eyJnZW5lcmF0aW9uIjoxLCJwcm92aWRlciI6ImdpdGh1Yi1jb2Rlc3BhY2VzIiwicmVzb3VyY2VJZCI6IjAwMDAwMDAwLTAwMDAtNDAwMC04MDAwLTAwMDAwMDAwMDAwMSJ9"
}{
"action": "create",
"target": "moira-target:v1:eyJjb250cm9sbGVyIjp7ImNvbm5lY3Rpb25JZCI6IjAwMDAwMDAwLTAwMDAtNDAwMC04MDAwLTAwMDAwMDAwMDAwMSIsImRldmljZUlkIjoiMDAwMDAwMDAtMDAwMC00MDAwLTgwMDAtMDAwMDAwMDAwMDAxIn0sInByb3ZpZGVyIjoiZ2l0aHViLWNvZGVzcGFjZXMiLCJyZXBvc2l0b3J5SWQiOiI0MiJ9",
"branch": "main"
}{
"action": "lifecycle",
"workspace": "moira-workspace:v1:eyJnZW5lcmF0aW9uIjoxLCJwcm92aWRlciI6ImdpdGh1Yi1jb2Rlc3BhY2VzIiwicmVzb3VyY2VJZCI6IjAwMDAwMDAwLTAwMDAtNDAwMC04MDAwLTAwMDAwMDAwMDAwMSJ9",
"operation": "start"
}{
"action": "adopt",
"workspace": "moira-workspace:v1:eyJnZW5lcmF0aW9uIjoxLCJwcm92aWRlciI6ImdpdGh1Yi1jb2Rlc3BhY2VzIiwicmVzb3VyY2VJZCI6IjAwMDAwMDAwLTAwMDAtNDAwMC04MDAwLTAwMDAwMDAwMDAwMSJ9",
"controller": "moira-controller:v1:eyJjb25uZWN0aW9uSWQiOiIwMDAwMDAwMC0wMDAwLTQwMDAtODAwMC0wMDAwMDAwMDAwMDEiLCJkZXZpY2VJZCI6IjAwMDAwMDAwLTAwMDAtNDAwMC04MDAwLTAwMDAwMDAwMDAwMSJ9"
}{
"action": "delete",
"workspace": "moira-workspace:v1:eyJnZW5lcmF0aW9uIjoxLCJwcm92aWRlciI6ImdpdGh1Yi1jb2Rlc3BhY2VzIiwicmVzb3VyY2VJZCI6IjAwMDAwMDAwLTAwMDAtNDAwMC04MDAwLTAwMDAwMDAwMDAwMSJ9",
"confirm_delete": true
}{
"action": "setup_help"
}{
"action": "adopt_external",
"controller": "moira-controller:v1:eyJjb25uZWN0aW9uSWQiOiIwMDAwMDAwMC0wMDAwLTQwMDAtODAwMC0wMDAwMDAwMDAwMDEiLCJkZXZpY2VJZCI6IjAwMDAwMDAwLTAwMDAtNDAwMC04MDAwLTAwMDAwMDAwMDAwMSJ9",
"name": "existing-environment"
}{
"action": "repository_admit",
"controller": "moira-controller:v1:eyJjb25uZWN0aW9uSWQiOiIwMDAwMDAwMC0wMDAwLTQwMDAtODAwMC0wMDAwMDAwMDAwMDEiLCJkZXZpY2VJZCI6IjAwMDAwMDAwLTAwMDAtNDAwMC04MDAwLTAwMDAwMDAwMDAwMSJ9",
"repository": "42"
}{
"action": "repository_create",
"controller": "moira-controller:v1:eyJjb25uZWN0aW9uSWQiOiIwMDAwMDAwMC0wMDAwLTQwMDAtODAwMC0wMDAwMDAwMDAwMDEiLCJkZXZpY2VJZCI6IjAwMDAwMDAwLTAwMDAtNDAwMC04MDAwLTAwMDAwMDAwMDAwMSJ9",
"installation": "moira-installation:v1:eyJjb250cm9sbGVyIjp7ImNvbm5lY3Rpb25JZCI6IjAwMDAwMDAwLTAwMDAtNDAwMC04MDAwLTAwMDAwMDAwMDAwMSIsImRldmljZUlkIjoiMDAwMDAwMDAtMDAwMC00MDAwLTgwMDAtMDAwMDAwMDAwMDAxIn0sImluc3RhbGxhdGlvbklkIjoiNDIifQ",
"name": "new-project"
}{
"action": "resume",
"reference": "moira-operation:v1:eyJqb3VybmFsIjoicmVwb3NpdG9yeS1jcmVhdGUiLCJraW5kIjoicmVwb3NpdG9yeSIsIm93bmVyIjp7ImNvbm5lY3Rpb25JZCI6IjAwMDAwMDAwLTAwMDAtNDAwMC04MDAwLTAwMDAwMDAwMDAwMSIsImRldmljZUlkIjoiMDAwMDAwMDAtMDAwMC00MDAwLTgwMDAtMDAwMDAwMDAwMDAxIiwia2luZCI6ImNvbnRyb2xsZXIifSwicmVxdWVzdElkIjoid3MxLTAwMDAwMDAwLTAwMDAtNDAwMC04MDAwLTAwMDAwMDAwMDAwMSJ9"
}{
"action": "collect",
"reference": "moira-process:v1:eyJvd25lciI6eyJraW5kIjoiZ2l0aHViIiwicmVzb3VyY2VJZCI6IjAwMDAwMDAwLTAwMDAtNDAwMC04MDAwLTAwMDAwMDAwMDAwMSJ9LCJyZXF1ZXN0SWQiOiJ3czEtMDAwMDAwMDAtMDAwMC00MDAwLTgwMDAtMDAwMDAwMDAwMDAxIn0"
}{
"action": "find",
"owner": "moira-workspace:v1:eyJnZW5lcmF0aW9uIjoxLCJwcm92aWRlciI6ImdpdGh1Yi1jb2Rlc3BhY2VzIiwicmVzb3VyY2VJZCI6IjAwMDAwMDAwLTAwMDAtNDAwMC04MDAwLTAwMDAwMDAwMDAwMSJ9",
"kind": "command"
}codespace_terminal
Run argv or a script; return original operation/process references without a default execution deadline. Run a command with required native-file stdin, never mixed with text stdin. Read original process output with complete-character continuation. Cancel only the process addressed by its returned reference. Close a named workspace session. Collect the original operation or process without resubmitting any effect. Discover original owner receipts; ambiguous candidates are never selected or replayed automatically.
Actions: run, run_native, output, stop, close, collect, find.
Input schema
{
"anyOf": [
{
"type": "object",
"properties": {
"workspace": {
"type": "string",
"description": "Copy the returned workspace reference; never manufacture or refresh it"
},
"command": {
"anyOf": [
{
"type": "object",
"properties": {
"argv": {
"type": "array",
"items": {
"type": "string"
},
"minItems": 1
}
},
"required": [
"argv"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"script": {
"type": "string",
"minLength": 1
}
},
"required": [
"script"
],
"additionalProperties": false
}
]
},
"session": {
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$"
},
"mode": {
"type": "string",
"enum": [
"open",
"continue"
]
}
},
"required": [
"name",
"mode"
],
"additionalProperties": false
},
"cwd": {
"type": "string",
"minLength": 1,
"maxLength": 4096,
"description": "Working directory inside the selected workspace repository; defaults to '.'. Prefer a repository-relative directory such as moira-ws/task. A directory created elsewhere in the VM cannot be used as cwd or accessed through workspace file tools"
},
"env": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"propertyNames": {
"pattern": "^[A-Za-z_][A-Za-z0-9_]*$"
}
},
"background": {
"type": "boolean"
},
"timeout_seconds": {
"type": "integer",
"exclusiveMinimum": 0,
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"max_stdout_bytes": {
"type": "integer",
"exclusiveMinimum": 0,
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"max_stderr_bytes": {
"type": "integer",
"exclusiveMinimum": 0,
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"stdin_text": {
"type": "string"
},
"action": {
"type": "string",
"const": "run"
}
},
"required": [
"workspace",
"command",
"action"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"workspace": {
"type": "string",
"description": "Copy the returned workspace reference; never manufacture or refresh it"
},
"command": {
"anyOf": [
{
"type": "object",
"properties": {
"argv": {
"type": "array",
"items": {
"type": "string"
},
"minItems": 1
}
},
"required": [
"argv"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"script": {
"type": "string",
"minLength": 1
}
},
"required": [
"script"
],
"additionalProperties": false
}
]
},
"session": {
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$"
},
"mode": {
"type": "string",
"enum": [
"open",
"continue"
]
}
},
"required": [
"name",
"mode"
],
"additionalProperties": false
},
"cwd": {
"type": "string",
"minLength": 1,
"maxLength": 4096,
"description": "Working directory inside the selected workspace repository; defaults to '.'. Prefer a repository-relative directory such as moira-ws/task. A directory created elsewhere in the VM cannot be used as cwd or accessed through workspace file tools"
},
"env": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"propertyNames": {
"pattern": "^[A-Za-z_][A-Za-z0-9_]*$"
}
},
"background": {
"type": "boolean"
},
"timeout_seconds": {
"type": "integer",
"exclusiveMinimum": 0,
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"max_stdout_bytes": {
"type": "integer",
"exclusiveMinimum": 0,
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"max_stderr_bytes": {
"type": "integer",
"exclusiveMinimum": 0,
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"stdin_file": {},
"action": {
"type": "string",
"const": "run_native"
}
},
"required": [
"workspace",
"command",
"stdin_file",
"action"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"process": {
"type": "string",
"description": "Copy the returned process reference; never manufacture or refresh it"
},
"stream": {
"type": "string",
"enum": [
"stdout",
"stderr"
]
},
"cursor": {
"type": "string",
"description": "Copy the returned output-cursor reference; never manufacture or refresh it"
},
"max_bytes": {
"type": "integer",
"exclusiveMinimum": 0,
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"action": {
"type": "string",
"const": "output"
}
},
"required": [
"process",
"stream",
"action"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"process": {
"type": "string",
"description": "Copy the returned process reference; never manufacture or refresh it"
},
"action": {
"type": "string",
"const": "stop"
}
},
"required": [
"process",
"action"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"workspace": {
"type": "string",
"description": "Copy the returned workspace reference; never manufacture or refresh it"
},
"name": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$"
},
"action": {
"type": "string",
"const": "close"
}
},
"required": [
"workspace",
"name",
"action"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"reference": {
"type": "string",
"description": "Copy the returned operation or process reference; never manufacture or refresh it"
},
"action": {
"type": "string",
"const": "collect"
}
},
"required": [
"reference",
"action"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"owner": {
"type": "string",
"description": "Copy the returned workspace or controller reference; never manufacture or refresh it"
},
"kind": {
"type": "string",
"enum": [
"command",
"file-change",
"lifecycle",
"repository",
"pull-request",
"delivery",
"session",
"unknown"
]
},
"query": {
"type": "string"
},
"cursor": {
"type": "string",
"minLength": 1
},
"action": {
"type": "string",
"const": "find"
}
},
"required": [
"owner",
"action"
],
"additionalProperties": false
}
],
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"stdin_file": {
"type": "object",
"properties": {
"file_id": {
"type": "string",
"maxLength": 512,
"pattern": "^(?:sediment:\\/\\/)?file_[A-Za-z0-9]+$"
},
"download_url": {
"type": "string",
"format": "uri"
},
"file_name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"mime_type": {
"type": "string",
"maxLength": 127,
"pattern": "^[a-z0-9][a-z0-9!#$&^_.+-]*\\/[a-z0-9][a-z0-9!#$&^_.+-]*$"
},
"size_bytes": {
"type": "integer",
"minimum": 0
}
},
"required": [
"file_id",
"download_url"
],
"additionalProperties": false,
"description": "Native ChatGPT reference acquired by the workspace owner; pass it without base64. Source refusal before admission is confirmed, not a lost accepted mutation"
}
},
"type": "object"
}Result: Owner-produced data, native content or original operation references; unavailable observation does not prove absence. Owner-produced data, native content or original operation references; unavailable observation does not prove absence. Owner-produced data, native content or original operation references; unavailable observation does not prove absence. Owner-produced data, native content or original operation references; unavailable observation does not prove absence. Owner-produced data, native content or original operation references; unavailable observation does not prove absence. Owner-produced data, native content or original operation references; unavailable observation does not prove absence. Owner-produced data, native content or original operation references; unavailable observation does not prove absence.
{
"action": "run",
"workspace": "moira-workspace:v1:eyJnZW5lcmF0aW9uIjoxLCJwcm92aWRlciI6ImdpdGh1Yi1jb2Rlc3BhY2VzIiwicmVzb3VyY2VJZCI6IjAwMDAwMDAwLTAwMDAtNDAwMC04MDAwLTAwMDAwMDAwMDAwMSJ9",
"command": {
"argv": [
"git",
"status",
"--short"
]
}
}{
"action": "run_native",
"workspace": "moira-workspace:v1:eyJnZW5lcmF0aW9uIjoxLCJwcm92aWRlciI6ImdpdGh1Yi1jb2Rlc3BhY2VzIiwicmVzb3VyY2VJZCI6IjAwMDAwMDAwLTAwMDAtNDAwMC04MDAwLTAwMDAwMDAwMDAwMSJ9",
"command": {
"argv": [
"cat"
]
},
"stdin_file": {
"file_id": "file_Example",
"download_url": "https://files.oaiusercontent.com/example"
}
}{
"action": "output",
"process": "moira-process:v1:eyJvd25lciI6eyJraW5kIjoiZ2l0aHViIiwicmVzb3VyY2VJZCI6IjAwMDAwMDAwLTAwMDAtNDAwMC04MDAwLTAwMDAwMDAwMDAwMSJ9LCJyZXF1ZXN0SWQiOiJ3czEtMDAwMDAwMDAtMDAwMC00MDAwLTgwMDAtMDAwMDAwMDAwMDAxIn0",
"stream": "stdout"
}{
"action": "stop",
"process": "moira-process:v1:eyJvd25lciI6eyJraW5kIjoiZ2l0aHViIiwicmVzb3VyY2VJZCI6IjAwMDAwMDAwLTAwMDAtNDAwMC04MDAwLTAwMDAwMDAwMDAwMSJ9LCJyZXF1ZXN0SWQiOiJ3czEtMDAwMDAwMDAtMDAwMC00MDAwLTgwMDAtMDAwMDAwMDAwMDAxIn0"
}{
"action": "close",
"workspace": "moira-workspace:v1:eyJnZW5lcmF0aW9uIjoxLCJwcm92aWRlciI6ImdpdGh1Yi1jb2Rlc3BhY2VzIiwicmVzb3VyY2VJZCI6IjAwMDAwMDAwLTAwMDAtNDAwMC04MDAwLTAwMDAwMDAwMDAwMSJ9",
"name": "shell"
}{
"action": "collect",
"reference": "moira-process:v1:eyJvd25lciI6eyJraW5kIjoiZ2l0aHViIiwicmVzb3VyY2VJZCI6IjAwMDAwMDAwLTAwMDAtNDAwMC04MDAwLTAwMDAwMDAwMDAwMSJ9LCJyZXF1ZXN0SWQiOiJ3czEtMDAwMDAwMDAtMDAwMC00MDAwLTgwMDAtMDAwMDAwMDAwMDAxIn0"
}{
"action": "find",
"owner": "moira-workspace:v1:eyJnZW5lcmF0aW9uIjoxLCJwcm92aWRlciI6ImdpdGh1Yi1jb2Rlc3BhY2VzIiwicmVzb3VyY2VJZCI6IjAwMDAwMDAwLTAwMDAtNDAwMC04MDAwLTAwMDAwMDAwMDAwMSJ9",
"kind": "command"
}codespace_read
Read complete UTF-8 characters with a whole-file reference and continuation. Observe metadata and return a checked file reference for a regular file. Return a validated native image preview.
Actions: read, stat, preview.
Input schema
{
"anyOf": [
{
"type": "object",
"properties": {
"workspace": {
"type": "string",
"description": "Copy the returned workspace reference; never manufacture or refresh it"
},
"path": {
"type": "string",
"minLength": 1,
"maxLength": 4096,
"description": "Path relative to the selected workspace repository root, for example moira-ws/task/file.md. File tools reject absolute paths, parent traversal and symlinks; use '.' for directory operations at the root"
},
"window": {
"anyOf": [
{
"type": "object",
"properties": {
"start_line": {
"type": "integer",
"exclusiveMinimum": 0,
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"max_lines": {
"type": "integer",
"exclusiveMinimum": 0,
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"additionalProperties": false
},
{
"type": "object",
"properties": {
"cursor": {
"type": "string",
"description": "Copy the returned file-cursor reference; never manufacture or refresh it"
}
},
"required": [
"cursor"
],
"additionalProperties": false
}
]
},
"max_bytes": {
"type": "integer",
"exclusiveMinimum": 0,
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"action": {
"type": "string",
"const": "read"
}
},
"required": [
"workspace",
"path",
"action"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"workspace": {
"type": "string",
"description": "Copy the returned workspace reference; never manufacture or refresh it"
},
"path": {
"type": "string",
"minLength": 1,
"maxLength": 4096,
"description": "Path relative to the selected workspace repository root, for example moira-ws/task/file.md. File tools reject absolute paths, parent traversal and symlinks; use '.' for directory operations at the root"
},
"action": {
"type": "string",
"const": "stat"
}
},
"required": [
"workspace",
"path",
"action"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"workspace": {
"type": "string",
"description": "Copy the returned workspace reference; never manufacture or refresh it"
},
"path": {
"type": "string",
"minLength": 1,
"maxLength": 4096,
"description": "Path relative to the selected workspace repository root, for example moira-ws/task/file.md. File tools reject absolute paths, parent traversal and symlinks; use '.' for directory operations at the root"
},
"max_bytes": {
"type": "integer",
"exclusiveMinimum": 0,
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"action": {
"type": "string",
"const": "preview"
}
},
"required": [
"workspace",
"path",
"action"
],
"additionalProperties": false
}
],
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object"
}Result: Owner-produced data, native content or original operation references; unavailable observation does not prove absence. Owner-produced data, native content or original operation references; unavailable observation does not prove absence. Owner-produced data, native content or original operation references; unavailable observation does not prove absence.
{
"action": "read",
"workspace": "moira-workspace:v1:eyJnZW5lcmF0aW9uIjoxLCJwcm92aWRlciI6ImdpdGh1Yi1jb2Rlc3BhY2VzIiwicmVzb3VyY2VJZCI6IjAwMDAwMDAwLTAwMDAtNDAwMC04MDAwLTAwMDAwMDAwMDAwMSJ9",
"path": "README.md"
}{
"action": "stat",
"workspace": "moira-workspace:v1:eyJnZW5lcmF0aW9uIjoxLCJwcm92aWRlciI6ImdpdGh1Yi1jb2Rlc3BhY2VzIiwicmVzb3VyY2VJZCI6IjAwMDAwMDAwLTAwMDAtNDAwMC04MDAwLTAwMDAwMDAwMDAwMSJ9",
"path": "README.md"
}{
"action": "preview",
"workspace": "moira-workspace:v1:eyJnZW5lcmF0aW9uIjoxLCJwcm92aWRlciI6ImdpdGh1Yi1jb2Rlc3BhY2VzIiwicmVzb3VyY2VJZCI6IjAwMDAwMDAwLTAwMDAtNDAwMC04MDAwLTAwMDAwMDAwMDAwMSJ9",
"path": "screen.png"
}codespace_edit
Create a text file only when absent. Replace text only against complete expected text or an observed file reference. Replace matching old text atomically against one original across the selected files. Collect the original operation or process without resubmitting any effect. Discover original owner receipts; ambiguous candidates are never selected or replayed automatically.
Actions: create, replace, patch, collect, find.
Input schema
{
"anyOf": [
{
"type": "object",
"properties": {
"workspace": {
"type": "string",
"description": "Copy the returned workspace reference; never manufacture or refresh it"
},
"path": {
"type": "string",
"minLength": 1,
"maxLength": 4096,
"description": "Path relative to the selected workspace repository root, for example moira-ws/task/file.md. File tools reject absolute paths, parent traversal and symlinks; use '.' for directory operations at the root"
},
"text": {
"type": "string"
},
"action": {
"type": "string",
"const": "create"
}
},
"required": [
"workspace",
"path",
"text",
"action"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"workspace": {
"type": "string",
"description": "Copy the returned workspace reference; never manufacture or refresh it"
},
"path": {
"type": "string",
"minLength": 1,
"maxLength": 4096,
"description": "Path relative to the selected workspace repository root, for example moira-ws/task/file.md. File tools reject absolute paths, parent traversal and symlinks; use '.' for directory operations at the root"
},
"text": {
"type": "string"
},
"expected": {
"anyOf": [
{
"type": "object",
"properties": {
"text": {
"type": "string"
}
},
"required": [
"text"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"file": {
"type": "string",
"description": "Copy the returned file reference; never manufacture or refresh it"
}
},
"required": [
"file"
],
"additionalProperties": false
}
]
},
"action": {
"type": "string",
"const": "replace"
}
},
"required": [
"workspace",
"path",
"text",
"expected",
"action"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"workspace": {
"type": "string",
"description": "Copy the returned workspace reference; never manufacture or refresh it"
},
"files": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"minLength": 1,
"maxLength": 4096,
"description": "Path relative to the selected workspace repository root, for example moira-ws/task/file.md. File tools reject absolute paths, parent traversal and symlinks; use '.' for directory operations at the root"
},
"expected": {
"anyOf": [
{
"type": "object",
"properties": {
"text": {
"type": "string"
}
},
"required": [
"text"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"file": {
"type": "string",
"description": "Copy the returned file reference; never manufacture or refresh it"
}
},
"required": [
"file"
],
"additionalProperties": false
}
]
},
"replacements": {
"type": "array",
"items": {
"type": "object",
"properties": {
"old_text": {
"type": "string",
"minLength": 1
},
"new_text": {
"type": "string"
},
"occurrence": {
"type": "string",
"enum": [
"one",
"all"
]
}
},
"required": [
"old_text",
"new_text"
],
"additionalProperties": false
},
"minItems": 1
}
},
"required": [
"path",
"replacements"
],
"additionalProperties": false
},
"minItems": 1
},
"action": {
"type": "string",
"const": "patch"
}
},
"required": [
"workspace",
"files",
"action"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"reference": {
"type": "string",
"description": "Copy the returned operation or process reference; never manufacture or refresh it"
},
"action": {
"type": "string",
"const": "collect"
}
},
"required": [
"reference",
"action"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"owner": {
"type": "string",
"description": "Copy the returned workspace or controller reference; never manufacture or refresh it"
},
"kind": {
"type": "string",
"enum": [
"command",
"file-change",
"lifecycle",
"repository",
"pull-request",
"delivery",
"session",
"unknown"
]
},
"query": {
"type": "string"
},
"cursor": {
"type": "string",
"minLength": 1
},
"action": {
"type": "string",
"const": "find"
}
},
"required": [
"owner",
"action"
],
"additionalProperties": false
}
],
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object"
}Result: Owner-produced data, native content or original operation references; unavailable observation does not prove absence. Owner-produced data, native content or original operation references; unavailable observation does not prove absence. Owner-produced data, native content or original operation references; unavailable observation does not prove absence. Owner-produced data, native content or original operation references; unavailable observation does not prove absence. Owner-produced data, native content or original operation references; unavailable observation does not prove absence.
{
"action": "create",
"workspace": "moira-workspace:v1:eyJnZW5lcmF0aW9uIjoxLCJwcm92aWRlciI6ImdpdGh1Yi1jb2Rlc3BhY2VzIiwicmVzb3VyY2VJZCI6IjAwMDAwMDAwLTAwMDAtNDAwMC04MDAwLTAwMDAwMDAwMDAwMSJ9",
"path": "notes.txt",
"text": "Hello\n"
}{
"action": "replace",
"workspace": "moira-workspace:v1:eyJnZW5lcmF0aW9uIjoxLCJwcm92aWRlciI6ImdpdGh1Yi1jb2Rlc3BhY2VzIiwicmVzb3VyY2VJZCI6IjAwMDAwMDAwLTAwMDAtNDAwMC04MDAwLTAwMDAwMDAwMDAwMSJ9",
"path": "notes.txt",
"text": "Updated\n",
"expected": {
"text": "Hello\n"
}
}{
"action": "patch",
"workspace": "moira-workspace:v1:eyJnZW5lcmF0aW9uIjoxLCJwcm92aWRlciI6ImdpdGh1Yi1jb2Rlc3BhY2VzIiwicmVzb3VyY2VJZCI6IjAwMDAwMDAwLTAwMDAtNDAwMC04MDAwLTAwMDAwMDAwMDAwMSJ9",
"files": [
{
"path": "notes.txt",
"replacements": [
{
"old_text": "Hello",
"new_text": "Welcome"
}
]
}
]
}{
"action": "collect",
"reference": "moira-process:v1:eyJvd25lciI6eyJraW5kIjoiZ2l0aHViIiwicmVzb3VyY2VJZCI6IjAwMDAwMDAwLTAwMDAtNDAwMC04MDAwLTAwMDAwMDAwMDAwMSJ9LCJyZXF1ZXN0SWQiOiJ3czEtMDAwMDAwMDAtMDAwMC00MDAwLTgwMDAtMDAwMDAwMDAwMDAxIn0"
}{
"action": "find",
"owner": "moira-workspace:v1:eyJnZW5lcmF0aW9uIjoxLCJwcm92aWRlciI6ImdpdGh1Yi1jb2Rlc3BhY2VzIiwicmVzb3VyY2VJZCI6IjAwMDAwMDAwLTAwMDAtNDAwMC04MDAwLTAwMDAwMDAwMDAwMSJ9",
"kind": "command"
}codespace_git
Create one pull request through the workspace's scoped Git broker. Read a pull request by number or pushed head/base without creation. Collect the original operation or process without resubmitting any effect. Discover original owner receipts; ambiguous candidates are never selected or replayed automatically.
Actions: create, read, collect, find.
Input schema
{
"anyOf": [
{
"type": "object",
"properties": {
"workspace": {
"type": "string",
"description": "Copy the returned workspace reference; never manufacture or refresh it"
},
"head": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"base": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"title": {
"type": "string",
"minLength": 1
},
"body": {
"type": "string"
},
"draft": {
"type": "boolean"
},
"action": {
"type": "string",
"const": "create"
}
},
"required": [
"workspace",
"head",
"base",
"title",
"action"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"workspace": {
"type": "string",
"description": "Copy the returned workspace reference; never manufacture or refresh it"
},
"query": {
"anyOf": [
{
"type": "object",
"properties": {
"number": {
"type": "integer",
"exclusiveMinimum": 0,
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"number"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"head": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"base": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"required": [
"head",
"base"
],
"additionalProperties": false
}
]
},
"action": {
"type": "string",
"const": "read"
}
},
"required": [
"workspace",
"query",
"action"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"reference": {
"type": "string",
"description": "Copy the returned operation or process reference; never manufacture or refresh it"
},
"action": {
"type": "string",
"const": "collect"
}
},
"required": [
"reference",
"action"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"owner": {
"type": "string",
"description": "Copy the returned workspace or controller reference; never manufacture or refresh it"
},
"kind": {
"type": "string",
"enum": [
"command",
"file-change",
"lifecycle",
"repository",
"pull-request",
"delivery",
"session",
"unknown"
]
},
"query": {
"type": "string"
},
"cursor": {
"type": "string",
"minLength": 1
},
"action": {
"type": "string",
"const": "find"
}
},
"required": [
"owner",
"action"
],
"additionalProperties": false
}
],
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object"
}Result: Owner-produced data, native content or original operation references; unavailable observation does not prove absence. Owner-produced data, native content or original operation references; unavailable observation does not prove absence. Owner-produced data, native content or original operation references; unavailable observation does not prove absence. Owner-produced data, native content or original operation references; unavailable observation does not prove absence.
{
"action": "create",
"workspace": "moira-workspace:v1:eyJnZW5lcmF0aW9uIjoxLCJwcm92aWRlciI6ImdpdGh1Yi1jb2Rlc3BhY2VzIiwicmVzb3VyY2VJZCI6IjAwMDAwMDAwLTAwMDAtNDAwMC04MDAwLTAwMDAwMDAwMDAwMSJ9",
"head": "feature/change",
"base": "main",
"title": "Change"
}{
"action": "read",
"workspace": "moira-workspace:v1:eyJnZW5lcmF0aW9uIjoxLCJwcm92aWRlciI6ImdpdGh1Yi1jb2Rlc3BhY2VzIiwicmVzb3VyY2VJZCI6IjAwMDAwMDAwLTAwMDAtNDAwMC04MDAwLTAwMDAwMDAwMDAwMSJ9",
"query": {
"number": 42
}
}{
"action": "collect",
"reference": "moira-process:v1:eyJvd25lciI6eyJraW5kIjoiZ2l0aHViIiwicmVzb3VyY2VJZCI6IjAwMDAwMDAwLTAwMDAtNDAwMC04MDAwLTAwMDAwMDAwMDAwMSJ9LCJyZXF1ZXN0SWQiOiJ3czEtMDAwMDAwMDAtMDAwMC00MDAwLTgwMDAtMDAwMDAwMDAwMDAxIn0"
}{
"action": "find",
"owner": "moira-workspace:v1:eyJnZW5lcmF0aW9uIjoxLCJwcm92aWRlciI6ImdpdGh1Yi1jb2Rlc3BhY2VzIiwicmVzb3VyY2VJZCI6IjAwMDAwMDAwLTAwMDAtNDAwMC04MDAwLTAwMDAwMDAwMDAwMSJ9",
"kind": "command"
}communication
Send ordinary text through configured user channels without choosing credentials or recipients. Deliver a required native attachment through its selected paired owner and configured channels. Deliver an immutable existing owner publication without reacquiring or rewriting its bytes. Collect the original operation or process without resubmitting any effect. Discover original owner receipts; ambiguous candidates are never selected or replayed automatically.
Actions: send, deliver, deliver_publication, collect, find.
Input schema
{
"anyOf": [
{
"type": "object",
"properties": {
"message": {
"type": "string",
"minLength": 1
},
"format": {
"type": "string",
"enum": [
"plain",
"markdown",
"html"
]
},
"silent": {
"type": "boolean"
},
"channel": {
"type": "string",
"pattern": "^[a-z0-9][a-z0-9._-]*$"
},
"action": {
"type": "string",
"const": "send"
}
},
"required": [
"message",
"action"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"owner": {
"type": "string",
"description": "Copy the returned controller reference; never manufacture or refresh it"
},
"file": {},
"kind": {
"type": "string",
"enum": [
"image",
"document"
]
},
"message": {
"type": "string"
},
"format": {
"type": "string",
"enum": [
"plain",
"markdown",
"html"
]
},
"silent": {
"type": "boolean"
},
"channel": {
"type": "string",
"pattern": "^[a-z0-9][a-z0-9._-]*$"
},
"action": {
"type": "string",
"const": "deliver"
}
},
"required": [
"file",
"kind",
"action"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"publication": {
"type": "string",
"pattern": "^owner-file:\\/\\/(workspace|controller)\\/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}\\/[A-Za-z0-9_-]{43}$"
},
"kind": {
"type": "string",
"enum": [
"image",
"document"
]
},
"message": {
"type": "string"
},
"format": {
"type": "string",
"enum": [
"plain",
"markdown",
"html"
]
},
"silent": {
"type": "boolean"
},
"channel": {
"type": "string",
"pattern": "^[a-z0-9][a-z0-9._-]*$"
},
"action": {
"type": "string",
"const": "deliver_publication"
}
},
"required": [
"publication",
"kind",
"action"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"reference": {
"type": "string",
"description": "Copy the returned operation or process reference; never manufacture or refresh it"
},
"action": {
"type": "string",
"const": "collect"
}
},
"required": [
"reference",
"action"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"owner": {
"type": "string",
"description": "Copy the returned workspace or controller reference; never manufacture or refresh it"
},
"kind": {
"type": "string",
"enum": [
"command",
"file-change",
"lifecycle",
"repository",
"pull-request",
"delivery",
"session",
"unknown"
]
},
"query": {
"type": "string"
},
"cursor": {
"type": "string",
"minLength": 1
},
"action": {
"type": "string",
"const": "find"
}
},
"required": [
"owner",
"action"
],
"additionalProperties": false
}
],
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"file": {
"type": "object",
"properties": {
"file_id": {
"type": "string",
"maxLength": 512,
"pattern": "^(?:sediment:\\/\\/)?file_[A-Za-z0-9]+$"
},
"download_url": {
"type": "string",
"format": "uri"
},
"file_name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"mime_type": {
"type": "string",
"maxLength": 127,
"pattern": "^[a-z0-9][a-z0-9!#$&^_.+-]*\\/[a-z0-9][a-z0-9!#$&^_.+-]*$"
},
"size_bytes": {
"type": "integer",
"minimum": 0
}
},
"required": [
"file_id",
"download_url"
],
"additionalProperties": false,
"description": "Native ChatGPT reference acquired by the workspace owner; pass it without base64. Source refusal before admission is confirmed, not a lost accepted mutation"
}
},
"type": "object"
}Result: Owner-produced data, native content or original operation references; unavailable observation does not prove absence. Owner-produced data, native content or original operation references; unavailable observation does not prove absence. Owner-produced data, native content or original operation references; unavailable observation does not prove absence. Owner-produced data, native content or original operation references; unavailable observation does not prove absence. Owner-produced data, native content or original operation references; unavailable observation does not prove absence.
{
"action": "send",
"message": "The report is ready."
}{
"action": "deliver",
"file": {
"file_id": "file_Example",
"download_url": "https://files.oaiusercontent.com/example"
},
"kind": "document"
}{
"action": "deliver_publication",
"publication": "owner-file://workspace/00000000-0000-4000-8000-000000000001/AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
"kind": "document"
}{
"action": "collect",
"reference": "moira-process:v1:eyJvd25lciI6eyJraW5kIjoiZ2l0aHViIiwicmVzb3VyY2VJZCI6IjAwMDAwMDAwLTAwMDAtNDAwMC04MDAwLTAwMDAwMDAwMDAwMSJ9LCJyZXF1ZXN0SWQiOiJ3czEtMDAwMDAwMDAtMDAwMC00MDAwLTgwMDAtMDAwMDAwMDAwMDAxIn0"
}{
"action": "find",
"owner": "moira-workspace:v1:eyJnZW5lcmF0aW9uIjoxLCJwcm92aWRlciI6ImdpdGh1Yi1jb2Rlc3BhY2VzIiwicmVzb3VyY2VJZCI6IjAwMDAwMDAwLTAwMDAtNDAwMC04MDAwLTAwMDAwMDAwMDAwMSJ9",
"kind": "command"
}codespace_search
Search code at the workspace owner with explicit result windows.
Input schema
{
"type": "object",
"properties": {
"workspace": {
"type": "string",
"description": "Copy the returned workspace reference; never manufacture or refresh it"
},
"path": {
"type": "string",
"minLength": 1,
"maxLength": 4096,
"description": "Path relative to the selected workspace repository root, for example moira-ws/task/file.md. File tools reject absolute paths, parent traversal and symlinks; use '.' for directory operations at the root"
},
"query": {
"type": "string",
"minLength": 1
},
"mode": {
"type": "string",
"enum": [
"literal",
"regex"
]
},
"max_matches": {
"type": "integer",
"exclusiveMinimum": 0,
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"max_bytes": {
"type": "integer",
"exclusiveMinimum": 0,
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"workspace",
"path",
"query"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Result: Owner-produced data, native content or original operation references; unavailable observation does not prove absence.
{
"workspace": "moira-workspace:v1:eyJnZW5lcmF0aW9uIjoxLCJwcm92aWRlciI6ImdpdGh1Yi1jb2Rlc3BhY2VzIiwicmVzb3VyY2VJZCI6IjAwMDAwMDAwLTAwMDAtNDAwMC04MDAwLTAwMDAwMDAwMDAwMSJ9",
"path": ".",
"query": "TODO"
}codespace_upload
Stream a required native attachment to a new path or an observed replacement target.
Input schema
{
"type": "object",
"properties": {
"workspace": {
"type": "string",
"description": "Copy the returned workspace reference; never manufacture or refresh it"
},
"target": {
"anyOf": [
{
"type": "object",
"properties": {
"create": {
"type": "object",
"properties": {
"path": {
"type": "string",
"minLength": 1,
"maxLength": 4096,
"description": "Path relative to the selected workspace repository root, for example moira-ws/task/file.md. File tools reject absolute paths, parent traversal and symlinks; use '.' for directory operations at the root"
}
},
"required": [
"path"
],
"additionalProperties": false
}
},
"required": [
"create"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"replace": {
"type": "object",
"properties": {
"file": {
"type": "string",
"description": "Copy the returned file reference; never manufacture or refresh it"
}
},
"required": [
"file"
],
"additionalProperties": false
}
},
"required": [
"replace"
],
"additionalProperties": false
}
]
},
"file": {
"type": "object",
"properties": {
"file_id": {
"type": "string",
"maxLength": 512,
"pattern": "^(?:sediment:\\/\\/)?file_[A-Za-z0-9]+$"
},
"download_url": {
"type": "string",
"format": "uri"
},
"file_name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"mime_type": {
"type": "string",
"maxLength": 127,
"pattern": "^[a-z0-9][a-z0-9!#$&^_.+-]*\\/[a-z0-9][a-z0-9!#$&^_.+-]*$"
},
"size_bytes": {
"type": "integer",
"minimum": 0
}
},
"required": [
"file_id",
"download_url"
],
"additionalProperties": false,
"description": "Native ChatGPT reference acquired by the workspace owner; pass it without base64. Source refusal before admission is confirmed, not a lost accepted mutation"
}
},
"required": [
"workspace",
"target",
"file"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Result: Owner-produced data, native content or original operation references; unavailable observation does not prove absence.
{
"workspace": "moira-workspace:v1:eyJnZW5lcmF0aW9uIjoxLCJwcm92aWRlciI6ImdpdGh1Yi1jb2Rlc3BhY2VzIiwicmVzb3VyY2VJZCI6IjAwMDAwMDAwLTAwMDAtNDAwMC04MDAwLTAwMDAwMDAwMDAwMSJ9",
"target": {
"create": {
"path": "input.bin"
}
},
"file": {
"file_id": "file_Example",
"download_url": "https://files.oaiusercontent.com/example"
}
}codespace_download
Publish a complete file link with derived default name and media type.
Input schema
{
"type": "object",
"properties": {
"workspace": {
"type": "string",
"description": "Copy the returned workspace reference; never manufacture or refresh it"
},
"path": {
"type": "string",
"minLength": 1,
"maxLength": 4096,
"description": "Path relative to the selected workspace repository root, for example moira-ws/task/file.md. File tools reject absolute paths, parent traversal and symlinks; use '.' for directory operations at the root"
},
"file_name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"mime_type": {
"type": "string",
"pattern": "^[a-z0-9!#$&^_.+-]+\\/[a-z0-9!#$&^_.+-]+$"
},
"max_bytes": {
"type": "integer",
"exclusiveMinimum": 0,
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"workspace",
"path"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Result: Owner-produced data, native content or original operation references; unavailable observation does not prove absence.
{
"workspace": "moira-workspace:v1:eyJnZW5lcmF0aW9uIjoxLCJwcm92aWRlciI6ImdpdGh1Yi1jb2Rlc3BhY2VzIiwicmVzb3VyY2VJZCI6IjAwMDAwMDAwLTAwMDAtNDAwMC04MDAwLTAwMDAwMDAwMDAwMSJ9",
"path": "report.pdf"
}workflow
Discover workflows available to the current user. Create, inspect, validate, and modify workflows. Express a decision as `cases` on the node that has the evidence (a directive routes on its own answer, `success` when no case holds) with single-purpose arithmetic as its `expressions`; keep a separate condition or expression node only for a shared or standalone decision. Bind a progress block to the list it works through with `list`. Create short-lived workflow upload or download tokens. Inspect or resolve bundled-workflow reconciliation errors. Status returns candidate references to every agent and full candidate states to administrators. Get and resolve are administrator-only; use Workflow Management Flow to semantically merge candidates, then submit the merged graph.
Actions: list, create, edit, get, get-structure, get-node, search-nodes, validate, list-variables, get-variable, set-variable, delete-variable, diff, copy, clone-node, move-node, list-nodes, get-nodes, analyze-variables, set-visibility, create-invite, list-access, list-invites, revoke-access, revoke-invite, history, get-revision, compare-revisions, rollback, upload, download, reconciliation_status, reconciliation_get, reconciliation_resolve.
Input schema
{
"anyOf": [
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "list"
},
"search": {
"type": "string",
"description": "Search in workflow name and description"
},
"visibility": {
"type": "string",
"enum": [
"public",
"private",
"all"
],
"description": "Filter by visibility (default: all accessible)"
},
"sort": {
"type": "string",
"enum": [
"createdAt",
"name"
],
"description": "Sort field (default: createdAt)"
},
"sortOrder": {
"type": "string",
"enum": [
"asc",
"desc"
],
"description": "Sort order (default: desc)"
},
"limit": {
"type": "number",
"minimum": 1,
"maximum": 100,
"description": "Number of results (default: 20, max: 100)"
},
"offset": {
"type": "number",
"minimum": 0,
"description": "Offset for pagination (default: 0)"
}
},
"required": [
"action"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "create"
},
"overwrite": {
"type": "boolean",
"description": "Overwrite existing workflow with same ID (default: false)"
},
"workflow": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Workflow ID (auto-generated if not provided)"
},
"metadata": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Human-readable workflow name"
},
"version": {
"type": "string",
"description": "Semantic version (e.g., '1.0.0')"
},
"description": {
"type": "string",
"description": "Brief workflow description"
},
"author": {
"type": "string",
"description": "Workflow author"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Workflow tags"
},
"schemaVersion": {
"type": "integer",
"minimum": 0
}
},
"required": [
"name",
"version",
"description"
],
"additionalProperties": true
},
"nodes": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {}
},
"description": "Array of workflow nodes. Decisions are `cases` on the deciding node (condition or agent-directive) with a default output; a separate condition or expression node serves shared or standalone decisions."
},
"variableRegistry": {
"type": "object",
"additionalProperties": {},
"description": "Declared global variables (JSON-Schema-shaped: name -> {type, description, default?}). Required for any variable referenced by bare name in directives, routing cases, expressions, progress list bindings and templates."
},
"runtimePolicy": {
"type": "object",
"properties": {
"externalVariableWrites": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"allowedNodeIds": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"progress": {
"type": "object",
"properties": {
"title": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"goal": {
"type": "string",
"minLength": 1,
"maxLength": 1000
},
"facts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"tone": {
"type": "string",
"enum": [
"neutral",
"positive",
"warning",
"critical"
]
}
},
"required": [
"label",
"value"
],
"additionalProperties": false
},
"maxItems": 8
},
"nodes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"label": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"content": {
"type": "object",
"properties": {
"summary": {
"type": "string",
"minLength": 1,
"maxLength": 1000
},
"details": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"maxItems": 12
},
"outcome": {
"type": "string",
"minLength": 1,
"maxLength": 1000
},
"next": {
"type": "string",
"minLength": 1,
"maxLength": 500
}
},
"required": [
"summary"
],
"additionalProperties": false
},
"connections": {
"type": "object",
"properties": {
"default": {
"type": "string",
"minLength": 1
}
},
"additionalProperties": false
},
"list": {
"type": "object",
"properties": {
"items": {
"type": "string",
"minLength": 1
},
"title": {
"type": "string",
"minLength": 1
},
"current": {
"type": "string",
"minLength": 1
},
"done": {
"type": "string",
"minLength": 1
},
"total": {
"type": "string",
"minLength": 1
},
"indexBase": {
"type": "number",
"enum": [
0,
1
]
}
},
"additionalProperties": false
}
},
"required": [
"id",
"label",
"content"
],
"additionalProperties": false
},
"minItems": 1,
"maxItems": 18
}
},
"required": [
"nodes"
],
"additionalProperties": false
},
"visibility": {
"type": "string",
"enum": [
"public",
"private"
],
"description": "Workflow visibility (default: private)"
},
"systemReminder": {
"type": "string",
"description": "System reminder shown to agent on each step"
}
},
"required": [
"metadata",
"nodes"
],
"additionalProperties": true,
"description": "Complete authored workflow for create or validate; preserve the graph and metadata, including fields not edited by this caller"
}
},
"required": [
"action",
"workflow"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "edit"
},
"workflowId": {
"type": "string",
"minLength": 1
},
"changes": {
"type": "object",
"properties": {
"metadata": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"version": {
"type": "string"
},
"description": {
"type": "string"
},
"author": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": true
},
"variableRegistry": {
"type": "object",
"additionalProperties": {},
"description": "Replace the workflow's declared global variable registry"
},
"runtimePolicy": {
"type": "object",
"properties": {
"externalVariableWrites": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"allowedNodeIds": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"progress": {
"type": "object",
"properties": {
"title": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"goal": {
"type": "string",
"minLength": 1,
"maxLength": 1000
},
"facts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"tone": {
"type": "string",
"enum": [
"neutral",
"positive",
"warning",
"critical"
]
}
},
"required": [
"label",
"value"
],
"additionalProperties": false
},
"maxItems": 8
},
"nodes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"label": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"content": {
"type": "object",
"properties": {
"summary": {
"type": "string",
"minLength": 1,
"maxLength": 1000
},
"details": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"maxItems": 12
},
"outcome": {
"type": "string",
"minLength": 1,
"maxLength": 1000
},
"next": {
"type": "string",
"minLength": 1,
"maxLength": 500
}
},
"required": [
"summary"
],
"additionalProperties": false
},
"connections": {
"type": "object",
"properties": {
"default": {
"type": "string",
"minLength": 1
}
},
"additionalProperties": false
},
"list": {
"type": "object",
"properties": {
"items": {
"type": "string",
"minLength": 1
},
"title": {
"type": "string",
"minLength": 1
},
"current": {
"type": "string",
"minLength": 1
},
"done": {
"type": "string",
"minLength": 1
},
"total": {
"type": "string",
"minLength": 1
},
"indexBase": {
"type": "number",
"enum": [
0,
1
]
}
},
"additionalProperties": false
}
},
"required": [
"id",
"label",
"content"
],
"additionalProperties": false
},
"minItems": 1,
"maxItems": 18
}
},
"required": [
"nodes"
],
"additionalProperties": false
},
"addNodes": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {}
},
"description": "New nodes to add"
},
"removeNodes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Node IDs to remove"
},
"updateNodes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"nodeId": {
"type": "string",
"description": "ID of node to update"
},
"changes": {
"description": "Fields to update on the node"
}
},
"required": [
"nodeId"
],
"additionalProperties": false
},
"description": "Nodes to update with specific changes"
},
"removeConnections": {
"type": "array",
"items": {
"type": "object",
"properties": {
"nodeId": {
"type": "string",
"description": "ID of node with connection to remove"
},
"connectionKey": {
"type": "string",
"description": "Connection key to remove (e.g., 'default', 'true', 'false')"
}
},
"required": [
"nodeId",
"connectionKey"
],
"additionalProperties": false
},
"description": "Connections to remove from nodes"
},
"systemReminder": {
"type": "string",
"description": "New system reminder text"
}
},
"additionalProperties": false
},
"expectedRevision": {
"type": "integer",
"minimum": 0,
"description": "edit or rollback: the current definition revision from get; required for rollback; a stale value refuses the write"
}
},
"required": [
"action",
"workflowId",
"changes"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "get"
},
"workflowId": {
"type": "string",
"minLength": 1
},
"includeNodes": {
"type": "boolean",
"description": "Include full node definitions in get response"
},
"includeValidation": {
"type": "boolean",
"description": "Include validation results in response"
},
"offset": {
"type": "number",
"description": "Pagination offset for node listing"
},
"limit": {
"type": "number",
"description": "Maximum nodes to return"
}
},
"required": [
"action",
"workflowId"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "get-structure"
},
"workflowId": {
"type": "string",
"minLength": 1
},
"graph": {
"type": "boolean",
"description": "Return ASCII flow graph (get-structure only)"
},
"detailed": {
"type": "boolean",
"description": "Include directive preview in structure (get-structure only)"
}
},
"required": [
"action",
"workflowId"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "get-node"
},
"workflowId": {
"type": "string",
"minLength": 1
},
"nodeId": {
"type": "string",
"minLength": 1
}
},
"required": [
"action",
"workflowId",
"nodeId"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "search-nodes"
},
"workflowId": {
"type": "string",
"minLength": 1
},
"query": {
"type": "string",
"minLength": 1
},
"includeVariables": {
"type": "boolean",
"description": "Include variables in search (search-nodes only)"
},
"snippetMode": {
"type": "boolean",
"description": "Return only snippets, not full nodes (search-nodes only)"
}
},
"required": [
"action",
"workflowId",
"query"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "validate"
},
"workflow": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Workflow ID (auto-generated if not provided)"
},
"metadata": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Human-readable workflow name"
},
"version": {
"type": "string",
"description": "Semantic version (e.g., '1.0.0')"
},
"description": {
"type": "string",
"description": "Brief workflow description"
},
"author": {
"type": "string",
"description": "Workflow author"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Workflow tags"
},
"schemaVersion": {
"type": "integer",
"minimum": 0
}
},
"required": [
"name",
"version",
"description"
],
"additionalProperties": true
},
"nodes": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {}
},
"description": "Array of workflow nodes. Decisions are `cases` on the deciding node (condition or agent-directive) with a default output; a separate condition or expression node serves shared or standalone decisions."
},
"variableRegistry": {
"type": "object",
"additionalProperties": {},
"description": "Declared global variables (JSON-Schema-shaped: name -> {type, description, default?}). Required for any variable referenced by bare name in directives, routing cases, expressions, progress list bindings and templates."
},
"runtimePolicy": {
"type": "object",
"properties": {
"externalVariableWrites": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"allowedNodeIds": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"progress": {
"type": "object",
"properties": {
"title": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"goal": {
"type": "string",
"minLength": 1,
"maxLength": 1000
},
"facts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"tone": {
"type": "string",
"enum": [
"neutral",
"positive",
"warning",
"critical"
]
}
},
"required": [
"label",
"value"
],
"additionalProperties": false
},
"maxItems": 8
},
"nodes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"label": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"content": {
"type": "object",
"properties": {
"summary": {
"type": "string",
"minLength": 1,
"maxLength": 1000
},
"details": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"maxItems": 12
},
"outcome": {
"type": "string",
"minLength": 1,
"maxLength": 1000
},
"next": {
"type": "string",
"minLength": 1,
"maxLength": 500
}
},
"required": [
"summary"
],
"additionalProperties": false
},
"connections": {
"type": "object",
"properties": {
"default": {
"type": "string",
"minLength": 1
}
},
"additionalProperties": false
},
"list": {
"type": "object",
"properties": {
"items": {
"type": "string",
"minLength": 1
},
"title": {
"type": "string",
"minLength": 1
},
"current": {
"type": "string",
"minLength": 1
},
"done": {
"type": "string",
"minLength": 1
},
"total": {
"type": "string",
"minLength": 1
},
"indexBase": {
"type": "number",
"enum": [
0,
1
]
}
},
"additionalProperties": false
}
},
"required": [
"id",
"label",
"content"
],
"additionalProperties": false
},
"minItems": 1,
"maxItems": 18
}
},
"required": [
"nodes"
],
"additionalProperties": false
},
"visibility": {
"type": "string",
"enum": [
"public",
"private"
],
"description": "Workflow visibility (default: private)"
},
"systemReminder": {
"type": "string",
"description": "System reminder shown to agent on each step"
}
},
"required": [
"metadata",
"nodes"
],
"additionalProperties": true,
"description": "Complete authored workflow for create or validate; preserve the graph and metadata, including fields not edited by this caller"
}
},
"required": [
"action",
"workflow"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "list-variables"
},
"workflowId": {
"type": "string",
"minLength": 1
},
"variableNames": {
"type": "array",
"items": {
"type": "string"
}
},
"query": {
"type": "string",
"description": "Search query for search-nodes action"
},
"variableTypes": {
"type": "array",
"items": {
"type": "string"
}
},
"hasDefault": {
"type": "boolean"
},
"externallyWritable": {
"type": "boolean"
}
},
"required": [
"action",
"workflowId"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "get-variable"
},
"workflowId": {
"type": "string",
"minLength": 1
},
"variableName": {
"type": "string",
"minLength": 1
}
},
"required": [
"action",
"workflowId",
"variableName"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "set-variable"
},
"workflowId": {
"type": "string",
"minLength": 1
},
"variableName": {
"type": "string",
"minLength": 1
},
"variableValue": {}
},
"required": [
"action",
"workflowId",
"variableName",
"variableValue"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "delete-variable"
},
"workflowId": {
"type": "string",
"minLength": 1
},
"variableName": {
"type": "string",
"minLength": 1
}
},
"required": [
"action",
"workflowId",
"variableName"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "diff"
},
"workflowId": {
"type": "string",
"minLength": 1
},
"compareWorkflowId": {
"type": "string",
"minLength": 1
}
},
"required": [
"action",
"workflowId",
"compareWorkflowId"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "copy"
},
"workflowId": {
"type": "string",
"minLength": 1
},
"newName": {
"type": "string",
"description": "New name for copied workflow (copy action)"
}
},
"required": [
"action",
"workflowId"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "clone-node"
},
"workflowId": {
"type": "string",
"minLength": 1
},
"nodeId": {
"type": "string",
"minLength": 1
},
"newId": {
"type": "string",
"description": "New ID for cloned node (clone-node action)"
}
},
"required": [
"action",
"workflowId",
"nodeId"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "move-node"
},
"workflowId": {
"type": "string",
"minLength": 1
},
"nodeId": {
"type": "string",
"minLength": 1
},
"targetIndex": {
"type": "number"
}
},
"required": [
"action",
"workflowId",
"nodeId",
"targetIndex"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "move-node"
},
"workflowId": {
"type": "string",
"minLength": 1
},
"nodeId": {
"type": "string",
"minLength": 1
},
"afterNodeId": {
"type": "string",
"minLength": 1
}
},
"required": [
"action",
"workflowId",
"nodeId",
"afterNodeId"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "list-nodes"
},
"workflowId": {
"type": "string",
"minLength": 1
},
"typeFilter": {
"type": "string",
"description": "Filter nodes by type (list-nodes only)"
},
"includePreview": {
"type": "boolean",
"description": "Include directive preview (list-nodes only)"
},
"previewLength": {
"type": "number",
"description": "Length of directive preview (list-nodes only, default 100)"
}
},
"required": [
"action",
"workflowId"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "get-nodes"
},
"workflowId": {
"type": "string",
"minLength": 1
},
"nodeIds": {
"type": "array",
"items": {
"type": "string"
},
"minItems": 1
}
},
"required": [
"action",
"workflowId",
"nodeIds"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "analyze-variables"
},
"workflowId": {
"type": "string",
"minLength": 1
}
},
"required": [
"action",
"workflowId"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "set-visibility"
},
"workflowId": {
"type": "string",
"minLength": 1
},
"visibility": {
"type": "string",
"enum": [
"public",
"private"
]
}
},
"required": [
"action",
"workflowId",
"visibility"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "create-invite"
},
"workflowId": {
"type": "string",
"minLength": 1
},
"ttlMs": {
"type": "number",
"description": "Invite expiration time in milliseconds (create-invite only, default 7 days)"
}
},
"required": [
"action",
"workflowId"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "list-access"
},
"workflowId": {
"type": "string",
"minLength": 1
},
"limit": {
"type": "number",
"description": "Maximum nodes to return"
},
"offset": {
"type": "number",
"description": "Pagination offset for node listing"
}
},
"required": [
"action",
"workflowId"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "list-invites"
},
"workflowId": {
"type": "string",
"minLength": 1
},
"activeOnly": {
"type": "boolean",
"description": "Filter to active (unused) invites only (list-invites only, default true)"
},
"limit": {
"type": "number",
"description": "Maximum nodes to return"
},
"offset": {
"type": "number",
"description": "Pagination offset for node listing"
}
},
"required": [
"action",
"workflowId"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "revoke-access"
},
"workflowId": {
"type": "string",
"minLength": 1
},
"targetUserId": {
"type": "string",
"minLength": 1
}
},
"required": [
"action",
"workflowId",
"targetUserId"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "revoke-invite"
},
"inviteId": {
"type": "string",
"minLength": 1
}
},
"required": [
"action",
"inviteId"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "history"
},
"workflowId": {
"type": "string",
"minLength": 1
}
},
"required": [
"action",
"workflowId"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "get-revision"
},
"workflowId": {
"type": "string",
"minLength": 1
},
"revision": {
"type": "integer",
"exclusiveMinimum": 0
}
},
"required": [
"action",
"workflowId",
"revision"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "compare-revisions"
},
"workflowId": {
"type": "string",
"minLength": 1
},
"fromRevision": {
"type": "integer",
"exclusiveMinimum": 0
},
"toRevision": {
"type": "integer",
"exclusiveMinimum": 0
}
},
"required": [
"action",
"workflowId",
"fromRevision",
"toRevision"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "rollback"
},
"workflowId": {
"type": "string",
"minLength": 1
},
"revision": {
"type": "integer",
"exclusiveMinimum": 0
},
"expectedRevision": {
"type": "integer",
"minimum": 0
}
},
"required": [
"action",
"workflowId",
"revision",
"expectedRevision"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "upload"
},
"ttlMinutes": {
"type": "number",
"default": 60,
"description": "Token expiration time in minutes (default: 60)"
}
},
"required": [
"action"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "download"
},
"workflowId": {
"type": "string",
"minLength": 1
},
"ttlMinutes": {
"type": "number",
"default": 60,
"description": "Token expiration time in minutes (default: 60)"
}
},
"required": [
"action",
"workflowId"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "reconciliation_status"
}
},
"required": [
"action"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "reconciliation_get"
},
"reference": {
"type": "string",
"minLength": 1
}
},
"required": [
"action",
"reference"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "reconciliation_resolve"
},
"reference": {
"type": "string",
"minLength": 1
},
"selection": {
"type": "string",
"enum": [
"current",
"incoming",
"previous"
]
},
"revision": {
"type": "string",
"pattern": "^[a-f0-9]{64}$",
"minLength": 1
},
"rationale": {
"type": "string",
"minLength": 1,
"maxLength": 2000
}
},
"required": [
"action",
"reference",
"selection",
"revision",
"rationale"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "reconciliation_resolve"
},
"reference": {
"type": "string",
"minLength": 1
},
"revision": {
"type": "string",
"pattern": "^[a-f0-9]{64}$",
"minLength": 1
},
"rationale": {
"type": "string",
"minLength": 1,
"maxLength": 2000
},
"mergedGraph": {
"type": "object",
"additionalProperties": {}
},
"visibility": {
"type": "string",
"enum": [
"public",
"private"
]
},
"selection": {
"type": "string",
"const": "current"
}
},
"required": [
"action",
"reference",
"revision",
"rationale",
"mergedGraph",
"visibility",
"selection"
],
"additionalProperties": false
}
],
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object"
}Result: A workflow page with explicit offset, limit, returnedCount, hasMore, and nextOffset. Action-specific workflow data. A formatted URL and usage instructions. Conflict status, a candidate, or a resolution result.
{
"limit": 20,
"offset": 0,
"action": "list"
}{
"limit": 20,
"offset": 20,
"action": "list"
}{
"action": "get",
"workflowId": "moira/quick-task",
"includeNodes": false,
"includeValidation": false
}{
"action": "list-nodes",
"workflowId": "moira/quick-task",
"includePreview": true
}{
"action": "get-nodes",
"workflowId": "moira/quick-task",
"nodeIds": [
"start",
"end"
]
}{
"action": "analyze-variables",
"workflowId": "moira/quick-task"
}{
"action": "set-visibility",
"workflowId": "my-workflow",
"visibility": "private"
}{
"action": "upload",
"ttlMinutes": 60
}{
"action": "reconciliation_status"
}execution
Prepare, then execute, a replay-safe workflow start. Continue an existing workflow execution. Inspect and update execution-scoped state. Inspect, create, or unlock execution locks.
Actions: prepare, execute, step, user, executions, execution_context, current_step, diagnose, materialize, recover, cancel-execution, stop-execution, update-note, update-task-title, set-parent, reminders, add-reminder, update-reminder, remove-reminder, variables, set-variable, await-user, progress, progress-image-token, lock_status, lock_list, unlock, lock.
Input schema
{
"anyOf": [
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "prepare"
},
"workflowId": {
"type": "string",
"description": "Workflow ID to prepare; discover accessible definitions with workflow({action:\"list\"})"
},
"note": {
"type": "string",
"maxLength": 500,
"description": "Optional prepare execution note (max 500 chars)"
},
"parentExecutionId": {
"type": "string",
"description": "Required for prepare. Use \"none\" for standalone, or a parent process UUID."
},
"skipTelegramCheck": {
"type": "boolean",
"description": "Prepare only. Deprecated alias for skipNotificationCheck"
}
},
"required": [
"action",
"workflowId",
"parentExecutionId"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "prepare"
},
"workflowId": {
"type": "string",
"description": "Workflow ID to prepare; discover accessible definitions with workflow({action:\"list\"})"
},
"note": {
"type": "string",
"maxLength": 500,
"description": "Optional prepare execution note (max 500 chars)"
},
"parentExecutionId": {
"type": "string",
"description": "Required for prepare. Use \"none\" for standalone, or a parent process UUID."
},
"skipNotificationCheck": {
"type": "boolean",
"const": false
},
"skipTelegramCheck": {
"type": "boolean",
"const": false
}
},
"required": [
"action",
"workflowId",
"parentExecutionId",
"skipNotificationCheck"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "prepare"
},
"workflowId": {
"type": "string",
"description": "Workflow ID to prepare; discover accessible definitions with workflow({action:\"list\"})"
},
"note": {
"type": "string",
"maxLength": 500,
"description": "Optional prepare execution note (max 500 chars)"
},
"parentExecutionId": {
"type": "string",
"description": "Required for prepare. Use \"none\" for standalone, or a parent process UUID."
},
"skipNotificationCheck": {
"type": "boolean",
"const": true
},
"skipTelegramCheck": {
"type": "boolean",
"const": true
}
},
"required": [
"action",
"workflowId",
"parentExecutionId",
"skipNotificationCheck"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "execute"
},
"startAttemptId": {
"type": "string",
"format": "uuid",
"description": "Required for execute. Start attempt ID returned by prepare"
}
},
"required": [
"action",
"startAttemptId"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "step"
},
"processId": {
"type": "string",
"description": "Process ID from successful execution execute or a previous execution step response"
},
"attemptId": {
"type": "string",
"description": "Step attempt ID from successful execution execute, execution step, or execution current_step"
},
"input": {
"anyOf": [
{
"type": "string"
},
{
"type": "object",
"additionalProperties": {}
},
{
"type": "array",
"items": {}
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Input data matching the step's inputSchema. Structure depends on current step requirements."
}
},
"required": [
"action",
"processId",
"attemptId"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "step"
},
"processId": {
"type": "string",
"description": "Process ID from successful execution execute or a previous execution step response"
},
"attemptId": {
"type": "string",
"description": "Step attempt ID from successful execution execute, execution step, or execution current_step"
},
"teleportTo": {
"type": "string"
}
},
"required": [
"action",
"processId",
"attemptId",
"teleportTo"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "user"
}
},
"required": [
"action"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "executions"
},
"status": {
"type": "array",
"items": {
"type": "string",
"enum": [
"running",
"waiting",
"completed",
"failed",
"locked"
]
},
"description": "Filter executions by status (array of statuses)"
},
"workflowId": {
"type": "string",
"description": "Filter by workflow ID"
},
"search": {
"type": "string",
"description": "Search in execution notes"
},
"sort": {
"type": "string",
"enum": [
"createdAt",
"updatedAt"
],
"description": "Sort field for executions list"
},
"sortOrder": {
"type": "string",
"enum": [
"asc",
"desc"
],
"description": "Sort order (ascending or descending)"
},
"limit": {
"type": "number",
"minimum": 1,
"maximum": 100,
"description": "Maximum executions to return (1-100)"
},
"offset": {
"type": "number",
"minimum": 0,
"description": "Pagination offset"
}
},
"required": [
"action"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "execution_context"
},
"executionId": {
"type": "string",
"minLength": 1
}
},
"required": [
"action",
"executionId"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "current_step"
},
"executionId": {
"type": "string",
"minLength": 1
}
},
"required": [
"action",
"executionId"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "diagnose"
},
"executionId": {
"type": "string",
"minLength": 1
}
},
"required": [
"action",
"executionId"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "materialize"
},
"executionId": {
"type": "string",
"minLength": 1
}
},
"required": [
"action",
"executionId"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "recover"
},
"executionId": {
"type": "string",
"minLength": 1
},
"nodeId": {
"type": "string",
"minLength": 1
},
"variableValues": {
"type": "object",
"additionalProperties": {},
"description": "Variable values written into the execution context while recovering (recover only)"
}
},
"required": [
"action",
"executionId",
"nodeId"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "cancel-execution"
},
"executionId": {
"type": "string",
"minLength": 1
},
"expectedRevision": {
"type": "integer",
"minimum": 0
}
},
"required": [
"action",
"executionId",
"expectedRevision"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "stop-execution"
},
"executionId": {
"type": "string",
"minLength": 1
},
"expectedRevision": {
"type": "integer",
"minimum": 0
},
"reason": {
"type": "string",
"minLength": 1,
"maxLength": 500
}
},
"required": [
"action",
"executionId",
"expectedRevision",
"reason"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "update-note"
},
"executionId": {
"type": "string",
"minLength": 1
},
"note": {
"type": "string",
"maxLength": 500
}
},
"required": [
"action",
"executionId",
"note"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "update-task-title"
},
"executionId": {
"type": "string",
"minLength": 1
},
"taskTitle": {
"type": "string",
"maxLength": 500,
"minLength": 1
},
"expectedRevision": {
"type": "integer",
"minimum": 0
},
"expectedTaskIdentityRevision": {
"type": "string",
"minLength": 64,
"maxLength": 64
}
},
"required": [
"action",
"executionId",
"taskTitle",
"expectedRevision",
"expectedTaskIdentityRevision"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "set-parent"
},
"executionId": {
"type": "string",
"minLength": 1
},
"expectedRevision": {
"type": "integer",
"minimum": 0
},
"expectedParentRevision": {
"type": "string",
"minLength": 64,
"maxLength": 64
},
"parentExecutionId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "string",
"const": "none"
}
]
}
},
"required": [
"action",
"executionId",
"expectedRevision",
"expectedParentRevision",
"parentExecutionId"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "reminders"
},
"executionId": {
"type": "string",
"minLength": 1
},
"reminderStatus": {
"type": "string",
"enum": [
"active",
"cancelled"
],
"description": "Reminder status filter"
},
"search": {
"type": "string",
"description": "Search in execution notes"
}
},
"required": [
"action",
"executionId"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "add-reminder"
},
"executionId": {
"type": "string",
"minLength": 1
},
"expectedRevision": {
"type": "integer",
"minimum": 0
},
"expectedRemindersRevision": {
"type": "string",
"minLength": 64,
"maxLength": 64
},
"idempotencyKey": {
"type": "string",
"maxLength": 100
},
"reminderText": {
"type": "string",
"minLength": 1,
"maxLength": 1000
}
},
"required": [
"action",
"executionId",
"expectedRevision",
"expectedRemindersRevision",
"reminderText"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "update-reminder"
},
"executionId": {
"type": "string",
"minLength": 1
},
"expectedRevision": {
"type": "integer",
"minimum": 0
},
"expectedRemindersRevision": {
"type": "string",
"minLength": 64,
"maxLength": 64
},
"reminderId": {
"type": "string",
"minLength": 1
},
"reminderText": {
"type": "string",
"minLength": 1,
"maxLength": 1000
}
},
"required": [
"action",
"executionId",
"expectedRevision",
"expectedRemindersRevision",
"reminderId",
"reminderText"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "remove-reminder"
},
"executionId": {
"type": "string",
"minLength": 1
},
"expectedRevision": {
"type": "integer",
"minimum": 0
},
"expectedRemindersRevision": {
"type": "string",
"minLength": 64,
"maxLength": 64
},
"reminderId": {
"type": "string",
"minLength": 1
}
},
"required": [
"action",
"executionId",
"expectedRevision",
"expectedRemindersRevision",
"reminderId"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "variables"
},
"executionId": {
"type": "string",
"minLength": 1
},
"names": {
"type": "array",
"items": {
"type": "string"
}
},
"search": {
"type": "string",
"description": "Search in execution notes"
},
"types": {
"type": "array",
"items": {
"type": "string"
}
},
"editable": {
"type": "boolean"
},
"hasValue": {
"type": "boolean"
},
"writePhase": {
"type": "string",
"enum": [
"current",
"other"
]
}
},
"required": [
"action",
"executionId"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "set-variable"
},
"executionId": {
"type": "string",
"minLength": 1
},
"variableName": {
"type": "string",
"minLength": 1
},
"expectedRevision": {
"type": "integer",
"minimum": 0
},
"expectedContextRevision": {
"type": "string",
"minLength": 64,
"maxLength": 64
},
"variableValue": {}
},
"required": [
"action",
"executionId",
"variableName",
"expectedRevision",
"expectedContextRevision",
"variableValue"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "await-user"
},
"executionId": {
"type": "string",
"minLength": 1
},
"question": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"options": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"minItems": 1,
"maxItems": 4,
"description": "await-user: the choices, when the question is a choice"
}
},
"required": [
"action",
"executionId",
"question"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "await-user"
},
"executionId": {
"type": "string",
"minLength": 1
},
"resolve": {
"type": "boolean",
"const": true
}
},
"required": [
"action",
"executionId",
"resolve"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "progress"
},
"executionId": {
"type": "string",
"minLength": 1
},
"at": {
"type": "integer",
"minimum": 0,
"description": "Route cursor for progress: project the run as of this visit sequence number (the route is cut there, variables carry the values written up to it)"
}
},
"required": [
"action",
"executionId"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "progress-image-token"
},
"executionId": {
"type": "string",
"minLength": 1
},
"device_id": {
"type": "string",
"format": "uuid",
"description": "Selected paired controller for progress-image-token; omit only when exactly one live controller is eligible"
},
"theme": {
"type": "string",
"enum": [
"light",
"dark"
]
},
"viewportWidth": {
"type": "integer",
"minimum": 480,
"maximum": 4096
},
"view": {
"type": "string",
"enum": [
"cards",
"process"
],
"description": "progress-image-token: cards (default) draws every block as a content card; process draws the aggregated block view with labelled transitions and loops"
},
"hide": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 100,
"description": "progress-image-token: block ids or authored node ids (resolved to their block) left out of the image; their transitions collapse"
},
"collapse": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 100,
"description": "progress-image-token: block ids or authored node ids drawn as a label-only chip"
}
},
"required": [
"action",
"executionId"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "lock_status"
},
"executionId": {
"type": "string",
"description": "Execution ID (required for all actions)"
}
},
"required": [
"action",
"executionId"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "lock_list"
},
"executionId": {
"type": "string",
"description": "Execution ID (required for all actions)"
}
},
"required": [
"action",
"executionId"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "unlock"
},
"executionId": {
"type": "string",
"description": "Execution ID (required for all actions)"
},
"pin": {
"type": "string",
"minLength": 1
}
},
"required": [
"action",
"executionId",
"pin"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "lock"
},
"executionId": {
"type": "string",
"description": "Execution ID (required for all actions)"
},
"reason": {
"type": "string",
"minLength": 1
}
},
"required": [
"action",
"executionId",
"reason"
],
"additionalProperties": false
}
],
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object"
}Result: A start attempt receipt or the process ID and first instruction. The next instruction with its step attempt ID, or a terminal result. Action-specific session or execution data. Lock state without a secret PIN.
{
"action": "prepare",
"workflowId": "moira/quick-task",
"parentExecutionId": "none"
}{
"action": "execute",
"startAttemptId": "00000000-0000-4000-8000-000000000000"
}{
"processId": "00000000-0000-4000-8000-000000000000",
"attemptId": "11111111-1111-4111-8111-111111111111",
"input": {
"outcome": "completed"
},
"action": "step"
}{
"action": "executions",
"limit": 20,
"offset": 0
}{
"action": "lock_status",
"executionId": "00000000-0000-4000-8000-000000000000"
}notes
Store and retrieve versioned notes.
Actions: list, get, save, delete, history, stats.
Input schema
{
"anyOf": [
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "list"
},
"tag": {
"type": "string",
"description": "Filter notes by tag (for list action)"
},
"keySearch": {
"type": "string",
"description": "Search notes by key pattern (for list action)"
},
"limit": {
"type": "number",
"minimum": 1,
"maximum": 100,
"description": "Maximum notes to return (1-100, default 50)"
},
"offset": {
"type": "number",
"minimum": 0,
"description": "Pagination offset (default 0)"
}
},
"required": [
"action"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "get"
},
"key": {
"type": "string",
"minLength": 1
},
"version": {
"type": "number",
"description": "Specific version number to retrieve (for get action)"
}
},
"required": [
"action",
"key"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "save"
},
"key": {
"type": "string",
"minLength": 1
},
"value": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Tags for the note (for save action, max 10 tags)"
}
},
"required": [
"action",
"key",
"value"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "delete"
},
"key": {
"type": "string",
"minLength": 1
}
},
"required": [
"action",
"key"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "history"
},
"key": {
"type": "string",
"minLength": 1
}
},
"required": [
"action",
"key"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "stats"
}
},
"required": [
"action"
],
"additionalProperties": false
}
],
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object"
}Result: Action-specific note data.
{
"action": "list",
"limit": 20,
"offset": 0
}playbooks
Keep named, reusable behaviour text an agent can read where it is needed.
Actions: list, get, save, delete, history, compare, restore, visibility.
Input schema
{
"anyOf": [
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "list"
},
"search": {
"type": "string",
"description": "Search playbooks by name or description (for list)"
},
"limit": {
"type": "number",
"minimum": 1,
"maximum": 100,
"description": "Maximum playbooks to return (1-100, default 50)"
},
"offset": {
"type": "number",
"minimum": 0,
"description": "Pagination offset (default 0)"
}
},
"required": [
"action"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "get"
},
"name": {
"type": "string",
"minLength": 1
},
"owner": {
"type": "string",
"description": "Owner handle or id when reading someone else's public playbook; defaults to you"
},
"revision": {
"type": "number",
"description": "Revision number to read or restore (for get and restore)"
}
},
"required": [
"action",
"name"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "save"
},
"name": {
"type": "string",
"minLength": 1
},
"content": {
"type": "string"
},
"title": {
"type": "string",
"description": "Human-readable name (for save)"
},
"description": {
"type": "string",
"description": "What this playbook is for (for save)"
}
},
"required": [
"action",
"name",
"content"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "delete"
},
"name": {
"type": "string",
"minLength": 1
}
},
"required": [
"action",
"name"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "history"
},
"name": {
"type": "string",
"minLength": 1
},
"owner": {
"type": "string",
"description": "Owner handle or id when reading someone else's public playbook; defaults to you"
}
},
"required": [
"action",
"name"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "compare"
},
"name": {
"type": "string",
"minLength": 1
},
"fromRevision": {
"type": "number"
},
"toRevision": {
"type": "number"
},
"owner": {
"type": "string",
"description": "Owner handle or id when reading someone else's public playbook; defaults to you"
}
},
"required": [
"action",
"name",
"fromRevision",
"toRevision"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "restore"
},
"name": {
"type": "string",
"minLength": 1
},
"revision": {
"type": "number"
}
},
"required": [
"action",
"name",
"revision"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "visibility"
},
"name": {
"type": "string",
"minLength": 1
},
"visibility": {
"type": "string",
"enum": [
"private",
"public"
]
}
},
"required": [
"action",
"name",
"visibility"
],
"additionalProperties": false
}
],
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object"
}Result: Action-specific playbook data.
{
"action": "list",
"limit": 20,
"offset": 0
}artifacts
Manage static HTML artifacts.
Actions: token, upload, update, delete, list, stats.
Input schema
{
"anyOf": [
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "token"
},
"ttlMinutes": {
"type": "number",
"minimum": 1,
"maximum": 1440,
"description": "Token expiration in minutes (1-1440, default 60)"
}
},
"required": [
"action"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "upload"
},
"name": {
"type": "string",
"minLength": 1
},
"executionId": {
"type": "string",
"description": "Link inline upload to an execution; for HTTP upload send executionId in the body"
},
"content": {
"type": "string",
"minLength": 1
}
},
"required": [
"action",
"name",
"content"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "update"
},
"uuid": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"description": "Artifact name (required for upload action)"
},
"content": {
"type": "string",
"minLength": 1
}
},
"required": [
"action",
"uuid",
"content"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "delete"
},
"uuid": {
"type": "string",
"minLength": 1
}
},
"required": [
"action",
"uuid"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "list"
},
"limit": {
"type": "number",
"minimum": 1,
"maximum": 100,
"description": "Maximum artifacts to return (1-100, default 50)"
},
"offset": {
"type": "number",
"minimum": 0,
"description": "Pagination offset (default 0)"
}
},
"required": [
"action"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "stats"
}
},
"required": [
"action"
],
"additionalProperties": false
}
],
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object"
}Result: Artifact metadata, quota data, or a token.
{
"action": "list",
"limit": 20,
"offset": 0
}settings
Read or update user settings.
Actions: get, set, list.
Input schema
{
"anyOf": [
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "get"
}
},
"required": [
"action"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "get"
},
"key": {
"type": "string",
"minLength": 1,
"pattern": "\\S"
}
},
"required": [
"action",
"key"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "get"
},
"category": {
"type": "string",
"minLength": 1,
"pattern": "\\S"
}
},
"required": [
"action",
"category"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "set"
},
"key": {
"type": "string",
"minLength": 1,
"pattern": "\\S"
},
"value": {}
},
"required": [
"action",
"key",
"value"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "list"
},
"category": {
"type": "string",
"minLength": 1,
"pattern": "\\S",
"description": "Category filter for get and list; do not combine with key for get"
}
},
"required": [
"action"
],
"additionalProperties": false
}
],
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object"
}Result: Masked setting data or an update result.
{
"action": "get",
"key": "telegram.enabled"
}{
"action": "get",
"category": "notifications"
}{
"action": "get"
}help
Read runtime documentation and the factual tool reference.
Input schema
{
"type": "object",
"properties": {
"topic": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
],
"description": "Documentation topic(s) to retrieve. Call without a topic to discover the current topics and accepted aliases."
}
},
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Result: Markdown documentation.
{
"topic": "tools"
}Behavioral guidance
Section titled “Behavioral guidance”The catalog defines accepted inputs. These topic owners explain authority, durable state and effects that a schema alone cannot establish.
Choose the tool group and its exact action branch before constructing arguments. Fields from a
different action are refused; an absent field, null, false and an empty value are distinct.
codespace_search, codespace_upload and codespace_download have one purpose and no action
field. For native input use the declared top-level file or stdin_file field, preserving the
host’s descriptor and metadata unchanged. Native-file metadata in the published schema identifies
that field; it does not make the field optional for an action that requires it.
User communication
Section titled “User communication”communication (send) uses the authenticated user’s configured channels; callers do not supply recipient credentials or arbitrary headers. Provider limits apply (ordinary Telegram text: 4096 characters).
For communication (deliver), pass the host’s native file descriptor and metadata unchanged. An explicitly selected registered controller is never replaced because another is available. communication (deliver_publication) addresses the owner through an existing immutable publication. Publication does not send a message; delivery neither consumes nor renews it. Reads remain subject to expiry and current authority.
The owner retains bytes and the original receipt. Cloud Moira authorizes the channel and streams to its fixed vendor transport without retaining a native-file copy. The owner validates the complete file/text plan before staging; unsupported explicit kinds are refused, not silently changed. Collect the returned original operation with communication (collect). If its first reply was lost, find candidates at that owner and choose the original explicitly, even for one match. Absence or an unavailable observation does not establish that delivery never happened. See delivery recovery.
Workspace purposes and references
Section titled “Workspace purposes and references”Discovery returns opaque workspace, controller, target and installation references. Copy them unchanged; an address is not authority. Lifecycle conflicts require a fresh observation and deliberate decision, including renewed confirmation for deletion.
Commands use argv or script; native stdin requires codespace_terminal (run_native). Each deliberate uncontrolled call is a distinct intent: command text cannot deduplicate a lost first reply. Collect original operations/processes through the originating group’s collect action and returned references; find discovers candidates at that owner without submitting work. Known uncertain outcomes project as unconfirmed; a confirmed refusal is completed with outcome.ok:false. Neither permits automatic replay or changes the retained receipt. codespace (resume) continues only the original retained private-repository setup, not commands or replacement repositories. Lifecycle uses codespace with action: "lifecycle" and a separate operation of start, stop or resume_setup.
File reads return complete UTF-8 characters and checked references/cursors. Create requires absence; replacement checks complete expected text or an observed reference; patches match text against one original without caller-computed offsets or hashes. Upload needs a native descriptor and explicit create/checked replacement target. Download publishes the complete file, not just an observed prefix. Observation windows do not impose a command deadline. See workspace and file troubleshooting and workspace patterns.
Workflow discovery and execution
Section titled “Workflow discovery and execution”Follow the Agent Guide for prepare/execute, current Step attempt identity, exact replay, stale reconciliation, input schema and metadata revisions. Use Troubleshooting for diagnose/recover; recovery cannot replay effects, reopen a terminal run or bypass a healthy execution’s step.
A step response is evidence of stored execution state, not proof that the agent performed its directive. A missing value, an empty value and a rejected answer are distinct. Materialize archive custody, owner collection, fallback and completion are specified in Materialize. Task names and one-use progress image grants are specified in Workflows.
Stopping an execution
Section titled “Stopping an execution”Use the Agent Guide’s guarded stop operation for cancellation of a running workflow. It records a permanent stopped result, not successful completion, and does not stop active child runs. cancel-execution is for a blocked start; it is not a substitute for stopping a running execution.
Workflow definitions and reconciliation
Section titled “Workflow definitions and reconciliation”The Agent Guide owns definition reads and mutations, pagination and administrator reconciliation. Definition mutation is not workflow execution. Use Workflow Management Flow for semantic authoring and conflict resolution.
A MCP lock belongs to the current user and requires a running execution and trusted Telegram delivery. No skip flag bypasses PIN delivery; failed delivery leaves no usable active lock. MCP responses never disclose the PIN. The separate authenticated Web creation response shows it once to the owner. See lock nodes.
Settings and notes
Section titled “Settings and notes”The Agent Guide owns setting selectors, masking and validation. Masked secrets are not replacement values. Notes owns versioned user-scoped text, soft deletion and configurable storage/version/key/tag limits.
Playbooks
Section titled “Playbooks”Playbooks are named reusable behavioral text. Publication grants authenticated reading of the owner’s text, not mutation rights. Names are scoped to an account; saving or restoring creates a revision subject to configured retention and size limits. Name another owner’s handle or ID explicitly when reading their public playbook.
Public artifacts and workflow files
Section titled “Public artifacts and workflow files”Artifacts owns public static HTML, upload grants, expiry, user quotas and ownership. Use workflow actions upload and download for short-lived workflow JSON import/export grants; multipart upload uses field workflow. Ordinary workflow inspection and mutation use the other workflow actions.
Development codespaces
Section titled “Development codespaces”Choose one provider for discovery; unrelated providers or billing must not delay it. Use returned references and current permissions for lifecycle operations, repository admission and Git authority. Never substitute a reachable controller for the selected registered owner. Idle/provider limits and provider diagnostics are explained in Self-hosting and Troubleshooting.
Direct guest terminal access
Section titled “Direct guest terminal access”Use the supported guest CLI for an authorized codespace. Preserve full operation output and daemon diagnostics rather than inferring success from a shell exit or the existence of a workspace. resume_setup continues the same proven guest lifetime; it does not authorize VM replacement. See Troubleshooting.
Runtime help
Section titled “Runtime help”help() discovers English topics and aliases; help({ topic: "tools" }) renders this same typed catalog. It is not a reader of effective database-overridden system instructions. See Agent Instructions for the canonical file default.
Related documentation
Section titled “Related documentation”- Agent Guide — execution and tool-use procedures
- Troubleshooting — failures and uncertain outcomes
- Writing workflows — authored graph contracts