Skip to main content
Glama
Sign In
Itential MCP Server

Itential MCP Server

Official
by itential
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Remote

Backup Device Configuration

backup_device_configuration

Create a backup of a device configuration to establish recovery points, track changes, and enable rollback for network configuration management.

Instructions

Create a backup of a device configuration in Itential Platform.

Configuration backups provide recovery points and change tracking for network devices, enabling rollback capabilities and configuration management workflows.

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": {
      "name": "<name>"
    },
    "name": "backup_device_configuration"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYesThe name of the device to backup
notesNoNotes to attach to the backup
descriptionNoShort description to attach to the backup

Output Schema

NameRequiredDescriptionDefault
idYesUnique identifier for the backup
statusYesStatus of the backup operation
messageYesDescriptive message about the operation status

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4/5.0
Behavior3/5

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

Annotations already indicate readOnlyHint=false and destructiveHint=false, so the description is not required to restate the write nature. It does add value by describing the purpose of backups (recovery points, change tracking, rollback), but it doesn't disclose additional behavioral details like whether an existing backup is overwritten or if special permissions are needed. This is adequate but not rich.

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 two concise sentences, front-loaded with the action verb and resource. The second sentence provides useful context about the value of backups without redundancy. No wasted words.

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?

With a simple parameter set (3 params, all documented), an output schema, and annotations, the description covers the essential purpose and value proposition. It does not explain return values since an output schema exists, and the description is sufficient for an agent to understand core behavior. Minor gap: no sibling differentiation, but that is already considered in usage guidelines.

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?

The input schema has 100% description coverage for all three parameters (name, notes, description), so the schema already provides full parameter meaning. The description does not add any additional parameter-level detail, meeting the baseline for high schema coverage without going beyond it.

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 opens with 'Create a backup of a device configuration', which is a specific verb+resource that clearly states the tool's function. This distinguishes it from sibling tools like get_device_configuration and apply_device_configuration by naming the backup action explicitly.

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 explains that backups 'provide recovery points and change tracking... enabling rollback capabilities', which gives clear context for when this tool should be used. However, it does not explicitly mention alternatives or exclusions, such as when to prefer get_device_configuration or apply_device_configuration.

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