Skip to main content
Glama
Sign In
Copilot Studio MCP

Copilot Studio MCP

by jgt87
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

Restore an environment from a backup

cs_admin_restore_environment

Restore a Copilot Studio environment backup into the same or another environment, overwriting target data and customizations. Requires confirm: true; otherwise returns a dry run.

Instructions

Restore a backup into the same or another environment. Overwrites the target's data and customisations: requires confirm: true. Runs 'pac admin restore' with the active pac auth profile. Mutates a live environment: requires confirm: true (a dry run otherwise).

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "selectedBackup": "<selectedBackup>"
    },
    "name": "cs_admin_restore_environment"
  }
}

Input Schema

NameRequiredDescriptionDefault
cwdNoWorking directory for pac (for project commands: the solution project folder)
nameNoName for the restored environment
asyncNoRun the operation asynchronously
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.
skipAuditDataNoDo not restore audit data
selectedBackupYesBackup date as mm/dd/yyyy hh:mm, or 'latest'
timeoutSecondsNoDefault 14400
maxAsyncWaitTimeNoMax asynchronous wait time in minutes (default 60)
sourceEnvironmentNoEnvironment the backup came from
targetEnvironmentNoEnvironment to restore into (defaults to the source)

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

A3.6/5.0
Behavior4/5

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

With no annotations, the description carries the full burden and does well: it discloses that the target's data AND customisations are overwritten, that confirm: true is required to actually mutate, that omitting it yields a dry run, and that it runs under the active pac auth profile. It stops short of stating irreversibility, permission/elevation requirements, or expected duration.

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?

Four sentences, all front-loaded and on-topic, but the confirm requirement is stated twice in near-identical wording ('requires confirm: true' ... 'requires confirm: true (a dry run otherwise)'), which is redundant filler in an otherwise tight description.

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 12-parameter destructive admin tool with no output schema and no annotations, the description covers the critical decision inputs: destination scope, overwrite semantics, confirm/dry-run gate, and the underlying command. Return-value behavior is left unexplained, though the schema's background/jobId parameter hints at async polling via cs_job_status.

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 all 12 parameters including selectedBackup format, sourceEnvironment/targetEnvironment, profile, background/jobId, and confirm are already documented in the schema. The description only restates the confirm behavior and adds no new parameter-level detail, so the baseline 3 applies.

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

Purpose4/5

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

The description opens with a specific verb+resource (restore a backup into an environment) and states the scope (same or another environment), and the pac invocation ('pac admin restore') anchors exactly what is executed. It does not explicitly name or contrast with the nearest siblings (cs_admin_copy_environment, cs_admin_reset_environment, cs_admin_backup_environment), so an agent must infer the distinction from context.

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

Usage Guidelines3/5

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

It tells the agent the primary gate (confirm: true, otherwise a dry run) and that the target must be an environment, which is useful. But it gives no explicit when-to-use/when-not guidance against the adjacent lifecycle tools like copy, reset, or snapshot, and no prerequisites beyond the confirm flag.

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