Skip to main content
Glama

Snapshot an environment

cs_snapshot_environment

Capture an environment's full state—agents, flows, connections, and settings—into a folder for comparison and history auditing.

Instructions

Capture one environment into a folder for comparison or history: solution version, every agent cloned with pac copilot clone (agents/), and, when signed in, flows, connection references, environment variables and publish state. Read-only for the environment.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
dirYesSnapshot folder (recreated)
labelYesShort name such as DEV, TEST, ACC, PROD
agentsNoAgent schema names or ids to clone; default: every agent pac copilot list returns
clientIdNoEntra app (client) id for MSAL. Defaults to CPS_CLIENT_ID, then the first-party VS Code id.
solutionNoSolution unique name to record version/managed state for
tenantIdNoEntra tenant id. Defaults to the workspace sync metadata, then CPS_TENANT_ID.
maxAgentsNoDefault 20
environmentYesEnvironment id or URL
includeDataverseNoDefault true: flows, connection references, environment variables and publish state via Dataverse (needs cs_login; skipped silently otherwise)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.5

TDQS

A4.2/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full burden and does well by explicitly stating 'Read-only for the environment.' It also discloses the conditional behavior for flows and Dataverse data when signed in, which agents need to know before invoking.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is one dense sentence with a front-loaded purpose, a clear colon-delimited content list, and a final safety qualifier. Every clause earns its place, with no fluff or repetition.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 9-parameter tool with no annotations and no output schema, the description provides a solid overview, safety profile, and content scope while the schema covers parameter semantics. Explicit routing to related comparison tools is absent, but this is a minor gap given the otherwise complete context.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the parameters are already fully documented in the input schema. The description adds conceptual context about what the snapshot contains but does not need to repeat parameter-level details.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description names a specific action ('Capture one environment into a folder') and enumerates the exact contents of the snapshot, including solution version, agents, flows, and publish state. This clearly distinguishes it from sibling comparison tools like cs_compare_snapshots or cs_check_drift.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The phrase 'for comparison or history' gives clear context for when to use this tool, and 'when signed in' notes a conditional scope. It does not explicitly name alternatives or exclusions, but the intended use case is stated well enough.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools