Tool Reference

Tools are grouped by operating domain. Each tool carries an MCP annotation hint indicating its effect category:

• Read-only discovery (readOnlyHint: true) — list, get, preflight, and diff tools. Safe for discovery; do not write local files or mutate live state. (get-workflow-execution-logs is read-only by default; it writes a local file only when the optional fileName is provided.)
• Local artifact write (readOnlyHint: false, no confirm) — export, scaffold, and snapshot tools. Write files under configured artifact directories; overwrite defaults to false. Do not mutate live VCFA/vRO state.
• Live mutation (readOnlyHint: false, confirm: true) — create, update, import, run, and delete tools. Mutate live VCFA/vRO state and require explicit confirmation. Tools that overwrite or delete live state — import, update, run, and delete tools, plus rebuild-project-package — additionally set destructiveHint: true so hosts can require heightened approval; additive creates and add-*-to-project-package tools do not.

Each tool lists its input schema in a collapsible parameters section. Required confirmation fields such as confirm must be set to true before the tool performs the write or destructive operation.

Discovery list tools automatically follow server-side pagination for both vRO /vco/api list responses and VCF Automation service pages. Tool inputs stay focused on filters and selectors; callers do not need to provide page cursors for normal discovery. If a listing stops at the pagination request cap before reaching the server's full total, the result carries a truncated flag and the tool output ends with a visible truncation warning (and context snapshots record a per-domain warning) instead of silently returning partial data.

Two-Phase Confirmation Fields

High-risk live mutation tools support optional expected target fields. These fields are backward-compatible: omitted fields do not change existing confirm: true behavior. When supplied, the handler performs read-only discovery first and refuses before mutation if the live target does not match.

Common expected fields:

Field	Used by	Purpose
expectedName	delete/update tools for workflows, actions, configurations, resources, packages, templates, deployments, and subscriptions	Verify the live display name or package name before mutation.
expectedWorkflowName, expectedInputNames	run-workflow, run-workflow-and-wait	Bind execution to a discovered workflow name and input contract.
expectedCategoryId, expectedCategoryName	direct workflow, action, configuration, and resource imports	Verify the intended import category.
expectedPackageName	import-package, import-project-package	Verify the package identity from package import details.
expectedDeploymentName, expectedActionName	run-deployment-action	Verify the deployment and day-2 action discovered immediately before submission.
expectedProjectId, expectedProjectName, expectedStatus	deployment and template deletes, deployment actions	Verify project/status context before the live change.
expectedEventTopicId, expectedRunnableId	subscription update/delete	Verify subscription wiring before the live change.

Direct imports still preserve their existing overwrite defaults for compatibility. When overwrite is omitted on workflow and package imports, it resolves to true; pass it explicitly and prefer prepare-artifact-promotion for reusable content.

Context Snapshots

collect-context-snapshot

Collect reusable VCF Automation/vRO environment context and persist deterministic Markdown and JSON snapshots for future agents. Secrets, scripts, template YAML, and binary content are omitted by default. When the MCP client exposes workspace roots and VCFA_CONTEXT_DIR is not set, snapshots are written under the current workspace's artifacts/context/ directory.

Parameters

Parameter	Type	Required	Default	Description
fileBaseName	string	No	vcfa-context	Base file name for the generated .json and .md files under the configured context directory. Use a plain name only, without path separators or extensions.
overwrite	boolean	No	false	Replace existing snapshot files with the same generated names.
domains	string[]	No	core domains	Domains to collect. Core domains are workflows, actions, configurations, resources, and categories; optional domains are templates, catalogItems, eventTopics, subscriptions, packages, and plugins.
includeOptionalDomains	boolean	No	false	Also collect templates, catalog items, event topics, subscriptions, packages, and plugins.
maxItemsPerDomain	integer	No	100	Maximum items to collect per domain. Increase this when an environment has more than 100 items in a domain and full coverage is needed.
profile	enum	No	default	Snapshot profile. Use vcfaBuiltIns to focus on workflows in subfolders below the Library workflow category, plus actions whose module is com.vmware or starts with com.vmware..

When profile is vcfaBuiltIns, omitted domains default to workflows and actions, omitted fileBaseName defaults to vcfa-builtins-context, and omitted maxItemsPerDomain defaults to 1000. Explicitly requested non-workflow/action domains are still collected normally.

After a successful collection, the tool response includes agent-facing resource URIs:

• vcfa://context/latest for the newest snapshot manifest.
• vcfa://context/snapshots/{fileName} for the generated JSON and Markdown snapshot files.

The server also emits a resource-list change notification so MCP clients can rediscover persisted context snapshots.

Artifact Promotion

prepare-artifact-promotion

Run preflight for a local workflow, action, configuration, or package artifact; optionally export a live backup; summarize risks and changes; and recommend the exact import tool call. This tool never imports.

Parameters

Parameter	Type	Required	Default	Description
kind	enum	Yes	-	Artifact kind to prepare: workflow, action, configuration, or package.
fileName	string	Yes	-	Plain artifact file name under the configured artifact directory for the selected kind.
target	object	No	-	Optional live target and import category details used for diff, backup, and the recommended import call.
overwrite	boolean	No	true	Overwrite flag to include in the recommended import call where supported.
backup	object	No	-	Optional live backup export settings. When backup is enabled, the matching live target ID or package name is required.

target object:

