Skip to main content
Glama

Back up an environment

cs_admin_backup_environment

Takes a manual platform backup of a live Copilot Studio environment via pac admin backup. Requires confirm: true to mutate the environment; otherwise returns a dry run.

Instructions

Take a manual backup of an environment (the platform's own backup, not the file backup cs_backup_tenant writes). Changes a live environment: requires confirm: true. Runs 'pac admin backup' with the active pac auth profile. Mutates a live environment: requires confirm: true (a dry run otherwise).

Input Schema

NameRequiredDescriptionDefault
cwdNoWorking directory for pac (for project commands: the solution project folder)
labelYesBackup label
confirmNoRequired to actually perform a change in a live environment. Without it the tool returns a dry run.
profileNopac auth profile to run as: the admin account for tenant commands. Defaults to CPS_ADMIN_PROFILE for admin commands and CPS_PAC_PROFILE otherwise, then the active profile. cs_init lists the profiles.
backgroundNoRun in the background and return a jobId immediately, for a command that takes longer than the client will wait. Poll cs_job_status.
environmentNoEnvironment id or URL
timeoutSecondsNoDefault 3600

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.1.8
    • removedInput schema / additionalProperties
      Removed value: -false
  2. First observedv0.1.5

TDQS

A4/5.0
Behavior4/5

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

No annotations are provided, so the description carries the full burden and mostly does: it discloses that this mutates a live environment, that confirm:true is required, and that otherwise a dry run is returned. It never mentions what happens to existing backups or retention, and the confirm/dry-run point is stated twice, slightly muddying the signal.

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

Conciseness3/5

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

The opening sentence is well front-loaded and useful, but the trailing sentence ('Changes a live environment: requires confirm: true... Mutates a live environment: requires confirm: true (a dry run otherwise).') restates the same fact twice and pads length without adding information.

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 7-parameter mutation tool with no annotations and no output schema, the description covers the key risk (live mutation, confirm gate, dry-run fallback) and the underlying command. It leaves backup retention/overwrite behavior and what the dry run returns unstated, which is a modest gap.

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 coverage is 100% and every parameter including confirm, profile, background, and timeoutSeconds is already documented in the schema. The description adds only the profile default behavior, which the schema also covers, so it does not meaningfully extend parameter meaning.

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?

States a specific verb and resource ('Take a manual backup of an environment') and explicitly distinguishes itself from the sibling cs_backup_tenant, which writes a file backup. An agent can pick this tool over that one without opening either schema.

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 description clarifies the alternative (cs_backup_tenant's file backup vs this platform backup) and notes it runs with the active pac auth profile. It doesn't state when NOT to use it beyond that contrast, nor mention prerequisites like the confirm flag routing to cs_admin_list_backups.

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