Get environment variable

veryfront__get_environment_variable

Requires project.read.

Access

No external-service connection is required. Use a Veryfront credential with access to the requested resources.

Call type: Read-only.

Arguments

FieldTypeRequiredDescription and constraints
project_referencestringNoProject ID or slug
environment_idstringYesEnvironment ID containing the variable. Format: uuid.
keystringYesVariable name (e.g., API_KEY)

Example request

Send this JSON-RPC request through an initialized MCP client. Replace sample identifiers and values before calling the tool. See MCP client setup.

json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "veryfront__get_environment_variable",
    "arguments": {
      "environment_id": "00000000-0000-4000-8000-000000000000",
      "key": "example"
    }
  }
}

Result

The published output shape is summarized below. Inspect both the MCP response content and isError when handling a call.

FieldTypeRequiredDescription and constraints
idstringYesUnique identifier for the returned record. Format: uuid.
keystringYes
valuestringYesValue: "********".
has_valuebooleanYes

Full schemas

json
{
  "type": "object",
  "properties": {
    "project_reference": {
      "type": "string",
      "description": "Project ID or slug"
    },
    "environment_id": {
      "type": "string",
      "format": "uuid",
      "description": "Environment ID containing the variable."
    },
    "key": {
      "type": "string",
      "description": "Variable name (e.g., API_KEY)"
    }
  },
  "required": [
    "environment_id",
    "key"
  ],
  "additionalProperties": false,
  "description": "Arguments for the get_environment_variable tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}
json
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "Unique identifier for the returned record."
    },
    "key": {
      "type": "string"
    },
    "value": {
      "type": "string",
      "const": "********"
    },
    "has_value": {
      "type": "boolean"
    }
  },
  "required": [
    "id",
    "key",
    "value",
    "has_value"
  ],
  "additionalProperties": false,
  "description": "Structured result returned by the get_environment_variable tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}