Skip to main content
Glama
vbr-write-mcp

vbr-write-mcp

by Aquatick

Describe Endpoint

describe_endpoint
Read-onlyIdempotent

Look up Veeam Backup & Replication REST API endpoint details, including parameters and request-body schemas, or search endpoints by path, HTTP method, or keywords.

Instructions

Look up the VBR REST API 1.3-rev2 reference bundled with this server.

With a path and method: the endpoint's summary, description, path/query parameters and request-body schema (nested models inlined to depth; deeper ones appear as {"$ref": Model} - expand them with describe_model). A model with x-subtypes is polymorphic: its type field selects one of the listed subtypes, whose extra fields the body must carry. With search words: matching endpoints (method, path, summary).

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

Input Schema

NameRequiredDescriptionDefault
depthNo
queryYesEither an API path (`/api/v1/jobs/{id}` or a concrete one) together with `method`, or search words such as 'quick backup', 'failover', 'add repository'.
methodNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive, closed-world behavior, so the safety profile is covered. The description adds genuinely useful context beyond them: nested models are inlined only to `depth` and deeper ones surface as `{"$ref": Model}`, and a model with `x-subtypes` is polymorphic with a `type` discriminator. It does not say what happens when a path matches nothing or fails to parse, which is the main remaining gap.

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?

It is front-loaded with the one-sentence purpose, then uses a parenthetical block for the detailed mode and a compact clause for the search mode. Dense but each sentence carries distinct information; the nested parenthetical about $refs is slightly hard to parse on first read.

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 no output schema, the description bears the burden of explaining return shape, and it does so adequately by enumerating summary, description, path/query parameters, request-body schema, and the search-mode tuple of method/path/summary. Removing reliance on inference for polymorphic bodies and $ref expansion covers the trickiest complexity of the tool.

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 only 33% (only `query` is described in the schema), so the description must compensate. It explains that `method` accompanies a path and that `depth` controls model inlining depth, which meaningfully clarifies all three inputs, but it never states the effect of depth=0 or the maximum of 4, nor that a concrete path may be used instead of a templated one beyond a parenthetical.

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 a specific verb and resource ('Look up the VBR REST API 1.3-rev2 reference bundled with this server') and then names exactly what is returned in each of its two modes: endpoint summary/description/parameters/body schema, or matching endpoints by method/path/summary. It also distinguishes itself from the sibling describe_model by assigning $ref expansion to that tool.

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 clearly states the two invocation modes — a path plus `method`, or search words such as 'quick backup', 'failover' — which tells an agent which inputs select which behavior, and it routes $ref expansion to describe_model. It does not give explicit 'when not to use' guidance (e.g., prefer api_read for live data versus this reference lookup), which keeps it below a 5.

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