Field	Type	Required	Description
categoryId	string	No	Target category ID for workflow or configuration import.
categoryName	string	No	Target category name for action import.
workflowId	string	No	Live workflow ID to diff against or export as a backup.
actionId	string	No	Live action ID to diff against or export as a backup.
configurationId	string	No	Live configuration ID to export as a backup.
packageName	string	No	Live package name to export as a backup.

backup object:

Field	Type	Required	Default	Description
enabled	boolean	Yes	-	Whether to export a live backup before promotion.
fileName	string	No	generated by tool	Optional backup artifact file name override.
overwrite	boolean	No	false	Overwrite the backup file if it already exists.

Workflows

list-workflows

List workflows from VCF Automation Orchestrator. Optionally filter by name substring.

Parameters

Parameter	Type	Required	Default	Description
filter	string	No	-	Filter workflows by name using a substring match.

list-workflows-by-category

List workflows assigned to a workflow category/folder and all descendant subfolders. Recursively fetches each subcategory; may be slow for large trees. Paths are normalized (leading slash is optional). Use this when you need folder membership, for example workflows under test, test/minko, and test/minko/sql.

Parameters

Parameter	Type	Required	Default	Description
categoryId	string	No	-	Exact WorkflowCategory ID to list recursively. Provide exactly one selector.
categoryName	string	No	-	Exact WorkflowCategory name to list recursively. If multiple categories match, use categoryId or categoryPath.
categoryPath	string	No	-	Exact WorkflowCategory path to list recursively, for example /test/minko. Leading slash is optional.
includeEmptyCategories	boolean	No	false	Include descendant categories that contain no workflows.
maxCategories	number	No	50	Maximum number of categories to traverse. Use a lower value to avoid slow traversals on large trees (1–500).

get-workflow

Get detailed information about a specific workflow including its input and output parameters.

Parameters

Parameter	Type	Required	Default	Description
id	string	Yes	-	Workflow ID to inspect.

create-workflow

Create a new empty workflow in VCF Automation Orchestrator. Use list-categories first to find a workflow category ID. For reusable workflow content, prefer publishing through the project package path after local authoring and validation.

Parameters

Parameter	Type	Required	Default	Description
categoryId	string	Yes	-	Workflow category ID where the empty workflow is created.
name	string	Yes	-	Name for the new workflow.
description	string	No	-	Optional workflow description.
confirm	boolean	Yes	-	Must be true to confirm creation. If false, the workflow is not created.

delete-workflow

Delete a workflow from VCF Automation Orchestrator. This action is irreversible.

Parameters

Parameter	Type	Required	Default	Description
id	string	Yes	-	Workflow ID to delete.
expectedName	string	No	-	Expected live workflow name to verify before deletion.
confirm	boolean	Yes	-	Must be true to confirm deletion. If false, deletion is not performed.

run-workflow

Validate inputs against the workflow definition, then execute the workflow with optional input parameters. Returns the execution ID; use get-workflow-execution to poll status and retrieve outputs.

Parameters

Parameter	Type	Required	Default	Description
id	string	Yes	-	Workflow ID to execute.
inputs	array	No	[]	Input parameters for the workflow execution. Inspect the workflow with get-workflow before running. Inputs are validated and type-normalized against the workflow definition before execution.
expectedWorkflowName	string	No	-	Expected live workflow name to verify before execution.
expectedInputNames	string[]	No	-	Expected workflow input names, in discovered order, to verify before execution.
confirm	boolean	Yes	-	Must be true to confirm execution. If false, the workflow is not run.

inputs array item:

Field	Type	Required	Description
name	string	Yes	Parameter name matching a workflow input parameter.
type	string	No	Optional vRO parameter type. When omitted, this tool uses the type from get-workflow.
value	any	Yes	Parameter value compatible with the workflow input type.

run-workflow-and-wait

Validate inputs, execute a workflow, poll until completion, failure, or timeout, and return outputs or useful failure diagnostics.

Parameters

Parameter	Type	Required	Default	Description
id	string	Yes	-	Workflow ID to execute.
inputs	array	No	[]	Input parameters for the workflow execution. This tool can infer parameter types from the workflow definition when type is omitted.
timeoutSeconds	integer	No	300	Maximum time to wait for completion before returning a timeout result.
pollIntervalSeconds	integer	No	2	Seconds between execution status polls.
logLimit	integer	No	20	Maximum execution log entries to include on failure or timeout. Set to 0 to suppress log excerpts.
expectedWorkflowName	string	No	-	Expected live workflow name to verify before execution.
expectedInputNames	string[]	No	-	Expected workflow input names, in discovered order, to verify before execution.
confirm	boolean	Yes	-	Must be true to confirm execution. If false, the workflow is not run.

inputs array item:

Field	Type	Required	Description
name	string	Yes	Parameter name matching a workflow input parameter.
type	string	No	Optional vRO parameter type. When omitted, this tool uses the type from get-workflow.
value	any	Yes	Parameter value compatible with the workflow input type.

list-workflow-executions

List past and current executions for a specific workflow. Use this to find an execution ID before calling get-workflow-execution.

Parameters

Parameter	Type	Required	Default	Description
workflowId	string	Yes	-	Workflow ID whose executions should be listed.
maxResults	integer	No	20	Maximum number of executions to return.
status	enum	No	-	Filter executions by status: running, completed, failed, canceled, or waiting-signal.

get-workflow-execution

Check the status and outputs of a workflow execution.

Parameters

