Skip to main content
Glama

pbs_snapshot_protected_get

Queries the protection flag of a Proxmox Backup Server snapshot to check if it is protected from deletion.

Instructions

READ-ONLY: query the protection flag for a specific backup snapshot — the READ half of the shipped pbs_snapshot_protected_set. The live schema declares this endpoint's return type null despite implying a real answer (the plausible return is the protection boolean the paired PUT sets) — passed through as-is. Needs PROXIMO_PBS_* config.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nsNoNamespace; omit for the root namespace.
storeYesPBS datastore name.
backup_idYesBackup group ID.
backup_timeYesSnapshot timestamp (Unix epoch).
backup_typeYesBackup type: vm, ct, or host.
proximo_targetNoWhich configured Proxmox target to run this call against — a target name from your multi-target config (a specific PVE/PBS/PMG/PDM box). Omit to use the single/default target from the environment; the selection applies only to this call.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior5/5

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

Without annotations, the description carries full burden. It declares the tool READ-ONLY upfront, discloses the return type discrepancy ('endpoint declares null but returns a boolean'), and mentions required configuration. This fully informs the agent of behavioral traits.

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 compact and front-loaded with the key characteristic 'READ-ONLY'. Every sentence adds value with no repetition or fluff. It efficiently conveys purpose, sibling relationship, nuance about return type, and config requirement.

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?

The description covers purpose, sibling existence, return type nuance, and config requirement. It does not explicitly handle error cases or missing snapshot behavior, but given the presence of an output schema and the tool's simplicity, this is adequate.

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%, so baseline is 3. The description does not add extra meaning beyond the schema descriptions for the parameters. No additional constraints or formats are provided.

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 clearly states the verb 'query' and the resource 'protection flag for a specific backup snapshot'. It explicitly distinguishes itself as 'the READ half of the shipped pbs_snapshot_protected_set', leaving no ambiguity about its purpose versus its sibling.

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 implies when to use this tool (to query protection flag) and pairs it with its set counterpart, but does not explicitly state when not to use or provide alternative tools. The prerequisite 'Needs PROXIMO_PBS_* config' gives context.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/john-broadway/proximo'

If you have feedback or need assistance with the MCP directory API, please join our Discord server