Skip to main content
Glama
vbr-write-mcp

vbr-write-mcp

by Aquatick

Api Write

api_write
Destructive

Sends state-changing VBR REST API requests (POST, PUT, DELETE) for write endpoints without a dedicated tool, such as failover, Instant Recovery, restores, and disk publishing. Look up the endpoint first, then build the body.

Instructions

Send any state-changing request to the VBR REST API - for write endpoints no dedicated tool covers.

Examples: High Availability cluster switchover, Azure / file-share / FCD Instant Recovery, Entra ID restores, disk publishing (Data Integration API), helper appliances, KMS servers. Look the endpoint up with describe_endpoint first and build body from its schema. Only endpoints of the VBR 1.3-rev2 API are accepted. Always treated as destructive: the server asks for confirmation before sending. reason is recorded in the audit log.

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

Input Schema

NameRequiredDescriptionDefault
bodyNo
pathYes
methodYes
paramsNo
reasonNo
confirm_tokenNo

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.4/5.0
Behavior5/5

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

Goes well past the annotations by disclosing the confirmation handshake ('the server asks for confirmation before sending') and the audit side effect ('`reason` is recorded in the audit log'), plus the API version gate. These are operational behaviors an agent cannot infer from destructiveHint/readOnlyHint alone and materially change how a call sequence is planned.

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?

Front-loaded with purpose and constraint, then procedural guidance, then the destructive/audit note. The parenthetical example cluster runs slightly long but each item maps to a real endpoint family rather than filler.

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?

Strong on scope, prerequisites, and side effects, and it correctly need not describe return values since an output schema exists. However, for a six-parameter generic escape-hatch tool with 0% schema coverage, the missing explanation of how `confirm_token` ties to the stated confirmation step leaves the actual call sequence underspecified.

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 0%, so the burden is on the text, and it only covers two of six parameters: `body` (build it from describe_endpoint's schema) and `reason` (audit log). `params`, `path`, `method`, and especially `confirm_token` — the parameter that presumably carries the confirmation the description alludes to — receive no direct explanation, leaving a real gap for an agent wiring up the two-step flow.

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?

States a specific verb and resource ('Send any state-changing request to the VBR REST API') and explicitly scopes it as the fallback 'for write endpoints no dedicated tool covers', which separates it from api_read and the many purpose-specific write tools in the sibling list. Concrete example endpoints (HA switchover, Instant Recovery, KMS servers) make the domain tangible.

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

Usage Guidelines5/5

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

Gives an explicit precondition chain: only when no dedicated tool covers the endpoint, look it up with `describe_endpoint` first, and build `body` from that endpoint's schema. It also states a hard constraint ('Only endpoints of the VBR 1.3-rev2 API are accepted'), so an agent knows when to avoid this tool and what to do before calling it.

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