Parameter	Type	Required	Default	Description
workflowId	string	Yes	-	Workflow ID associated with the execution.
executionId	string	Yes	-	Execution ID returned by run-workflow, run-workflow-and-wait, or list-workflow-executions.

get-workflow-execution-logs

Retrieve system/event log entries for a workflow execution, including workflow token messages such as System.log, System.debug, System.warn, and System.error. Use this after run-workflow, list-workflow-executions, or get-workflow-execution when detailed execution logs are needed. To save logs instead of returning them inline, provide fileName; exports are written under VCFA_EXECUTION_LOG_DIR or VCFA_ARTIFACT_DIR/execution-logs. The level parameter is a minimum severity filter for inline display and export: debug includes debug and all higher known severities plus unknown severities, info includes info, warning, and error logs, and error includes only error logs.

Parameters

Parameter	Type	Required	Default	Description
workflowId	string	Yes	-	Workflow ID associated with the execution.
executionId	string	Yes	-	Execution ID returned by run-workflow, run-workflow-and-wait, or list-workflow-executions.
maxResult	integer	No	-	Maximum number of execution log entries to fetch before filtering.
fileName	string	No	-	Plain .json or .txt file name to export under the configured execution log artifact directory. Do not pass a path.
level	debug | info | error	No	inline: none; export: info	Minimum log severity to display or export.
format	json | text	No	inferred from extension	Export format when fileName is provided. Must match the file extension when set.
overwrite	boolean	No	false	Overwrite the export file if it already exists.

export-workflow-file

Export a vRO workflow as a .workflow file under the configured workflow artifact directory.

Parameters

Parameter	Type	Required	Default	Description
id	string	Yes	-	Workflow ID to export.
fileName	string	Yes	-	Plain .workflow file name to save under the configured workflow artifact directory. Do not pass a path.
overwrite	boolean	No	false	Overwrite the file if it already exists.

scaffold-workflow-file

Generate a local importable .workflow artifact under the configured workflow artifact directory from structured metadata, linear tasks, bindings, and a vRO-compatible input_form_ for declared inputs. Each task is either a native vRO action workflow item (kind: "action", for a step that only invokes one existing action) or a scriptable task (kind: "script", the default, for custom JavaScript logic, multiple action calls, or orchestration). For reusable project content, publish the resulting workflow through the project package flow after preflight; use import-workflow-file only for narrow validation or explicitly requested one-off tests.

Parameters

Parameter	Type	Required	Default	Description
fileName	string	Yes	-	Plain .workflow file name to save under the configured workflow artifact directory.
overwrite	boolean	No	false	Overwrite the file if it already exists.
workflow	object	Yes	-	Complete workflow structure to render into the artifact.

workflow object:

Field	Type	Required	Default	Description
name	string	Yes	-	Workflow display name.
tasks	array	Yes	-	Linear sequence of workflow items (native action items or scriptable tasks). At least one task is required.
id	string	No	generated UUID	Workflow UUID.
description	string	No	-	Workflow description.
version	string	No	1.0.0	Workflow version metadata.
apiVersion	string	No	6.0.0	Workflow API version metadata.
inputs	array	No	[]	Workflow input parameters.
outputs	array	No	[]	Workflow output parameters.
attributes	array	No	[]	Workflow-scoped attributes.

The generated input_form_ is UTF-16BE JSON with a BOM. It places workflow inputs on a page_general page, uses section objects with only id and fields, maps common vRO types to compatible controls, and includes options.externalValidations: [] for vRO UI compatibility.

Workflow parameter object, used for inputs, outputs, and attributes:

Field	Type	Required	Description
name	string	Yes	Script-safe parameter name.
type	string	Yes	vRO parameter type, such as string, number, boolean, Array/string, or Properties.
description	string	No	Optional parameter description.

Task object:

Field	Type	Required	Default	Description
kind	string	No	script	Task kind: script (scriptable task) or action (native vRO action workflow item).
displayName	string	No	-	Task display name shown in the vRO UI.
name	string	No	itemN	Internal workflow item name.
description	string	No	-	Task description.
script	string	Yes for kind: "script"	-	JavaScript body of the scriptable task. Ignored for kind: "action" (generated automatically).
inBindings	array	No	[]	Scriptable-task bindings: bind workflow inputs or attributes into script-local variables.
outBindings	array	No	[]	Scriptable-task bindings: bind script-local variables back to workflow outputs or attributes.
module	string	Yes for kind: "action"	-	Native action module name, e.g. com.example.actions. Discover with get-action; do not invent.
actionName	string	Yes for kind: "action"	-	Native action name. Discover with get-action; do not invent.
inputs	array	No	[]	kind: "action" only. Ordered action inputs ({ name, type, source }) mapped from workflow inputs/attributes, in action signature order.
resultBinding	object	No	-	kind: "action" only. { name, type } binding the action result (actionResult) to a workflow output/attribute. Omit for actions with no return value.

Binding object (for inBindings/outBindings and inputs):

Field	Type	Required	Applies to	Description
name	string	Yes	all bindings	Script-local variable name (action parameter name for inputs).
type	string	Yes	all bindings	vRO parameter type. Must match the referenced workflow parameter or attribute type.
source	string	Yes	inBindings, inputs	Workflow input or attribute name to read from.
target	string	Yes	outBindings	Workflow output or attribute name to write to.

preflight-workflow-file

Validate a local .workflow artifact under the configured workflow artifact directory before importing it.

Parameters

