Documentation menu

Files, previews and local runtime

On this page

Inspect files before editing them. Local process tools require a stdio connection and a local target.

Use these tools

  1. Call the relevant read or status tool first.
  2. Review the target and required arguments.
  3. Run one intended action, with explicit human confirmation where required.
  4. Inspect status or re-read the affected resource afterward.

Inputs below describe the public contract. Your connected server’s current tool list is authoritative. Some tools require a particular host, target, inference mode or plan. Identifiers are values returned by earlier tools; do not invent them.

list_files

The generated project’s files.

Read the returned resource and use its current values when planning the next action.

ArgumentRequiredType or accepted values

| projectId | No | string |

| kind | No | sources, stories, meta, all |

| category | No | ba, ux, ui |

Operation: read-only.

Available setups: stdio, cloud project, cloud inference; stdio, cloud project, delegated inference; hosted HTTP.

The machine-readable tool contracts include nested argument schemas.

read_file

Read one generated file.

Read the returned resource and use its current values when planning the next action.

ArgumentRequiredType or accepted values

| projectId | No | string |

| path | Yes | string; minLength 1; maxLength 512 |

Operation: read-only.

Available setups: stdio, cloud project, cloud inference; stdio, cloud project, delegated inference; hosted HTTP.

The machine-readable tool contracts include nested argument schemas.

write_file

Write one generated file.

Writes source content and can affect the current app. Read the existing file and keep private credentials out of source.

ArgumentRequiredType or accepted values

| projectId | No | string |

| path | Yes | string; minLength 1; maxLength 512 |

| content | Yes | string |

Operation: can change state or start work; destructive effects are possible.

Available setups: stdio, cloud project, cloud inference; stdio, cloud project, delegated inference; hosted HTTP.

The machine-readable tool contracts include nested argument schemas.

delete_file

Delete one generated file.

Destructive file deletion. Check the path and dependencies before person-authorized confirmation.

ArgumentRequiredType or accepted values

| projectId | No | string |

| path | Yes | string; minLength 1; maxLength 512 |

| confirm | Yes | boolean |

Operation: can change state or start work; destructive effects are possible.

Available setups: stdio, cloud project, cloud inference; stdio, cloud project, delegated inference; hosted HTTP.

The machine-readable tool contracts include nested argument schemas.

preview_control

Start, restart, stop or rebuild the preview.

Changes the preview runtime, not production. Follow the returned status and review a failed build before continuing.

ArgumentRequiredType or accepted values

| projectId | No | string |

| action | Yes | start, restart, stop, rebuild |

Operation: can change state or start work.

Available setups: stdio, cloud project, cloud inference; stdio, cloud project, delegated inference; hosted HTTP.

The machine-readable tool contracts include nested argument schemas.

local_status

Is this machine ready to run the app.

Read the returned resource and use its current values when planning the next action.

Arguments: none ({}).

Operation: read-only.

Available setups: stdio, local project, cloud inference; stdio, local project, delegated inference.

The machine-readable tool contracts include nested argument schemas.

run_local

Build and start the app on this machine.

Starts the selected local app, with a build when requested. Read local_status and local_setup_guide first.

ArgumentRequiredType or accepted values

| build | No | boolean |

Operation: can change state or start work.

Available setups: stdio, local project, cloud inference; stdio, local project, delegated inference.

The machine-readable tool contracts include nested argument schemas.

stop_local

Stop the app on this machine.

Stops the local app managed by this connection. It does not stop a hosted production site.

Arguments: none ({}).

Operation: can change state or start work.

Available setups: stdio, local project, cloud inference; stdio, local project, delegated inference.

The machine-readable tool contracts include nested argument schemas.

local_setup_guide

How to run the generated app on this machine.

Read the returned resource and use its current values when planning the next action.

Arguments: none ({}).

Operation: read-only.

Available setups: stdio, local project, cloud inference; stdio, local project, delegated inference.

The machine-readable tool contracts include nested argument schemas.

set_local_service

Record the database or queue the user chose.

Stores the chosen database and Valkey service settings. Supply private connection values through an appropriate secret channel.

ArgumentRequiredType or accepted values

| databaseUrl | No | string |

| valkeyUrl | No | string |

| schema | No | string |

Operation: can change state or start work.

Available setups: stdio, local project, cloud inference; stdio, local project, delegated inference.

The machine-readable tool contracts include nested argument schemas.

MCP home · Recovery workflow · Costs

Names and marks

Valkey is a Linux Foundation project. Its name and marks are used to identify the referenced technology. Usage policy. OwlMeans documentation does not imply sponsorship or endorsement by those owners.