READ

get_environment

Fetch a single environment by UUID — its kind, component, addresses, branch, flags, health, version and freeze, never a secret.

Fetch one environment in full once list_environments has named it: the addresses a browser or a pipeline opens, the branch and version deployed there, whether deployments need a promotion approval, what the last health check found and when, and whether a change freeze is in force. The record never carries a secret. An environment outside the token's team or project scope, one the person cannot see, or one a client guest's token may not read (anything but UAT and production) answers RESOURCE_NOT_FOUND, never a permission error, so existence does not leak.

Requires ability

The token behind the MCP session must hold it, or the call is refused with TOKEN_MISSING_ABILITY.

Runs the same action as

The REST endpoint and this tool share one action, so validation, permissions and events are identical.

Annotations

Read-only

It reads and never changes anything.

Arguments

environment_id*string

UUID of the environment to fetch.

What it returns

{  "data": {    "id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",    "project_id": "7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13",    "component_id": null,    "name": "Production",    "kind": "production",    "url": "https://app.example.test",    "api_url": "https://api.example.test",    "admin_url": "https://app.example.test/admin",    "branch": "main",    "hosting": "Managed containers",    "region": "Singapore",    "auto_deploy": false,    "protected": true,    "health": "healthy",    "health_check_url": "https://app.example.test/up",    "last_checked_at": "2026-10-27T11:25:00+00:00",    "consecutive_failures": 0,    "current_version": "1.3.2",    "frozen_until": "2026-11-01T00:00:00+00:00",    "frozen": true,    "notes": null,    "position": 6,    "created_at": "2026-10-20T09:05:00+00:00",    "updated_at": "2026-10-27T11:25:00+00:00"  },  "meta": {}}

A guest's token receives the same record without admin_url, branch, hosting, region, health_check_url, consecutive_failures and notes.

How it fails

RESOURCE_NOT_FOUND

unknown environment_id, an environment outside the token's scope or the person's visibility, or one a guest may not read.

TOKEN_MISSING_ABILITY

token lacks environment:view.

How is this guide?

Last updated on