Parameter	Type	Required	Default	Description
fileName	string	Yes	-	Plain .workflow file name under the configured workflow artifact directory to validate.

diff-workflow-file

Compare two local .workflow artifacts, or compare a live workflow export against a local .workflow artifact. The base source is current or old; compare is proposed or new.

Parameters

Parameter	Type	Required	Default	Description
base	union	Yes	-	Current or old workflow source.
compare	union	Yes	-	Proposed or new workflow source.

Both base and compare are discriminated unions selected by source:

source value	Additional field	Description
file	fileName string	Local .workflow file under the configured workflow artifact directory.
live	workflowId string	Live workflow ID to export and use as the comparison side.

import-workflow-file

Import a .workflow file from the configured workflow artifact directory into a workflow category. Use this direct import path for narrow validation or explicitly requested one-off tests; publish reusable project content through ensure-project-package, add-workflow-to-project-package, rebuild-project-package, export-project-package, get-project-package-import-details, and import-project-package.

Parameters

Parameter	Type	Required	Default	Description
categoryId	string	Yes	-	Workflow category ID to import into.
fileName	string	Yes	-	Plain .workflow file name under the configured workflow artifact directory to import.
overwrite	boolean	No	true	Overwrite an existing workflow with the same identity.
expectedCategoryId	string	No	-	Expected workflow category ID; must match categoryId before import.
expectedCategoryName	string	No	-	Expected workflow category name to verify before import.
confirm	boolean	Yes	-	Must be true to confirm import. If false, import is not performed.

Actions

list-actions

List actions from VCF Automation Orchestrator. Optionally filter by name.

Parameters

Parameter	Type	Required	Default	Description
filter	string	No	-	Filter actions by name using a substring match.

get-action

Get detailed information about a specific action including its parameters. The script is summarized (sha256 + length) unless includeScript is set.

Parameters

Parameter	Type	Required	Default	Description
id	string	Yes	-	Action ID to inspect.
includeScript	boolean	No	false	If true, include the full action script. By default only a sha256/length summary of the script is returned.

create-action

Create a new action in VCF Automation Orchestrator.

Parameters

Parameter	Type	Required	Default	Description
moduleName	string	Yes	-	Module or package name to create the action in, for example com.example.myactions.
name	string	Yes	-	Name for the new action.
script	string	Yes	-	JavaScript or TypeScript script content for the action.
inputParameters	array	No	[]	Input parameter definitions for the action.
returnType	string	No	-	Return type, for example string, void, or Array/string.
confirm	boolean	Yes	-	Must be true to confirm creation. If false, the action is not created.

inputParameters array item:

Field	Type	Required	Description
name	string	Yes	Action input parameter name.
type	string	Yes	vRO parameter type.
description	string	No	Optional parameter description.

export-action-file

Export a vRO action as a .action file under the configured action artifact directory.

Parameters

Parameter	Type	Required	Default	Description
id	string	Yes	-	Action ID to export.
fileName	string	Yes	-	Plain .action file name to save under the configured action artifact directory. Do not pass a path.
overwrite	boolean	No	false	Overwrite the file if it already exists.

preflight-action-file

Validate a local .action artifact under the configured action artifact directory before importing it.

Parameters

Parameter	Type	Required	Default	Description
fileName	string	Yes	-	Plain .action file name under the configured action artifact directory to validate.

diff-action-file

Compare two local .action artifacts, or compare a live action export against a local .action artifact. The base source is current or old; compare is proposed or new.

Parameters

Parameter	Type	Required	Default	Description
base	union	Yes	-	Current or old action source.
compare	union	Yes	-	Proposed or new action source.

Both base and compare are discriminated unions selected by source:

source value	Additional field	Description
file	fileName string	Local .action file under the configured action artifact directory.
live	actionId string	Live action ID to export and use as the comparison side.

import-action-file

Import a .action file from the configured action artifact directory into an action category. Use this direct import path for narrow validation or explicitly requested one-off tests; publish reusable project content through the project package tools.

Parameters

Parameter	Type	Required	Default	Description
categoryName	string	Yes	-	Action category or module name to import into.
fileName	string	Yes	-	Plain .action file name under the configured action artifact directory to import.
expectedCategoryName	string	No	-	Expected action category/module name; must match categoryName before import.
expectedCategoryId	string	No	-	Expected action category ID to verify before import.
confirm	boolean	Yes	-	Must be true to confirm import. If false, import is not performed.

delete-action

Delete an action from VCF Automation Orchestrator. This action is irreversible.

Parameters

Parameter	Type	Required	Default	Description
id	string	Yes	-	Action ID to delete.
expectedName	string	No	-	Expected live action name to verify before deletion.
expectedModule	string	No	-	Expected live action module to verify before deletion.
confirm	boolean	Yes	-	Must be true to confirm deletion. If false, deletion is not performed.

Configuration Elements

list-configurations

List configuration elements from VCF Automation Orchestrator. Optionally filter by name or scope to a specific category.

Parameters

Parameter	Type	Required	Default	Description
filter	string	No	-	Filter configuration elements by name using a substring match.
categoryId	string	No	-	Filter configuration elements by ConfigurationElementCategory ID. Use list-categories with type ConfigurationElementCategory to find a category ID.

get-configuration

Get detailed information about a specific configuration element including its attributes. Secure-typed attribute values (e.g. SecureString) are redacted in the output and shown as [redacted], consistent with the context-snapshot redaction policy.

