This document is generated from ops/**/op.json. Do not edit by hand.
Delete one component-scoped cache value.
native 1.0.0 effect: write approval: never
Native Op over Cache Service delete_value()
Inputs:
component_id(string) The canonical component id namespace for the cache key.key(string) The cache key within the component namespace.
Outputs:
boolean: True when the cache delete operation completes.
Get one component-scoped cache value by key.
native 1.0.0 effect: read approval: never
Native Op over Cache Service get_value()
Inputs:
component_id(string) The canonical component id namespace for the cache key.key(string) The cache key within the component namespace.
Outputs:
object | null
Peek next component-scoped queue value without removal.
native 1.0.0 effect: read approval: never
Native Op over Cache Service peek_queue()
Inputs:
component_id(string) The canonical component id namespace for the queue.queue(string) The queue name within the component namespace.
Outputs:
object | null
Pop one component-scoped queue value using FIFO order.
native 1.0.0 effect: write approval: never
Native Op over Cache Service pop_queue()
Inputs:
component_id(string) The canonical component id namespace for the queue.queue(string) The queue name within the component namespace.
Outputs:
object | null
Push one component-scoped queue value.
native 1.0.0 effect: write approval: never
Native Op over Cache Service push_queue()
Inputs:
component_id(string) The canonical component id namespace for the queue.queue(string) The queue name within the component namespace.value(object) The JSON-serializable value to enqueue.
Outputs:
component_id(string) The canonical component id namespace for the queue.queue(string) The queue name within the component namespace.size(integer) The queue depth after the enqueue operation.
Set one component-scoped cache value.
native 1.0.0 effect: write approval: never
Native Op over Cache Service set_value()
Inputs:
component_id(string) The canonical component id namespace for the cache key.key(string) The cache key within the component namespace.value(object) The JSON-serializable value to persist.ttl_seconds(integer | null, optional) Optional TTL override in seconds; null uses the service default.
Outputs:
component_id(string) The canonical component id namespace for the cache key.key(string) The cache key within the component namespace.value(object) The JSON value that was persisted.ttl_seconds(integer | null) The effective TTL applied to the key; null means the key does not expire.
Create one commitment, reminder, task, or loop-closure obligation.
native 1.0.0 effect: write approval: always
Native Op over Commitment Service create_commitment()
Inputs:
description(string)provenance_reference(string | null, optional)ingestion_id(string | null, optional)source(string | null, optional)due_by(date-time | object | null, optional)due_timezone(string | null, optional)importance(integer, optional)effort_provided(integer, optional)effort_inferred(integer | null, optional)confidence(number | null, optional)requested_by(string, optional)
Outputs:
object
Extract zero or more commitment candidate signals from arbitrary text.
native 1.0.0 effect: read approval: never
Native Op over Commitment Service extract_commitment_candidates()
Inputs:
text(string) Arbitrary source text to scan for commitment signals.context(string, optional) Optional background context (e.g. conversation metadata, speaker roles) that may help the model interpret the text.
Outputs:
candidates(array[object]) Extracted commitment candidates, ordered by descending confidence.
Read one commitment by id.
native 1.0.0 effect: read approval: never
Native Op over Commitment Service get_commitment()
Inputs:
commitment_id(string)
Outputs:
object
Read one commitment with progress and transition history.
native 1.0.0 effect: read approval: never
Native Op over Commitment Service get_commitment_history()
Inputs:
commitment_id(string)
Outputs:
object
List commitments with optional lifecycle-state filtering.
native 1.0.0 effect: read approval: never
Native Op over Commitment Service list_commitments()
Inputs:
state(string | null, optional)limit(integer, optional)cursor(string | null, optional)
Outputs:
object
Record progress against one commitment.
native 1.0.0 effect: write approval: always
Native Op over Commitment Service record_progress()
Inputs:
commitment_id(string)provenance_reference(string | null, optional)occurred_at(date-time)summary(string)snippet(string | null, optional)
Outputs:
object
Run commitment miss detection for one commitment or all due commitments.
native 1.0.0 effect: execute approval: never
Native Op over Commitment Service run_miss_detection()
Inputs:
commitment_id(string | null, optional) One commitment id to check; omitted scans all due commitments.
Outputs:
checked_count(integer) Number of due open commitments examined.missed_count(integer) Number of commitments transitioned to MISSED.notified_count(integer) Number of missed notifications delivered.commitment_ids(array[string]) Commitment ids transitioned during this run.
Scan recent inbound conversation turns for commitment candidates.
native 1.0.0 effect: execute approval: never
Native Op over Commitment Service run_turn_scanner()
Inputs: None
Outputs:
turns_scanned(integer) Number of inbound turns examined.candidates_extracted(integer) Number of commitment candidates extracted.candidates_ingested(integer) Number of candidates ingested through the creation pipeline.errors_encountered(integer) Number of per-turn errors encountered.last_turn_id(string | null) Id of the last turn processed in this batch.
Transition one commitment to another lifecycle state.
native 1.0.0 effect: write approval: always
Native Op over Commitment Service transition_commitment()
Inputs:
commitment_id(string)to_state(string)requested_by(string)reason(string | null, optional)confidence(number | null, optional)
Outputs:
object
Update one commitment without changing its lifecycle state.
native 1.0.0 effect: write approval: always
Native Op over Commitment Service update_commitment()
Inputs:
commitment_id(string)description(string | null, optional)provenance_reference(string | null, optional)ingestion_id(string | null, optional)source(string | null, optional)due_by(date-time | object | null, optional)due_timezone(string | null, optional)importance(integer | null, optional)effort_provided(integer | null, optional)effort_inferred(integer | null, optional)reviewed_at(date-time | null, optional)
Outputs:
object
Queue one subagent invocation for asynchronous execution and return its identifier.
native 1.0.0 effect: execute approval: never
Native Op over Delegation Service invoke()
Inputs:
prompt(string) The task instruction the subagent should accomplish.context_text(string | null, optional) Optional inline scratch context appended to the subagent system prompt.context_object_refs(array[string], optional, default=[]) Object Service refs the subagent may resolve for additional context.personality_id(string, optional, default='subagent') Personality template id under lib/sdk/personalities (default 'subagent').tool_allowlist(array[string] | null, optional) Optional explicit allowlist of op_ids the subagent may invoke.max_turns(integer, optional, default=8) Hard ceiling on tool-loop turns.budget_tokens(integer | null, optional) Hard ceiling on total tokens consumed across all turns.max_wallclock_seconds(integer | null, optional) Hard ceiling on wallclock seconds from claim to terminal.parent_invocation_id(string | null, optional) Optional parent invocation id; cascade-cancel propagates here.
Outputs:
invocation_id(string)
Request cancellation of one queued or running subagent invocation.
native 1.0.0 effect: execute approval: never
Native Op over Delegation Service cancel()
Inputs:
invocation_id(string) The ULID identifier of the invocation to cancel.reason(string, optional) Cancel reason code (default 'manual').
Outputs:
accepted(boolean)
Read the current status projection for one subagent invocation.
native 1.0.0 effect: read approval: never
Native Op over Delegation Service get_status()
Inputs:
invocation_id(string) The ULID identifier of the invocation.
Outputs:
invocation_id(string)status(string)cancel_reason(string | null, optional)tokens_in(integer)tokens_out(integer)turn_count(integer)started_at(string | null, optional)completed_at(string | null, optional)
Spawn one subagent to accomplish a task and block until it returns a result.
native 1.0.0 effect: execute approval: never
Native Op over Delegation Service invoke_and_wait()
Inputs:
prompt(string) The task instruction the subagent should accomplish.context_text(string | null, optional) Optional inline scratch context appended to the subagent system prompt.context_object_refs(array[string], optional, default=[]) Object Service refs the subagent may resolve for additional context.personality_id(string, optional, default='subagent') Personality template id under lib/sdk/personalities (default 'subagent').tool_allowlist(array[string] | null, optional) Optional explicit allowlist of op_ids the subagent may invoke.max_turns(integer, optional, default=8) Hard ceiling on tool-loop turns.budget_tokens(integer | null, optional) Hard ceiling on total tokens consumed across all turns.max_wallclock_seconds(integer | null, optional) Hard ceiling on wallclock seconds from claim to terminal.parent_invocation_id(string | null, optional) Optional parent invocation id; cascade-cancel propagates here.timeout_seconds(number | null, optional) Maximum seconds to block waiting for terminal state.
Outputs:
invocation_id(string)status(string)final_response(string | null, optional)cancel_reason(string | null, optional)tokens_in(integer)tokens_out(integer)turn_count(integer)
Block until a previously queued subagent invocation reaches terminal state.
native 1.0.0 effect: read approval: never
Native Op over Delegation Service wait()
Inputs:
invocation_id(string) The ULID identifier of the invocation to wait on.timeout_seconds(number | null, optional) Maximum seconds to block. Returns the latest snapshot at timeout.
Outputs:
invocation_id(string)status(string)final_response(string | null, optional)cancel_reason(string | null, optional)tokens_in(integer)tokens_out(integer)turn_count(integer)
Persist a batch of embedding vectors for chunk and spec pairs.
native 1.0.0 effect: write approval: never
Native Op over Embedding Service upsert_embedding_vectors()
Inputs:
items(array[object]) Batch of chunk/spec/vector inputs to persist.
Outputs:
array[object]: Persisted embedding materialization records.
Generate embedding vectors for a batch of text chunks.
native 1.0.0 effect: read approval: never
Native Op over Language Service embed_batch()
Inputs:
texts(array[string]) The text chunks to embed.profile(string, optional) Optional embedding profile override.
Outputs:
array[object]: One embedding vector result per input text chunk.
Advance one ingestion from a named stage through the remaining pipeline.
native 1.0.0 effect: execute approval: never
Native Op over Ingestion Service advance_ingestion()
Inputs:
ingestion_id(string) The ingestion identifier to advance.from_stage(string) The first stage to consider: store, extract, normalize, or anchor.force_target(boolean, optional) Re-run the requested target stage even if its latest run succeeded.
Outputs:
id(string) The ingestion identifier.status(string) The current ingestion lifecycle status.source_type(string) The original source type.source_uri(string | null) The original source URI, if any.source_actor(string | null) The originating actor, if any.capture_time(string) The timezone-aware capture timestamp.mime_type(string | null) The source MIME type, if any.last_error(string | null) The most recent ingestion error, if any.created_at(string) The record creation timestamp.updated_at(string) The record update timestamp.
Index anchored ingestion artifacts through derived embedding services.
native 1.0.0 effect: execute approval: never
Native Op over Ingestion Service index_anchored_ingestion()
Inputs:
ingestion_id(string) The ingestion identifier whose anchored artifacts should be indexed.indexing_run_id(string) The ingestion-owned indexing run identifier to update.
Outputs:
ingestion_id(string) The ingestion identifier that was indexed.indexing_run_id(string) The ingestion-owned indexing run identifier.source_count(integer) Number of Embedding sources created or updated.chunk_count(integer) Number of chunks created or updated.embedding_count(integer) Number of embedding vectors persisted.failed_count(integer) Number of anchored artifacts that failed indexing.
List ingestions with optional status filtering.
native 1.0.0 effect: read approval: never
Native Op over Ingestion Service list_ingestions()
Inputs:
status(string | null, optional)limit(integer, optional)cursor(string | null, optional)
Outputs:
object
Replay an ingestion from a named stage forward.
native 1.0.0 effect: write approval: always
Native Op over Ingestion Service replay_ingestion()
Inputs:
ingestion_id(string)from_stage(string)
Outputs:
object
Return stage-ordered artifact outcomes for one ingestion.
native 1.0.0 effect: read approval: never
Native Op over Ingestion Service get_ingestion_results()
Inputs:
ingestion_id(string)
Outputs:
object
Retry one failed ingestion stage.
native 1.0.0 effect: write approval: always
Native Op over Ingestion Service retry_ingestion_stage()
Inputs:
ingestion_id(string)stage(string)
Outputs:
object
Return the current pipeline status for one ingestion.
native 1.0.0 effect: read approval: never
Native Op over Ingestion Service get_ingestion_status()
Inputs:
ingestion_id(string)
Outputs:
object
Submit one content item to the ingestion pipeline.
native 1.0.0 effect: write approval: always
Native Op over Ingestion Service submit_ingestion()
Inputs:
source_type(string)source_uri(string | null, optional)source_actor(string | null, optional)payload(object | null, optional)existing_object_key(string | null, optional)capture_time(string)mime_type(string | null, optional)
Outputs:
object
Cancel one scheduled job and clear its next run time.
native 1.0.0 effect: write approval: always
Native Op over Job Service cancel_job()
Inputs:
job_id(string) Job id to cancel.
Outputs:
object: Job mutation result containing the canceled job and audit row.
Create a scheduled job that invokes one op in the future or on a recurrence.
native 1.0.0 effect: write approval: always
Native Op over Job Service create_job()
Inputs:
summary(string) Short human-readable description of the scheduled job.details(string | null, optional) Optional longer explanation of the job's purpose.origin_reference(string | null, optional) Optional caller-owned reference used to correlate this job with an external object.schedule_type(string) Schedule discriminator. Must match the definition type.timezone(string) IANA timezone used to interpret calendar schedules, for example America/New_York or UTC.definition(object) Schedule definition. one_time uses run_at; interval uses interval_count and interval_unit; calendar_rule uses rrule; conditional uses predicate fields.job_action(object) Action to execute. Currently supports {type: op_invocation, op_id, input_payload}.start_state(string, optional) Initial lifecycle state. Use active when the schedule should begin firing.
Outputs:
object: Job mutation result containing the created job and audit row.
Read one scheduled job by id.
native 1.0.0 effect: read approval: never
Native Op over Job Service get_job()
Inputs:
job_id(string) Job id to read.
Outputs:
object: The requested job record.
List scheduled jobs with optional state and schedule-type filters.
native 1.0.0 effect: read approval: never
Native Op over Job Service list_jobs()
Inputs:
state(string | null, optional) Optional lifecycle-state filter such as active, paused, canceled, completed, or draft.schedule_type(string | null, optional) Optional schedule-type filter such as one_time, interval, calendar_rule, or conditional.limit(integer, optional) Maximum number of jobs to return.cursor(string | null, optional) Pagination cursor returned by a previous list call.
Outputs:
object: Job list result containing matching job records and the next cursor.
Queue an immediate execution for an active or paused scheduled job.
native 1.0.0 effect: write approval: always
Native Op over Job Service run_job_now()
Inputs:
job_id(string) Job id to execute immediately.
Outputs:
object: Run-now result containing the queued execution id.
Delete one persisted object by canonical object key.
native 1.0.0 effect: write approval: always
Native Op over Object Service delete_object()
Inputs:
object_key(string) The canonical object key to delete.
Outputs:
boolean: True when the object delete operation completes.
Read metadata for one persisted object by canonical object key.
native 1.0.0 effect: read approval: never
Native Op over Object Service stat_object()
Inputs:
object_key(string) The canonical object key to inspect.
Outputs:
ref(object)metadata(object)
Summarize all recent turns and compress context to summary-only.
native 1.0.0 effect: execute approval: never
Native Op over Recall Service compact_dialogue()
Inputs:
session_id(string) The session to compact
Outputs:
id(string) Session ULIDdialogue_summary(string | null) Updated rolling summarydialogue_summary_token_count(integer | null) Token count of new summarydialogue_start_turn_id(string | null) Advanced frontier pointer
Create a fresh Recall session.
native 1.0.0 effect: execute approval: never
Native Op over Recall Service create_session()
Inputs: None
Outputs:
id(string) The new session ULIDfocus(string | null) Always null for a fresh sessionfocus_token_count(integer | null) Always null for a fresh sessiondialogue_summary(string | null) Always null for a fresh sessiondialogue_summary_token_count(integer | null) Always null for a fresh sessiondialogue_start_turn_id(string | null) Always null for a fresh sessioncreated_at(string) ISO-8601 creation timestampupdated_at(string) ISO-8601 update timestamp
Flush one pending batch by key and deliver consolidated summary.
native 1.0.0 effect: external approval: never
Native Op over Relay Service flush_batch()
Inputs:
batch_key(string) The batch key to flush.actor(string, optional) Actor identity for routing context. Defaults to 'operator'.channel(string, optional) Channel identifier. Defaults to service routing default.title(string, optional) Optional title for flushed summary notification.
Outputs:
decision(string) Router decision outcome: sent or suppressed.delivered(boolean) Whether a message was delivered to channel.detail(string) Human-readable routing detail.suppressed_reason(string, optional) Suppression reason when no batch is available.batched_count(integer, optional) Pending item count when relevant.notification(object, optional) Normalized routed notification payload.
Route one outbound notification and decide suppress/send/batch.
native 1.0.0 effect: external approval: never
Native Op over Relay Service route_notification()
Inputs:
actor(string, optional) Actor identity for routing context. Defaults to 'operator'.channel(string, optional) Channel identifier. Defaults to service routing default.title(string, optional) Optional title rendered above message content.message(string) The notification body to route.dedupe_key(string, optional) Suppress duplicate sends within configured dedupe window.batch_key(string, optional) Queue into batch instead of immediate send.force(boolean, optional) Bypass dedupe, batch, and rate-limit suppression checks. Defaults to false.conversational_memory(object | null, optional) Recall-owned conversational outbound metadata with session_id, model, provider, token_count, and reasoning_level. Persisted only when a conversational channel actually sends.
Outputs:
decision(string) Router decision outcome: sent, suppressed, or batched.delivered(boolean) Whether a message was delivered to channel.detail(string) Human-readable routing detail.suppressed_reason(string, optional) Suppression reason when decision is suppressed.batched_count(integer, optional) Pending item count when decision is batched.notification(object, optional) Normalized routed notification payload.
Dispatch one coding task and return immediately with a RUNNING task row.
native 1.0.0 effect: external approval: never
Native Op over Software Service run_task_async()
Inputs:
workspace_id(string) Identifier of the registered workspace to operate on.prompt(string) Natural-language description of the task for the coding executor.executor(string | null, optional) Override the workspace's default executor (claude_code | codex | opencode).
Outputs:
id(string) Task identifier.workspace_id(string) Workspace identifier the task was dispatched against.executor(string) The coding executor used for this task.branch(string) Branch name created for the task worktree.prompt_object_ref(string | null, optional) Object Store reference holding the prompt text; null when Object Store is not wired.status(string) Initial task status (running).started_at(string) ISO8601 task start timestamp.finished_at(string, optional) Always null on async dispatch; populated only after the task reaches terminal.commit_sha(string, optional) Always null on async dispatch.test_passed(boolean, optional) Always null on async dispatch.stdout_object_ref(string, optional) Populated by the background driver when the executor exits.stderr_object_ref(string, optional) Populated by the background driver when the executor exits.test_stdout_object_ref(string, optional) Object Store reference for test stdout; null until captured.test_stderr_object_ref(string, optional) Object Store reference for test stderr; null until captured.termination_reason(string, optional) Populated when the task terminates.failure_detail(string, optional) Populated on failure.
Request cancellation of one in-flight Software task.
native 1.0.0 effect: execute approval: never
Native Op over Software Service cancel_task()
Inputs:
task_id(string) The task identifier to cancel.
Outputs:
id(string) Task identifier.workspace_id(string) Workspace identifier the task was dispatched against.executor(string) The coding executor used for this task.branch(string) Branch name created for the task worktree.prompt_object_ref(string | null, optional) Object Store reference holding the prompt text; null when Object Store is not wired.status(string) Current task status.started_at(string) ISO8601 task start timestamp.finished_at(string, optional) ISO8601 task completion timestamp; null until terminal.commit_sha(string, optional) Commit SHA produced by the task; null when no commit was made.test_passed(boolean, optional) Whether the configured test_command passed; null until the test step runs.stdout_object_ref(string, optional) Object Store reference for executor stdout; null until captured.stderr_object_ref(string, optional) Object Store reference for executor stderr; null until captured.test_stdout_object_ref(string, optional) Object Store reference for test stdout; null until captured.test_stderr_object_ref(string, optional) Object Store reference for test stderr; null until captured.termination_reason(string, optional) Why the task terminated; null until terminal.failure_detail(string, optional) Human-readable failure context; null on success.
Return the current lineage row for one Software task.
native 1.0.0 effect: read approval: never
Native Op over Software Service task_status()
Inputs:
task_id(string) The task identifier to inspect.
Outputs:
id(string) Task identifier.workspace_id(string) Workspace identifier the task was dispatched against.executor(string) The coding executor used for this task.branch(string) Branch name created for the task worktree.prompt_object_ref(string | null, optional) Object Store reference holding the prompt text; null when Object Store is not wired.status(string) Current task status.started_at(string) ISO8601 task start timestamp.finished_at(string, optional) ISO8601 task completion timestamp; null until terminal.commit_sha(string, optional) Commit SHA produced by the task; null when no commit was made.test_passed(boolean, optional) Whether the configured test_command passed; null until the test step runs.stdout_object_ref(string, optional) Object Store reference for executor stdout; null until captured.stderr_object_ref(string, optional) Object Store reference for executor stderr; null until captured.test_stdout_object_ref(string, optional) Object Store reference for test stdout; null until captured.test_stderr_object_ref(string, optional) Object Store reference for test stderr; null until captured.termination_reason(string, optional) Why the task terminated; null until terminal.failure_detail(string, optional) Human-readable failure context; null on success.
Dispatch one coding task and block until terminal.
native 1.0.0 effect: external approval: never
Native Op over Software Service run_task_sync()
Inputs:
workspace_id(string) Identifier of the registered workspace to operate on.prompt(string) Natural-language description of the task for the coding executor.executor(string | null, optional) Override the workspace's default executor (claude_code | codex | opencode).
Outputs:
id(string) Task identifier.workspace_id(string) Workspace identifier the task was dispatched against.executor(string) The coding executor used for this task.branch(string) Branch name created for the task worktree.prompt_object_ref(string | null, optional) Object Store reference holding the prompt text; null when Object Store is not wired.status(string) Final task status (succeeded | failed | cancelled).started_at(string) ISO8601 task start timestamp.finished_at(string, optional) ISO8601 task completion timestamp; null when the wait timed out before terminal.commit_sha(string, optional) Commit SHA produced by the task; null when no commit was made.test_passed(boolean, optional) Whether the configured test_command passed; null until the test step runs.stdout_object_ref(string, optional) Object Store reference for executor stdout; null until captured.stderr_object_ref(string, optional) Object Store reference for executor stderr; null until captured.test_stdout_object_ref(string, optional) Object Store reference for test stdout; null until captured.test_stderr_object_ref(string, optional) Object Store reference for test stderr; null until captured.termination_reason(string, optional) Why the task terminated; null until terminal.failure_detail(string, optional) Human-readable failure context; null on success.
Block until one Software task reaches a terminal status.
native 1.0.0 effect: read approval: never
Native Op over Software Service wait_for_task()
Inputs:
task_id(string) The task identifier to wait on.max_wait_seconds(number | null, optional) Soft deadline. When the deadline elapses before terminal, returns the most recent non-terminal row with a timed-out failure envelope.
Outputs:
id(string) Task identifier.workspace_id(string) Workspace identifier the task was dispatched against.executor(string) The coding executor used for this task.branch(string) Branch name created for the task worktree.prompt_object_ref(string | null, optional) Object Store reference holding the prompt text; null when Object Store is not wired.status(string) Final task status (succeeded | failed | cancelled), or non-terminal status if max_wait_seconds elapsed.started_at(string) ISO8601 task start timestamp.finished_at(string, optional) ISO8601 task completion timestamp; null when the wait timed out before terminal.commit_sha(string, optional) Commit SHA produced by the task; null when no commit was made.test_passed(boolean, optional) Whether the configured test_command passed; null until the test step runs.stdout_object_ref(string, optional) Object Store reference for executor stdout; null until captured.stderr_object_ref(string, optional) Object Store reference for executor stderr; null until captured.test_stdout_object_ref(string, optional) Object Store reference for test stdout; null until captured.test_stderr_object_ref(string, optional) Object Store reference for test stderr; null until captured.termination_reason(string, optional) Why the task terminated; null until terminal.failure_detail(string, optional) Human-readable failure context; null on success.
List registered Software workspaces.
native 1.0.0 effect: read approval: never
Native Op over Software Service list_workspaces()
Inputs:
include_revoked(boolean, optional) If true, also return revoked workspaces. Defaults to false.
Outputs:
array[object]
Register one repository as an allowlisted Software workspace; the binary trust gate.
native 1.0.0 effect: write approval: always
Native Op over Software Service register_workspace()
Inputs:
path(string) Absolute path on the Brain Core host to the git repository root.default_executor(string | null, optional, default='claude_code') Default coding executor for tasks against this workspace (claude_code | codex | opencode).test_command(string | null, optional) Shell command run by the Service after each task to gate the commit step.max_wallclock_seconds(integer | null, optional, default=1800) Hard wallclock budget per task against this workspace.branch_prefix(string | null, optional, default='brain/software/') Branch prefix under which task branches are created.
Outputs:
id(string) Workspace identifier.path(string) Registered repository path.default_executor(string) Configured default executor.test_command(string) Configured test command.max_wallclock_seconds(integer) Configured wallclock budget.branch_prefix(string) Configured branch prefix.created_at(string) ISO8601 registration timestamp.revoked_at(string, optional) ISO8601 revocation timestamp; null while active.
Revoke trust on a registered Software workspace.
native 1.0.0 effect: write approval: always
Native Op over Software Service revoke_workspace()
Inputs:
workspace_id(string) The workspace identifier to revoke.
Outputs:
id(string) Workspace identifier.path(string) Registered repository path.default_executor(string) Configured default executor.test_command(string) Configured test command.max_wallclock_seconds(integer) Configured wallclock budget.branch_prefix(string) Configured branch prefix.created_at(string) ISO8601 registration timestamp.revoked_at(string) ISO8601 revocation timestamp.
Split text into ordered chunks.
native 1.0.0 effect: execute approval: never
Native Op over Utility Service chunk_text()
Inputs:
text(string) The text to chunk.
Outputs:
array[object]: Ordered chunks derived from the input text.
Return the current UTC and operator-local datetimes.
native 1.0.0 effect: read approval: never
Native Op over Utility Service current_datetime()
Inputs: None
Outputs:
utc_timestamp(date-time) The current UTC datetime in ISO 8601 format.local_timestamp(date-time) The current datetime in the operator's preferred timezone.local_timezone(string) The operator's preferred IANA timezone name.
Convert an ISO-like datetime from one timezone to another.
native 1.0.0 effect: read approval: never
Native Op over Utility Service convert_datetime()
Inputs:
timestamp(string)to_timezone(string)from_timezone(string | null, optional)
Outputs:
object
Parse an ISO-like datetime and return UTC plus local projections.
native 1.0.0 effect: read approval: never
Native Op over Utility Service parse_datetime()
Inputs:
timestamp(string)timezone(string | null, optional)
Outputs:
object
Compute the signed duration from now, or a supplied instant, to a target datetime.
native 1.0.0 effect: read approval: never
Native Op over Utility Service duration_until()
Inputs:
target_timestamp(string)target_timezone(string | null, optional)now_timestamp(string | null, optional)now_timezone(string | null, optional)
Outputs:
object
Append content to one markdown file.
native 1.0.0 effect: write approval: never
Native Op over Vault Service append_file()
Inputs:
file_path(string) The full path of the file to append to.content(string) The content to append to the file.if_revision(string, optional) Only append to the file if its current revision matches this value.force(boolean, optional) Force the append, ignoring revision conflicts. Defaults to false.
Outputs:
path(string) The full path of the file.content(string) The content of the file.size_bytes(integer) The size of the file in bytes.created_at(date-time | null, optional) The timestamp when the file was created.updated_at(date-time | null, optional) The timestamp when the file was last updated.revision(string) The revision identifier for the file.
Create one directory in the vault.
native 1.0.0 effect: write approval: never
Native Op over Vault Service create_directory()
Inputs:
directory_path(string) The full path of the directory to create.recursive(boolean, optional) Create parent directories if they don't exist. Defaults to false.
Outputs:
path(string) The full path of the created directory.name(string) The name of the created directory.entry_type(string) The type of the entry (will be 'directory').size_bytes(integer) The size of the entry in bytes (will be 0).created_at(date-time | null, optional) The timestamp when the directory was created.updated_at(date-time | null, optional) The timestamp when the directory was last updated.revision(string) The revision identifier for the entry.
Create one markdown file; fails when it already exists.
native 1.0.0 effect: write approval: never
Native Op over Vault Service create_file()
Inputs:
file_path(string) The full path of the file to create.content(string, optional) The initial content of the file. Defaults to empty.
Outputs:
path(string) The full path of the file.content(string) The content of the file.size_bytes(integer) The size of the file in bytes.created_at(date-time | null, optional) The timestamp when the file was created.updated_at(date-time | null, optional) The timestamp when the file was last updated.revision(string) The revision identifier for the file.
Delete one directory, optionally recursively.
native 1.0.0 effect: write approval: always
Native Op over Vault Service delete_directory()
Inputs:
directory_path(string) The full path of the directory to delete.recursive(boolean, optional) Delete the directory even if it is not empty. Defaults to false.missing_ok(boolean, optional) If true, do not raise an error if the directory does not exist. Defaults to false.use_trash(boolean, optional) If true, move the directory to a trash folder instead of permanently deleting. Defaults to true.
Outputs:
boolean: True if the directory was deleted, False otherwise.
Delete one markdown file.
native 1.0.0 effect: write approval: always
Native Op over Vault Service delete_file()
Inputs:
file_path(string) The full path of the file to delete.missing_ok(boolean, optional) If true, do not raise an error if the file does not exist. Defaults to false.use_trash(boolean, optional) If true, move the file to a trash folder instead of permanently deleting. Defaults to true.if_revision(string, optional) Only delete the file if its current revision matches this value.force(boolean, optional) Bypass the trash folder and delete immediately. Defaults to false.
Outputs:
boolean: True if the file was deleted, False otherwise.
Apply one or more line-range edits to a markdown file.
native 1.0.0 effect: write approval: never
Native Op over Vault Service edit_file()
Inputs:
file_path(string) The full path of the file to edit.edits(array[object]) A sequence of line-range edits to apply to the file.if_revision(string, optional) Only edit the file if its current revision matches this value.force(boolean, optional) Force the edit, ignoring revision conflicts. Defaults to false.
Outputs:
path(string) The full path of the file.content(string) The content of the file.size_bytes(integer) The size of the file in bytes.created_at(date-time | null, optional) The timestamp when the file was created.updated_at(date-time | null, optional) The timestamp when the file was last updated.revision(string) The revision identifier for the file.
Read one markdown file by path.
native 1.0.0 effect: read approval: never
Native Op over Vault Service get_file()
Inputs:
file_path(string) The full path of the file to read.
Outputs:
path(string) The full path of the file.content(string) The content of the file.size_bytes(integer) The size of the file in bytes.created_at(date-time | null, optional) The timestamp when the file was created.updated_at(date-time | null, optional) The timestamp when the file was last updated.revision(string) The revision identifier for the file.
List file and directory entries under one vault-relative path.
native 1.0.0 effect: read approval: never
Native Op over Vault Service list_directory()
Inputs:
directory_path(string) The path of the directory to list. Use '.' for the vault root.
Outputs:
array[object]: A list of files and directories in the specified path.
Move one file or directory path.
native 1.0.0 effect: write approval: always
Native Op over Vault Service move_path()
Inputs:
source_path(string) The full path of the file or directory to move.target_path(string) The new full path for the file or directory.if_revision(string, optional) Only move if the source's current revision matches this value.force(boolean, optional) Force the move, overwriting the target if it exists. Defaults to false.
Outputs:
path(string) The full path of the moved entry.name(string) The name of the moved entry.entry_type(string) The type of the entry ('directory' or 'file').size_bytes(integer) The size of the entry in bytes.created_at(date-time | null, optional) The timestamp when the entry was created.updated_at(date-time | null, optional) The timestamp when the entry was last updated.revision(string) The revision identifier for the entry.
Search markdown files lexically through Obsidian Local REST API.
native 1.0.0 effect: read approval: never
Native Op over Vault Service search_files()
Inputs:
query(string) The search query.directory_scope(string, optional) A directory path to limit the search to.limit(integer, optional) The maximum number of results to return. Defaults to a system-wide setting.
Outputs:
array[object]: A list of files matching the search query.
Replace markdown file content with optional optimistic precondition.
native 1.0.0 effect: write approval: never
Native Op over Vault Service update_file()
Inputs:
file_path(string) The full path of the file to update.content(string) The new content to write to the file.if_revision(string, optional) Only update the file if its current revision matches this value.force(boolean, optional) Force the update, ignoring revision conflicts. Defaults to false.
Outputs:
path(string) The full path of the file.content(string) The content of the file.size_bytes(integer) The size of the file in bytes.created_at(date-time | null, optional) The timestamp when the file was created.updated_at(date-time | null, optional) The timestamp when the file was last updated.revision(string) The revision identifier for the file.
Returns the static string 'Hello, World!'.
logic 1.0.0 effect: read approval: never
Logic Op
Inputs: None
Outputs:
string: Returns the static string 'Hello, World!'.
List configured MCP servers or MCP Ops for one server.
logic 1.0.0 effect: read approval: never
Logic Op
Inputs:
server_id(string, optional) MCP server id whose MCP Ops should be listed.
Outputs:
string: Formatted MCP server or tool status.
Read one object and return metadata plus base64-encoded content.
logic 1.0.0 effect: read approval: never
Logic Op
Inputs:
object_key(string) The canonical object key to read.
Outputs:
object(object) The authoritative object record.content_base64(string) The base64-encoded blob content.
Read one text object and return metadata plus decoded content.
logic 1.0.0 effect: read approval: never
Logic Op
Inputs:
object_key(string) The canonical object key to read.encoding(string, optional) Text encoding used to decode stored bytes. Defaults to 'utf-8'.
Outputs:
object(object) The authoritative object record.content(string) The decoded text content.encoding(string) The text encoding used for decoding.
Persist one base64-encoded blob and return object metadata plus dedupe disposition.
logic 1.0.0 effect: write approval: never
Logic Op
Inputs:
content_base64(string) The base64-encoded blob content to persist.extension(string) The file extension recorded for the object.content_type(string) The MIME type recorded for the object.original_filename(string, optional) Optional original filename metadata.source_uri(string, optional) Optional source URI metadata.
Outputs:
object(object)write_disposition(string)
Persist one text blob and return object metadata plus dedupe disposition.
logic 1.0.0 effect: write approval: never
Logic Op
Inputs:
content(string) The text content to persist.extension(string, optional) File extension recorded for the object. Defaults to 'txt'.content_type(string, optional) MIME type recorded for the object. Defaults to 'text/plain; charset=utf-8'.original_filename(string, optional) Optional original filename metadata.source_uri(string, optional) Optional source URI metadata.encoding(string, optional) Text encoding used before persistence. Defaults to 'utf-8'.
Outputs:
object(object)write_disposition(string)
Classify one dynamic op by setting its effect and/or approval.
logic 1.0.0 effect: write approval: always
Logic Op
Inputs:
op_id(string) dynamic op id to classify (e.g. eventkit--list-events).words(array[string]) one or more words drawn from the effect set (read|write|execute|external) and/or the approval set (always|never).
Outputs:
string: Confirmation message describing the persisted classification.
List all slash commands, or describe one in detail when a query is given.
logic 1.0.0 effect: read approval: never
Logic Op
Inputs:
query(string, optional) When omitted, list all slash commands. When given, exact-match on slash name, alias, or op_id returns details for that op; substring-match returns the matching subset (or details if exactly one matches).
Outputs:
string: Formatted slash-command listing or per-op detail.
End of Op Catalog