Skip to content
All tools

recipe_run

Skills / Recipes · macOS · Windows

Effect: execute (strongest supported action). Status: gated.

Gated means the tool requires an installed app, a connected account, permission, or runtime availability. Check those requirements on the listed platform before using it.

macOS

Purpose

Executes a recipe end to end: binds params, runs each step's tool in order via the registry, persists the run (see recipe_runs), and returns each step's result plus any markers_path. Recipes with state-changing steps (write/send/delete) PREVIEW first — call again with confirm:true to run; read-only recipes run immediately. That confirmation starts the run and nothing else: a step cannot confirm itself. `confirm` in a step's args is ignored (the preview and the run report mark that step confirm_ignored), so a step whose tool asks for its own confirmation answers with its preview and is NOT executed (the run report marks it previewed and lists it in previewed_steps) — run that tool directly to do it. A step that errors (an error in its answer, or a refusal) stops the run and is reported (stopped_at, with the step's error_key); a step whose tool this Mac does not offer in tools/list is refused (tool_not_advertised). Either stops the run unless that step is marked "optional": true — then the error is recorded in its result and in skipped_optional, and the run continues.

Required inputs

Permissions and confirmation

Explicit confirmation parameter: inspect the schema and tool description before any real call. The documentation example keeps confirm false. Obtain user authorization before performing the action.

Full input schema — macOS
{
  "properties": {
    "confirm": {
      "description": "Set true to execute a recipe that has state-changing steps; read-only recipes ignore it.",
      "type": "boolean"
    },
    "name": {
      "description": "Name of the saved skill (recipe) to run, exactly as recipe_list reports it.",
      "type": "string"
    },
    "params": {
      "description": "Param overrides (merged over the recipe defaults).",
      "type": "object"
    }
  },
  "required": [
    "name"
  ],
  "type": "object"
}

Documentation example

Do not execute this example. These concrete inputs refer to a fictional demonstration dataset. Resolve real handles and obtain user authorization before any real call.

{
  "confirm": false,
  "name": "Demo morning brief"
}

Windows

Purpose

Executes a saved recipe end to end: binds params, runs each step's tool in order, records the run (see recipe_runs), and returns each step's result. Confirm gate: without confirm:true it returns a DRY-RUN PREVIEW of the ordered steps with their bound args; call again with confirm:true to execute. A step that errors stops the run and is reported (stopped_at), unless that step is marked "optional": true — then the error is recorded in its result and in skipped_optional, and the run continues. A step cannot confirm itself: confirm in a step's arguments is ignored (the step says confirm_ignored), so a step whose tool asks for confirmation (to send, delete, replace a file, run a command) returns that tool's preview and changes nothing; to make the change, call that tool directly after the user approves.

Required inputs

Permissions and confirmation

Explicit confirmation parameter: inspect the schema and tool description before any real call. The documentation example keeps confirm false. Obtain user authorization before performing the action.

Full input schema — Windows
{
  "properties": {
    "confirm": {
      "description": "Set true to execute; without it a dry-run preview is returned.",
      "type": "boolean"
    },
    "name": {
      "description": "Recipe name (from recipe_list).",
      "type": "string"
    },
    "params": {
      "description": "Param overrides (merged over the recipe defaults).",
      "type": "object"
    }
  },
  "required": [
    "name"
  ],
  "type": "object"
}

Documentation example

Do not execute this example. These concrete inputs refer to a fictional demonstration dataset. Resolve real handles and obtain user authorization before any real call.

{
  "confirm": false,
  "name": "Demo morning brief"
}