Parameters

Parameter	Type	Required	Default	Description
id	string	Yes	-	Configuration element ID to inspect.

create-configuration

Create a new configuration element in VCF Automation Orchestrator. Use list-categories with type ConfigurationElementCategory to find a category ID first.

Parameters

Parameter	Type	Required	Default	Description
categoryId	string	Yes	-	Configuration element category ID to create the element in.
name	string	Yes	-	Name for the new configuration element.
description	string	No	-	Optional description.
attributes	array	No	[]	Initial attributes for the configuration element.
confirm	boolean	Yes	-	Must be true to confirm creation. If false, the configuration element is not created.

attributes array item:

Field	Type	Required	Description
name	string	Yes	Attribute name.
type	string	Yes	vRO attribute type.
value	string	No	Attribute value as a string.

update-configuration

Update a configuration element name, description, or attributes. Supplied attributes replace the existing attribute set.

Parameters

Parameter	Type	Required	Default	Description
id	string	Yes	-	Configuration element ID to update.
expectedName	string	No	-	Expected current configuration element name to verify before update.
name	string	No	current name	New name for the configuration element.
description	string	No	current description	New description.
attributes	array	No	current attributes	New attributes to replace the existing set.
confirm	boolean	Yes	-	Must be true to confirm update. If false, the configuration element is not updated.

attributes array item:

Field	Type	Required	Description
name	string	Yes	Attribute name.
type	string	Yes	vRO attribute type.
value	string	No	Attribute value as a string.

delete-configuration

Delete a configuration element from VCF Automation Orchestrator. This action is irreversible.

Parameters

Parameter	Type	Required	Default	Description
id	string	Yes	-	Configuration element ID to delete.
expectedName	string	No	-	Expected live configuration element name to verify before deletion.
confirm	boolean	Yes	-	Must be true to confirm deletion. If false, deletion is not performed.

export-configuration-file

Export a vRO configuration element as a .vsoconf file under the configured configuration artifact directory.

Parameters

Parameter	Type	Required	Default	Description
id	string	Yes	-	Configuration element ID to export.
fileName	string	Yes	-	Plain .vsoconf file name to save under the configured configuration artifact directory. Do not pass a path.
overwrite	boolean	No	false	Overwrite the file if it already exists.

preflight-configuration-file

Validate a local .vsoconf artifact under the configured configuration artifact directory before importing it.

Parameters

Parameter	Type	Required	Default	Description
fileName	string	Yes	-	Plain .vsoconf file name under the configured configuration artifact directory to validate.

import-configuration-file

Import a .vsoconf file from the configured configuration artifact directory into a configuration element category. Use list-categories with type ConfigurationElementCategory to find a category ID first.

Parameters

Parameter	Type	Required	Default	Description
categoryId	string	Yes	-	Configuration element category ID to import into.
fileName	string	Yes	-	Plain .vsoconf file name under the configured configuration artifact directory to import.
expectedCategoryId	string	No	-	Expected configuration category ID; must match categoryId before import.
expectedCategoryName	string	No	-	Expected configuration category name to verify before import.
confirm	boolean	Yes	-	Must be true to confirm import. If false, import is not performed.

Resource Elements

list-resource-elements

List resource elements from VCF Automation Orchestrator. Optionally filter by name.

Parameters

Parameter	Type	Required	Default	Description
filter	string	No	-	Filter resource elements by name using a substring match.

export-resource-element

Export a vRO resource element by ID to a file under the configured resource artifact directory.

Parameters

Parameter	Type	Required	Default	Description
id	string	Yes	-	Resource element ID to export.
fileName	string	Yes	-	Plain file name to save under the configured resource artifact directory. Do not pass a path.
overwrite	boolean	No	false	Overwrite the file if it already exists.

import-resource-element

Import a vRO resource element from the configured resource artifact directory into a ResourceElementCategory. Use list-categories with type ResourceElementCategory to find a category ID first.

Parameters

Parameter	Type	Required	Default	Description
categoryId	string	Yes	-	Resource element category ID to import into.
fileName	string	Yes	-	Plain file name under the configured resource artifact directory to import.
expectedCategoryId	string	No	-	Expected resource category ID; must match categoryId before import.
expectedCategoryName	string	No	-	Expected resource category name to verify before import.
confirm	boolean	Yes	-	Must be true to confirm import. If false, import is not performed.

update-resource-element

Update an existing resource element's binary content from a file under the configured resource artifact directory.

Parameters

Parameter	Type	Required	Default	Description
id	string	Yes	-	Resource element ID to update.
expectedName	string	No	-	Expected live resource element name to verify before update.
expectedCategoryName	string	No	-	Expected live resource category name to verify before update.
fileName	string	Yes	-	Plain file name under the configured resource artifact directory containing the replacement content.
changesetSha	string	No	-	Optional X-VRO-Changeset-Sha value for version-controlled content.
confirm	boolean	Yes	-	Must be true to confirm update. If false, update is not performed.

delete-resource-element

Delete a resource element from VCF Automation Orchestrator. This can optionally force deletion when the resource is referenced by workflows.

Parameters

Parameter	Type	Required	Default	Description
id	string	Yes	-	Resource element ID to delete.
expectedName	string	No	-	Expected live resource element name to verify before deletion.
expectedCategoryName	string	No	-	Expected live resource category name to verify before deletion.
force	boolean	No	false	Delete even if the resource is referenced by workflows.
confirm	boolean	Yes	-	Must be true to confirm deletion. If false, deletion is not performed.

