Skip to main content
Glama
vbr-write-mcp

vbr-write-mcp

by Aquatick

Api Read

api_read
Read-onlyIdempotent

Send read-only GET requests to the VBR REST API to locate object IDs, apply query filters, or check state after an action.

Instructions

Send a GET request to the VBR REST API (read-only), e.g. to find ids or check state after an action.

path has its ids filled in (e.g. /api/v1/jobs/{id}); params holds query parameters (filters, skip/limit, orderColumn/orderAsc). If Veeam's vbr-mcp is connected too, its dedicated list tools give richer answers.

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

Input Schema

NameRequiredDescriptionDefault
pathYes
paramsNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.7/5.0
Behavior3/5

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

The annotations already declare readOnlyHint, idempotentHint, destructiveHint false, and openWorldHint false, so safety is covered without the prose. The description adds useful context by labeling the endpoint read-only and by distinguishing path templating from query parameters. It says nothing about error behavior, response shape, or rate limits, which matters for a raw API wrapper.

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

Conciseness4/5

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

Three tight sentences with zero filler, front-loaded with the action and constraint. The path/params explanation is compact without becoming cryptic. Slightly dense parenthetical style, but still readable and well ordered.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a two-parameter open-ended REST passthrough with no output schema and thin annotations on response handling, the description covers the inputs well but not the outcome. An agent still does not know the response body format or how the API's paging defaults behave. Adequate for invocation, incomplete for interpretation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 0% and the schema is bare strings/objects, so the description has to carry the load; it does. It explains that path carries filled-in ids in a templated route like /api/v1/jobs/{id}, and that params holds filters, skip/limit, and orderColumn/orderAsc. Concrete key names for pagination and sorting are exactly the kind of meaning the schema lacks.

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 names a specific verb and resource: send a GET request to the VBR REST API, marked read-only. That cleanly separates it from the write sibling and from the dedicated verb-specific tools. It falls short of 5 only because the generic escape-hatch nature means the scope of what it can reach is left broad rather than pinned down.

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?

It gives concrete when-to-use cues: finding ids or checking state after an action. It also redirects agents to richer dedicated list tools when vbr-mcp is connected, which is a real alternative signal rather than a bare mention. There is no explicit 'avoid this when X' exclusion for the generic read path.

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