Skip to main content
Glama

Set the backup retention period

cs_admin_set_backup_retention

Set how many days backups of a Copilot Studio environment are kept (7, 14, 21, or 28); requires confirm: true to change a live environment, otherwise returns a dry run.

Instructions

Set how many days backups of an environment are kept (7, 14, 21 or 28). Changes a live environment: requires confirm: true. Runs 'pac admin set-backup-retention-period' with the active pac auth profile. Mutates a live environment: requires confirm: true (a dry run otherwise).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
cwdNoWorking directory for pac (for project commands: the solution project folder)
daysYes7, 14, 21 or 28
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.
environmentNoEnvironment id or URL
timeoutSecondsNoDefault 600
maxAsyncWaitTimeNoMax asynchronous wait time in minutes (default 60)

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

B3.4/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 this mutates a live environment, that confirm: true is required to act, that without it the tool returns a dry run, and that it runs the underlying 'pac admin set-backup-retention-period' with the active auth profile. It stops short of stating required permissions or the shape/content of the result.

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?

It is short but redundant: the live-environment/confirm:true constraint is stated twice in near-identical sentences ('Changes a live environment: requires confirm: true' and 'Mutates a live environment: requires confirm: true (a dry run otherwise)'). The allowed-values fact is front-loaded well, but the duplication wastes space.

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 mutation command with no annotations and no output schema, the description covers the essentials an agent needs: what changes, that it is destructive/live, and the confirm gate. It could mention permissions or the result format, but it is close to complete for this operation.

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 schema already documents all nine parameters, making 3 the baseline. The description adds value by restating the valid 'days' values and the confirm gating semantics, but adds no syntax that is not already in the schema.

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?

States a specific verb and resource ('Set how many days backups of an environment are kept') and even enumerates the allowed values 7/14/21/28. The purpose is unambiguous and clearly distinct from adjacent siblings like cs_admin_backup_environment or cs_admin_list_backups, though it never explicitly contrasts itself with them.

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

Usage Guidelines2/5

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

It reveals a hard prerequisite (confirm: true) but gives no when-to-use guidance, no conditions for choosing this over alternatives, and no mention of related operations like restore or backup. The agent must infer the appropriate usage context entirely.

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