Categories

list-categories

List categories by type. Categories are needed to create or import workflows, actions, configuration elements, and resource elements.

Parameters

Parameter	Type	Required	Default	Description
type	enum	Yes	-	Category type: WorkflowCategory, ActionCategory, ConfigurationElementCategory, or ResourceElementCategory.
filter	string	No	-	Filter categories by name using a substring match.

Catalog Items

list-catalog-items

List available Service Broker catalog items. Optionally search by name or keyword.

Parameters

Parameter	Type	Required	Default	Description
search	string	No	-	Search catalog items by name or keyword.

get-catalog-item

Get catalog item details including type, source, and project assignments.

Parameters

Parameter	Type	Required	Default	Description
id	string	Yes	-	Catalog item ID to inspect.

Deployments

list-deployments

List deployments, optionally filtered by name or keyword and project ID.

Parameters

Parameter	Type	Required	Default	Description
search	string	No	-	Search deployments by name or keyword.
projectId	string	No	-	Filter deployments by project ID.

get-deployment

Get detailed information about a specific deployment by its ID.

Parameters

Parameter	Type	Required	Default	Description
id	string	Yes	-	Deployment ID to inspect.

create-deployment

Create a new deployment from a catalog item. Use list-catalog-items to find the catalog item ID, and list-deployments to verify afterwards.

Parameters

Parameter	Type	Required	Default	Description
catalogItemId	string	Yes	-	Catalog item ID to deploy.
deploymentName	string	Yes	-	Name for the new deployment.
projectId	string	Yes	-	Project ID in which to create the deployment.
version	string	No	latest	Catalog item version to deploy.
reason	string	No	-	Reason or comment for the deployment request.
inputs	object	No	{}	Catalog item input parameters as a key/value object. Use get-catalog-item or catalog documentation to verify the expected shape before deploying.
confirm	boolean	Yes	-	Must be true to confirm deployment creation. If false, the deployment request is not submitted.

delete-deployment

Delete a deployment by its ID. This is a destructive live operation.

Parameters

Parameter	Type	Required	Default	Description
id	string	Yes	-	Deployment ID to delete.
expectedName	string	No	-	Expected deployment name to verify before deletion.
expectedProjectId	string	No	-	Expected deployment project ID to verify before deletion.
expectedProjectName	string	No	-	Expected deployment project name to verify before deletion.
expectedStatus	string	No	-	Expected deployment status to verify before deletion.
confirm	boolean	Yes	-	Must be true to confirm deletion. If false, deletion is not performed.

list-deployment-actions

List deployment-level day-2 actions available for a VCF Automation deployment.

Parameters

Parameter	Type	Required	Default	Description
deploymentId	string	Yes	-	Deployment ID whose available actions should be listed.

run-deployment-action

Run a deployment-level day-2 action. Use list-deployment-actions first to find the action ID and any required inputs.

Parameters

Parameter	Type	Required	Default	Description
deploymentId	string	Yes	-	Deployment ID to act on.
actionId	string	Yes	-	Deployment action ID to run.
reason	string	No	-	Reason for requesting the day-2 action.
inputs	object	No	{}	Day-2 action inputs as a key/value object. Use list-deployment-actions to discover required inputs before running.
expectedDeploymentName	string	No	-	Expected deployment name to verify before submitting the day-2 action.
expectedProjectId	string	No	-	Expected deployment project ID to verify before submitting the day-2 action.
expectedProjectName	string	No	-	Expected deployment project name to verify before submitting the day-2 action.
expectedStatus	string	No	-	Expected deployment status to verify before submitting the day-2 action.
expectedActionName	string	No	-	Expected deployment action name to verify against the current action list before submitting.
confirm	boolean	Yes	-	Must be true to confirm the day-2 action request. If false, the request is not submitted.

Blueprint Templates

list-templates

List blueprint templates in VCF Automation Cloud Assembly. Optionally filter by name or keyword and project ID.

Parameters

Parameter	Type	Required	Default	Description
search	string	No	-	Search templates by name or keyword.
projectId	string	No	-	Filter templates by project ID.

get-template

Get detailed information about a specific blueprint template by its ID. The YAML content is summarized (sha256 + length) unless includeContent is set.

Parameters

Parameter	Type	Required	Default	Description
id	string	Yes	-	Template or blueprint ID to inspect.
includeContent	boolean	No	false	If true, include the full blueprint YAML content. By default only a sha256/length summary of the content is returned.

create-template

Create a new blueprint template in VCF Automation Cloud Assembly. Use list-templates to verify afterwards.

Parameters

Parameter	Type	Required	Default	Description
name	string	Yes	-	Name for the new template.
projectId	string	Yes	-	Project ID in which to create the template.
description	string	No	-	Optional template description.
content	string	No	empty template	YAML blueprint content for the template. Treat this as Cloud Assembly blueprint content and verify conventions from existing templates or docs before authoring.
requestScopeOrg	boolean	No	false	If true, the template is available org-wide rather than project-scoped.
confirm	boolean	Yes	-	Must be true to confirm creation. If false, the template is not created.

delete-template

Delete a blueprint template by its ID. This action is irreversible.

Parameters

