Open Orbit

Apply a recipe

Apply a catalog recipe with an Orbit MCP client, check the result, and inspect the changed page in Mockup.

Apply a recipe

Use an Orbit MCP client to apply a catalog recipe to an existing workspace, then inspect the result in Mockup.

Before you start

Connect an MCP client to Orbit. Use an app that already has a Mockup workspace.

Have the target workspace identifier and a recipe slug ready. If you do not have a slug, search the recipe catalog through GET /api/v1/recipes. Read the chosen recipe through GET /api/v1/recipes/{slug}.

Use a slug from the catalog result, not the recipe's display title. The Orbit REST API reference describes recipe discovery.

Check the recipe before you apply it

  1. Ask your MCP client to find Apply recipe, named orbit_apply_recipe.
  2. Give the client the target workspace identifier as id.
  3. Give the client the recipe slug as slug.
  4. Ask the client to call the tool with dry_run set to true.
  5. Read the returned issues and warnings.

For example, tell the client:

Use Orbit's Apply recipe tool to check the recipe I selected against my target workspace. Set dry_run to true. Show me the issues and warnings before any change.

A dry run checks the request without applying the recipe. If the response reports a problem, resolve that problem before you continue.

Apply the recipe

  1. Ask the client to use the same workspace identifier and recipe slug.
  2. Set dry_run to false.
  3. Supply an idempotency_key for this request.
  4. Call Apply recipe.
  5. Check that the response has applied set to true.
  6. Keep the returned node_ids so you can identify the new content.

If you retry an identical request, reuse the same idempotency_key. Do not send a new key for that retry.

Use the returned node_ids to identify the recipe's content. The Orbit MCP server card defines the tool's inputs and results.

Inspect the result

  1. Open the app in Orbit Studio.
  2. Open Mockup.
  3. Inspect the content from the recipe.
  4. Compare the result with the recipe you selected.

If the response does not confirm that Orbit applied the recipe, inspect issues before you retry. Do not assume that a successful connection means the recipe changed the app.

Next, edit a mockup or add a page.