Method API and MCP

The dashboard, CLI, and MCP use the same API handlers for saved Methods, versions, and run records. The API checks the signed-in organization, validates documents, and rejects conflicting writes.

Saved files and runs

Requests require a Method access token or a valid dashboard session. MCP forwards the caller’s OAuth token. Keep tokens out of Method files and logs.

Route	Purpose
`GET /api/methods`	List saved Methods.
`GET /api/methods/:id`	Read dashboard details, saved source, and version data.
`PATCH /api/methods/:id`	Change the display name with `name`.
`GET /api/methods/:id/source`	Read exact source text and its hash.
`GET /api/cli/methods/:id?version=:versionId`	Read a saved version. Without `version`, read the current version.
`PUT /api/cli/methods/:id/versions/:versionId`	Save a version by content. Supply `workflow`, `package`, `reason`, and optional `parent_version_id`. The version ID is `v_` + the first 32 hex of sha256(`METHOD_ID:package digest`): the same request again returns the same version. The first save of a new `wf_` ID (32 random hex) creates the Method. Saves from two computers both succeed and record their parents.
`POST /api/cli/methods/:id/versions/:versionId/publish`	Mark a saved version published, with `reason`. The CLI runs the issue gate and the cases first.
`GET /api/workspace/methods/:id/versions`	Read version history.
`POST /api/workspace/methods/:id/restore`	Restore `version_id` as a new version. Supply the observed `current_version_id`.
`GET /api/workspace/runs?workflow_id=:id`	Read run history. Add `overview=true` for the dashboard overview.
`GET /api/workspace/runs/:id`	Read a run and its inspection.
`PUT /api/cli/runs/:id`	Upload a local run. Supply `workflow_id`, `version_id`, increasing `sequence`, and `inspection`.
`POST /api/workspace/runs/:id/website`	Get a website result URL. Supply the file’s `sha256`.

New Methods use format: method/3.4. Saved method/3.1 to method/3.3 documents remain accepted. A saved version has not necessarily passed a run. Each run names the exact saved version it used.

Production runs

Apps start and read production runs with a service key (Authorization: Bearer mk_live_…): POST /v1/runs, GET /v1/runs/:id, POST /v1/runs/:id/answer, and POST /v1/runs/:id/cancel. Workers use /v1/worker/*. See Production runs.

MCP 7.0

Connect to https://mcp.withmethod.ai/mcp with Streamable HTTP and OAuth with PKCE.

Tool	Shared operation
`list_methods`	API Method list, including `workflows` and `next_cursor`.
`get_method`	Complete dashboard detail in `workflow`; includes saved source and version data.
`rename_method`	Dashboard name change.
`get_method_source`	Exact current source, `workflow_id`, `version_id`, format, and hashes.
`get_method_version`	CLI checkout; optional `version_id` selects a saved version.
`get_method_run_instructions`	CLI checkout plus the same `runAgentPrompt` function used by the dashboard.
`list_method_versions`	Dashboard version history.
`create_method`	Save `workflow` as version 1 of a new Method.
`save_method_version`	Save `workflow` with a `reason` as a version by content; the current version’s files are kept.
`restore_method_version`	Dashboard restore with `version_id` and `current_version_id`.
`list_method_runs`	Dashboard/CLI run list; optional `method_id` and `overview`.
`get_method_run`	Dashboard/CLI run detail, selected by `run_id`.
`sync_method_run`	CLI upload with `run_id`, `method_id`, `version_id`, `sequence`, and actual `inspection`.
`open_method_run_website`	Dashboard website result URL with `run_id` and `sha256`.

Method lookup tools take method_id. API response fields remain workflow, workflows, and workflow_id. Version 6 changes the response shapes of list_methods, get_method, rename_method, and get_method_source. Update clients that parsed the old summary fields. MCP now preserves API fields instead of replacing them with a build-status summary.

Execution and retries

The remote MCP server does not execute local steps or cancel local processes. Call get_method_run_instructions, then run its prompt with an agent that has a local terminal. This uses Method CLI and the same executor as a dashboard-initiated local run. Use the CLI for helper-file transfers, local tool setup, and run-file uploads. MCP is not a replacement for every dashboard screen or local CLI command. create_method and save_method_version accept a complete document as YAML/JSON text or an object. They save it through the API; they do not run it. A save is safe to retry: the same content is the same version. sync_method_run accepts actual executor records. Reuse the run ID and sequence when retrying the same upload. Do not repeat the business steps or invent a successful result to recover from an upload failure. Method CLI handles file transfer and progress upload automatically. Preserve exact source text when checking sha256. A source hash identifies a file; it does not prove a successful run.

Use the API

Endpoints

Method API and MCP

Saved files and runs

Production runs

MCP 7.0

Execution and retries

​Method API and MCP

​Saved files and runs

​Production runs

​MCP 7.0

​Execution and retries

Method API and MCP

Saved files and runs

Production runs

MCP 7.0

Execution and retries