Parameter	Type	Required	Default	Description
id	string	Yes	-	Template or blueprint ID to delete.
expectedName	string	No	-	Expected template name to verify before deletion.
expectedProjectId	string	No	-	Expected template project ID to verify before deletion.
expectedProjectName	string	No	-	Expected template project name to verify before deletion.
expectedStatus	string	No	-	Expected template status to verify before deletion.
confirm	boolean	Yes	-	Must be true to confirm deletion. If false, deletion is not performed.

Packages

list-packages

List vRO packages available on the Orchestrator instance. Optionally filter by name substring.

Parameters

Parameter	Type	Required	Default	Description
filter	string	No	-	Filter packages by name using a substring match.

get-package

Get details of a specific vRO package by its fully qualified package name.

Parameters

Parameter	Type	Required	Default	Description
name	string	Yes	-	Fully qualified package name, for example com.example.mypackage.

export-package

Export a vRO package as a ZIP file under the configured package artifact directory on the server.

Parameters

Parameter	Type	Required	Default	Description
name	string	Yes	-	Fully qualified package name to export, for example com.example.mypackage.
fileName	string	Yes	-	Plain .package or .zip file name to save under the configured package artifact directory. Do not pass a path.
overwrite	boolean	No	false	Overwrite the file if it already exists.
exportConfigurationAttributeValues	boolean	No	-	Include configuration attribute values when supported by vRO.
exportGlobalTags	boolean	No	-	Include global tags when supported by vRO.
exportVersionHistory	boolean	No	-	Include version history when supported by vRO.
exportConfigSecureStringAttributeValues	boolean	No	-	Include secure string configuration values when supported by vRO.

get-package-import-details

Analyze a local package file before import and return package elements and certificate details.

Parameters

Parameter	Type	Required	Default	Description
fileName	string	Yes	-	Plain .package or .zip file name under the configured package artifact directory.

create-package

Create a vRO package by exact fully qualified name. Refuses to create if the package already exists.

Parameters

Parameter	Type	Required	Default	Description
name	string	Yes	-	Exact fully qualified package name.
description	string	No	-	Package description.
confirm	boolean	Yes	-	Must be true to create the package.

ensure-project-package

Resolve and reuse the exact configured project package. Creates it only when createIfMissing and confirm are both true.

Parameters

Parameter	Type	Required	Default	Description
packageName	string	No	VCFA_PROJECT_PACKAGE_NAME	Exact project package name.
description	string	No	VCFA_PROJECT_PACKAGE_DESCRIPTION	Description used only when the package is created.
createIfMissing	boolean	No	false	Create the exact package if it is missing.
confirm	boolean	No	false	Must be true with createIfMissing to create.

add-workflow-to-project-package

Add a workflow and dependencies to the exact project package.

Parameters

Parameter	Type	Required	Default	Description
packageName	string	No	VCFA_PROJECT_PACKAGE_NAME	Exact package name.
workflowId	string	Yes	-	Workflow ID to add.
confirm	boolean	Yes	-	Must be true to add content.

add-action-to-project-package

Add an action and dependencies to the exact project package.

Parameters

Parameter	Type	Required	Default	Description
packageName	string	No	VCFA_PROJECT_PACKAGE_NAME	Exact package name.
categoryName	string	Yes	-	Action category/module name.
actionName	string	Yes	-	Action name.
confirm	boolean	Yes	-	Must be true to add content.

add-configuration-to-project-package

Add a configuration element and dependencies to the exact project package.

Parameters

Parameter	Type	Required	Default	Description
packageName	string	No	VCFA_PROJECT_PACKAGE_NAME	Exact package name.
configurationId	string	Yes	-	Configuration element ID.
confirm	boolean	Yes	-	Must be true to add content.

add-resource-to-project-package

Add a resource element and dependencies to the exact project package.

Parameters

Parameter	Type	Required	Default	Description
packageName	string	No	VCFA_PROJECT_PACKAGE_NAME	Exact package name.
resourceId	string	Yes	-	Resource element ID.
confirm	boolean	Yes	-	Must be true to add content.

rebuild-project-package

Rebuild the exact project package after adding content.

Parameters

Parameter	Type	Required	Default	Description
packageName	string	No	VCFA_PROJECT_PACKAGE_NAME	Exact package name.
confirm	boolean	Yes	-	Must be true to rebuild.

export-project-package

Export the exact project package to the configured package artifact directory.

Parameters

Parameter	Type	Required	Default	Description
packageName	string	No	VCFA_PROJECT_PACKAGE_NAME	Exact package name.
fileName	string	No	{packageName}.package	Output package file name.
overwrite	boolean	No	false	Overwrite the local package file if it exists.
exportConfigurationAttributeValues	boolean	No	-	Include configuration attribute values when supported by vRO.
exportGlobalTags	boolean	No	-	Include global tags when supported by vRO.
exportVersionHistory	boolean	No	-	Include version history when supported by vRO.
exportConfigSecureStringAttributeValues	boolean	No	-	Include secure string configuration values when supported by vRO.

get-project-package-import-details

Analyze an exported project package file before import.

Parameters

Parameter	Type	Required	Default	Description
packageName	string	No	VCFA_PROJECT_PACKAGE_NAME	Exact package name used for default file naming.
fileName	string	No	{packageName}.package	Package file name to analyze.

import-project-package

Import an exported project package file.

Parameters

