> ## Documentation Index
> Fetch the complete documentation index at: https://docs.asteroid.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# What the MCP server can do

> Every tool the Asteroid MCP server exposes, grouped by what it acts on.

Connect the server first — see [Install the MCP server](/mcp/install).

## Context and docs

| Tool | What it does |
| :- | :- |
| `getContext` | Returns your user context, including organization IDs and names. Call it first — most tools need an organization UUID. |
| `searchDocs` | Searches these docs. |

## Workflows

| Tool | What it does |
| :- | :- |
| `workflowList` | Lists the workflows in an organization. |
| `workflowCreate` | Creates a workflow with its first graph, and publishes that graph as version 1. |
| `workflowRename` | Renames a workflow. The name takes 1 to 100 characters. |
| `workflowDelete` | Deletes a workflow and its versions. Every execution must be terminal first. |
| `workflowGet` | Reads one workflow with its published version and version history. |
| `workflowDuplicate` | Copies a workflow into an organization. |
| `workflowExecutionStats` | Returns execution counts and outcomes over time for one workflow. |

## Profiles

| Tool | What it does |
| :- | :- |
| `agentProfilesList` | Lists the [login profiles](/concepts/profiles) in an organization. |
| `agentProfilesCreate` | Creates a profile. |
| `agentProfileGet` | Reads one profile. |
| `agentProfileUpdate` | Changes a profile. |
| `agentProfileDelete` | Deletes a profile. |
| `agentProfileClearBrowserCache` | Clears the browser state a profile has kept. |
| `agentProfileDuplicate` | Copies a profile with its settings, attached secrets, and cookies. |
| `agentProfileInboxEmailsList` | Lists the emails a profile's inbox received. |
| `agentProfileInboxEmailGet` | Reads one of those emails. |

## Profile groups

