Skip to content

Configuration

The server reads all runtime configuration from environment variables.

Required Variables

VariableRequiredDescription
VCFA_HOSTYesVCF Automation hostname, for example vcfa.example.com.
VCFA_USERNAMEYesUsername without organization, for example admin.
VCFA_ORGANIZATIONYesOrganization name (the tenant URL slug, not the display name), or system for provider/system administrator logins.
VCFA_PASSWORDYesPassword for the VCF Cloud API session, or the vRO Basic-auth password when VCFA_TARGET_PLATFORM=vra8.

The server authenticates by sending Basic Auth as {VCFA_USERNAME}@{VCFA_ORGANIZATION}:{VCFA_PASSWORD} to the VCF Cloud API session endpoint. Tenant logins use:

text
https://{VCFA_HOST}/cloudapi/1.0.0/sessions

When VCFA_ORGANIZATION is system (case-insensitive), the login is routed to the dedicated provider endpoint instead — the tenant endpoint rejects provider accounts with 401:

text
https://{VCFA_HOST}/cloudapi/1.0.0/sessions/provider

It uses the returned bearer token for later VCF Automation, Service Broker, Cloud Assembly, and vRO API calls.

VCF Cloud API Version Negotiation

VCF Automation 9.1 introduces API version 9.1.0 alongside 9.0.0. Before authenticating, the server probes the unauthenticated discovery document at https://{VCFA_HOST}/api/versions and selects the newest API version it knows (9.1.0 preferred, then 9.0.0) for the session request. If the probe fails or advertises no known version, the server falls back to 9.0.0, which 9.1 servers still accept. Set VCFA_TARGET_PLATFORM to vcfa9.1 or vcfa9.0 to pin the version explicitly and skip the probe.

For vRA/vRO 8.12+ read/run compatibility, set VCFA_TARGET_PLATFORM=vra8. In that mode, the server skips the VCF Cloud API session endpoint and sends Basic auth directly to /vco/api. The vRA/vRO 8 mode supports vRO read operations plus workflow execution and execution logs; Automation-service APIs such as catalog, deployments, templates, subscriptions, and event topics are intentionally unsupported until token-auth support is added.

Optional Variables

VariableDescription
VCFA_TARGET_PLATFORMTarget platform mode: vcfa (default, auto-negotiates the VCF Cloud API version), vcfa9.1/vcfa9.0 (pin the VCF Cloud API version, skipping the GET /api/versions probe), or vra8.
VCFA_IGNORE_TLSSet to true to disable TLS certificate verification for this server's requests to the VCFA host (lab environments only).
VCFA_ARTIFACT_DIRRoot directory for local artifact import/export files. Defaults to artifacts/ in the MCP server process working directory, typically the open project.
VCFA_PACKAGE_DIROverride the package artifact directory.
VCFA_RESOURCE_DIROverride the resource element artifact directory.
VCFA_WORKFLOW_DIROverride the workflow artifact directory.
VCFA_EXECUTION_LOG_DIROverride the workflow execution log export directory.
VCFA_ACTION_DIROverride the action artifact directory.
VCFA_CONFIGURATION_DIROverride the configuration artifact directory.
VCFA_CONTEXT_DIROverride the persisted context snapshot directory. If unset, context snapshots prefer the MCP client's current workspace root at artifacts/context/, falling back to VCFA_ARTIFACT_DIR/context.
VCFA_PROJECT_PACKAGE_NAMEStable fully-qualified package name reused by package-first workflows, for example com.example.project.
VCFA_PROJECT_PACKAGE_DESCRIPTIONOptional description used if the exact project package is explicitly created.

Artifact Directories

Artifacts are organized into typed subdirectories under VCFA_ARTIFACT_DIR:

text
VCFA_ARTIFACT_DIR/
  actions/
  configurations/
  context/
  execution-logs/
  packages/
  resources/
  workflows/

Use the specific directory overrides only when you need different storage locations per artifact type.

TLS Warning

VCFA_IGNORE_TLS=true disables TLS certificate verification only for this server's requests to the configured VCFA host, using a dedicated HTTPS agent. It does not set NODE_TLS_REJECT_UNAUTHORIZED or affect any other HTTPS traffic in the process. Use it only for lab or test environments where the risk is understood.