Parameter	Type	Required	Default	Description
packageName	string	No	VCFA_PROJECT_PACKAGE_NAME	Exact package name used for default file naming.
fileName	string	No	{packageName}.package	Package file name to import.
overwrite	boolean	No	true	Whether to overwrite existing package contents.
expectedPackageName	string	No	-	Expected package name from package import details to verify before import.
confirm	boolean	Yes	-	Must be true to import.
importConfigurationAttributeValues	boolean	No	-	Import configuration attribute values when supported by vRO.
tagImportMode	enum	No	-	Tag import mode: DoNotImport, ImportAndOverwriteExistingValue, or ImportButPreserveExistingValue.
importConfigSecureStringAttributeValues	boolean	No	-	Import secure string configuration values when supported by vRO.

preflight-package

Validate a local .package or .zip artifact under the configured package artifact directory before importing it.

Parameters

Parameter	Type	Required	Default	Description
fileName	string	Yes	-	Plain .package or .zip file name under the configured package artifact directory to validate.

import-package

Import a vRO package from the configured package artifact directory into the Orchestrator instance.

Parameters

Parameter	Type	Required	Default	Description
fileName	string	Yes	-	Plain .package or .zip file name under the configured package artifact directory to import.
overwrite	boolean	No	true	Whether to overwrite existing package contents.
expectedPackageName	string	No	-	Expected package name from package import details to verify before import.
confirm	boolean	Yes	-	Must be true to confirm import. If false, import is not performed.
importConfigurationAttributeValues	boolean	No	-	Import configuration attribute values when supported by vRO.
tagImportMode	enum	No	-	Tag import mode: DoNotImport, ImportAndOverwriteExistingValue, or ImportButPreserveExistingValue.
importConfigSecureStringAttributeValues	boolean	No	-	Import secure string configuration values when supported by vRO.

delete-package

Delete a vRO package by its fully qualified name. Optionally delete all workflows, actions, and configurations inside the package.

Parameters

Parameter	Type	Required	Default	Description
name	string	Yes	-	Fully qualified package name to delete, for example com.example.mypackage.
expectedName	string	No	-	Expected live package name to verify before deletion.
deleteContents	boolean	No	false	Also delete all elements inside the package.
confirm	boolean	Yes	-	Must be true to confirm deletion. If false, deletion is not performed.

Plugins

list-plugins

List installed plugins in VCF Automation Orchestrator. Optionally filter by name substring.

Parameters

Parameter	Type	Required	Default	Description
filter	string	No	-	Filter plugins by name using a substring match.

Extensibility Subscriptions

list-event-topics

List available Event Broker topics.

Parameters

This tool takes no parameters.

list-subscriptions

List extensibility subscriptions, optionally filtered by project ID.

Parameters

Parameter	Type	Required	Default	Description
projectId	string	No	-	Filter subscriptions by project ID.

get-subscription

Get subscription details including blocking setting and priority. Constraints are summarized (sha256 + length) unless includeConstraints is set.

Parameters

Parameter	Type	Required	Default	Description
id	string	Yes	-	Subscription ID to inspect.
includeConstraints	boolean	No	false	If true, include the full constraints JSON. By default only a sha256/length summary of the constraints is returned.

create-subscription

Create a subscription linking an Event Broker topic to a vRO workflow or ABX action.

Parameters

Parameter	Type	Required	Default	Description
name	string	Yes	-	Name for the subscription.
eventTopicId	string	Yes	-	Event topic ID to subscribe to. Use list-event-topics to discover available topics.
runnableType	enum	Yes	-	Runnable type to trigger: extensibility.vro for a vRO workflow or extensibility.abx for an ABX action.
runnableId	string	Yes	-	ID of the workflow or ABX action to trigger.
projectId	string	No	-	Project ID to scope the subscription to.
description	string	No	-	Optional subscription description.
blocking	boolean	No	-	Whether the subscription blocks the event pipeline until the runnable completes.
priority	number	No	-	Subscription priority. Lower number means higher priority.
timeout	number	No	-	Timeout in minutes for runnable execution.
disabled	boolean	No	false	Create the subscription in a disabled state.
confirm	boolean	Yes	-	Must be true to confirm creation. If false, the subscription is not created.

update-subscription

Update a subscription. All fields except id are optional; only supplied fields are updated.

Parameters

Parameter	Type	Required	Default	Description
id	string	Yes	-	Subscription ID to update.
expectedName	string	No	-	Expected subscription name to verify before update.
expectedEventTopicId	string	No	-	Expected event topic ID to verify before update.
expectedRunnableId	string	No	-	Expected runnable ID to verify before update.
name	string	No	current name	New subscription name.
description	string	No	current description	New description.
disabled	boolean	No	current state	Set to true to disable or false to enable.
runnableId	string	No	current runnable	New workflow or ABX action ID.
runnableType	enum	No	current type	New runnable type: extensibility.vro or extensibility.abx.
blocking	boolean	No	current setting	New blocking setting.
priority	number	No	current priority	New subscription priority. Lower number means higher priority.
timeout	number	No	current timeout	New timeout in minutes.
confirm	boolean	Yes	-	Must be true to confirm update. If false, the subscription is not updated.

delete-subscription

Delete an extensibility subscription.

Parameters

Parameter	Type	Required	Default	Description
id	string	Yes	-	Subscription ID to delete.
expectedName	string	No	-	Expected subscription name to verify before deletion.
expectedEventTopicId	string	No	-	Expected event topic ID to verify before deletion.
expectedRunnableId	string	No	-	Expected runnable ID to verify before deletion.
confirm	boolean	Yes	-	Must be true to confirm deletion. If false, deletion is not performed.