| Tool | What it does |
| :- | :- |
| `agentProfilePoolsList` | Lists the [profile groups](/concepts/profiles#profile-groups) in an organization. |
| `agentProfilePoolsCreate` | Creates a profile group. |
| `agentProfilePoolGet` | Reads one profile group. |
| `agentProfilePoolUpdate` | Changes a profile group's name or selection settings. |
| `agentProfilePoolDelete` | Deletes a profile group. Its profiles are kept. |
| `agentProfilePoolMembersList` | Lists the profiles in a profile group. |
| `agentProfilePoolMembersAdd` | Adds profiles to a profile group. |
| `agentProfilePoolMembersRemove` | Removes profiles from a profile group. |

## Secrets

Secret values are never returned. Reference fields in instructions as `##ITEM_KEY.FIELD##`. Attach secrets to a profile with `agentProfileUpdate` (`vaultItemIds`). The old profile `credentials*` fields are deprecated.

| Tool | What it does |
| :- | :- |
| `vaultItemsList` | Lists organization secrets. Values are omitted. |
| `vaultItemsCreate` | Creates a secret. Pass `templateId` or `kind` and `fields`, plus `values`. Omit `itemKey` and the server derives it from the name. Many secrets may share a key. |
| `vaultItemGet` | Reads one secret. Values are omitted. |
| `vaultItemUpdate` | Changes the name, the item key, or both. A rename leaves the key unchanged. |
| `vaultItemDelete` | Deletes a secret. |
| `vaultItemRotate` | Replaces field values in one write. |
| `vaultItemFieldAdd` | Adds a non-required field. |
| `vaultItemFieldRemove` | Removes a field the secret type does not require. |
| `vaultItemVersionsList` | Lists WorkOS versions. Does not decrypt. |
| `vaultTemplatesList` | Lists organization secret templates. |
| `vaultTemplatesCreate` | Creates an organization secret template. |
| `vaultTemplateGet` | Reads one template. |
| `vaultTemplateUpdate` | Changes a template. |
| `vaultTemplateDelete` | Deletes a template. |
| `vaultTemplateDuplicate` | Copies a template into an organization. |
| `vaultShareLinksList` | Lists secret requests. The token is never listed. |
| `vaultShareLinksCreate` | Creates a secret request. Omit `itemKey` and the server derives it from the name. The token is returned once. |
| `vaultShareLinkRevoke` | Revokes a pending secret request. |

See [Secrets & 2FA](/concepts/credentials).

## Executions

| Tool | What it does |
| :- | :- |
| `workflowExecutePost` | Starts an execution of the published version. |
| `executionsList` | Lists runs, with filters and pagination. |
| `executionGet` | Returns everything about one execution. |
| `executionView` | Draws an execution viewer in the chat, with status, activity, and result. |
| `executionActivitiesGet` | Returns the timeline of tool calls, messages, and events. |
| `executionFilesGet` | Lists the files an execution produced, grouped by directory. |
| `executionFileSignedUrl` | Returns a short-lived URL for reading one of those files. |
| `executionContextFileSignedUrl` | Returns a short-lived URL for reading a file attached to an execution. |
| `executionDebugFileSignedUrl` | Returns a short-lived URL for a debug file. Admins only. |
| `executionContextFilesGet` | Lists the files attached to an execution. |
| `executionStatusUpdate` | Pauses, resumes, or cancels an execution. |
| `executionUserMessagesAdd` | Sends a message to a running workflow. |
| `executionsStatusCounts` | Counts executions by status, with the same filters as `executionsList`. |
| `executionsMetadataKeys` | Lists the metadata keys used on an organization's executions. |

[Executions and statuses](/concepts/executions) lists the statuses these tools return.
[Debug your workflows](/operate/debug) covers how to read a failure.

## Versions

| Tool | What it does |
| :- | :- |
| `workflowVersionsList` | Lists the versions of a workflow. |
| `workflowVersionGet` | Loads one version: graph, rules, and settings. |
| `workflowVersionCreate` | Creates a version. Set `parentId` to record where it came from. It stays unpublished. |
| `workflowVersionPublish` | Publishes a version, so new executions use it. |
| `workflowVersionExecute` | Runs one specific version, published or not. Use it to test a draft. |
| `workflowVersionDelete` | Deletes an unpublished version that has no executions. |
| `workflowVersionInputsGet` | Lists the input names a version accepts. |
| `workflowVersionOutputSchemasGet` | Returns the output schemas on a version's output nodes. |
| `workflowHeadPublish` | Publishes the editable head as the next version. |
| `workflowHeadSnapshot` | Pins the editable head so `workflowVersionExecute` can run it unpublished. |
| `workflowHeadRevert` | Makes an earlier version the editable head again. |

## Files and validation

A workflow's graph and its files are the same thing, viewed two ways. Node instructions, settings, and
scripts all show up as files. Editing the editable head lands in place. Editing a published or
already-executed version forks a new one instead. See [Workflow filesystem](/concepts/filesystem) for where
the files land at run time.

| Tool | What it does |
| :- | :- |
| `workflowFilesList` | Lists the workflow's editable head as files. Returns a `rev`, which you pass back as `baseRev` to write. |
| `workflowVersionFilesList` | Lists the same files for one pinned, immutable version instead of the editable head. |
| `workflowFilesPatch` | Writes or deletes files on the editable workflow in one call. |
| `workflowVersionFileSignedUrl` | Returns a short-lived URL for reading a file. |
| `schemaValidate` | Checks a JSON schema before you put it on an output node. |
| `workflowSpecValidate` | Checks a graph before `workflowCreate` creates anything. |
| `workflowVersionValidate` | Runs the same check against a workflow that already exists. |

## Live environments

| Tool | What it does |
| :- | :- |
| `environmentStart` | Starts a standalone environment and returns its connection details, including a proxied CDP URL. |
| `environmentsList` | Lists an organization's currently-running standalone environments. |
| `environmentGet` | Reads one environment: its status and its CDP URL. |
| `environmentStop` | Stops a running environment. |

See [Live environments](/concepts/environments#live-environments) for how to connect to one.

## Next

<Card title="Build a workflow over MCP" icon="hammer" href="/build/from-your-coding-agent#build-a-workflow-over-mcp" horizontal>
  See these tools used together, start to finish.
</Card>

## Schedules and queued runs

| Tool | What it does |
| :- | :- |
| `schedulesList` | Lists the cron schedules on a workflow. |
| `scheduleCreate` | Creates a cron schedule with a time zone and inputs. |
| `scheduleGet` | Reads one schedule. |
| `scheduleUpdate` | Changes a schedule, or disables it. |
| `scheduleDelete` | Deletes a schedule. |
| `scheduledExecutionsList` | Lists a workflow's queued runs: one-off, batch items, and runs waiting for capacity. |
| `scheduledExecutionCreate` | Queues one run for a future time. |
| `scheduledExecutionCancel` | Cancels a queued run. |
| `scheduledExecutionReschedule` | Gives a cancelled run a new time. |

## Batches

| Tool | What it does |
| :- | :- |
| `executionBatchesList` | Lists a workflow's batches. |
| `executionBatchGet` | Reads one batch with its status counts. |
| `executionBatchPause` | Pauses a batch. Untriggered items wait. |
| `executionBatchResume` | Resumes a paused batch. |
| `executionBatchCancel` | Cancels a batch and its untriggered items. |

## Tags

| Tool | What it does |
| :- | :- |
| `workflowTagGroupsList` | Lists an organization's tag groups. |
| `workflowTagsList` | Lists an organization's tags with workflow counts. |
| `workflowTagsCreate` | Creates a tag in a group. |
| `workflowTagUpdate` | Renames a tag or changes its portal link. |
| `workflowTagDelete` | Deletes a tag from every workflow that carries it. |
| `workflowTagsGet` | Lists the tags on a workflow. |
| `workflowTagsPatch` | Adds and removes tags on a workflow, creating missing ones by name. |
| `workflowTagsSet` | Replaces the tags on a workflow. |

## Reference data

| Tool | What it does |
| :- | :- |
| `modelsList` | Lists the model slugs a node's `model` setting accepts. |
| `availableToolsList` | Lists the browser tools a node can use at run time. |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.