pve-mcp

pve_api_describe

Describe any Proxmox VE API endpoint by path and method to reveal its parameters, return shape, and required permissions; use verbose mode to include property-string sub-keys.

Instructions

Show parameters, return shape and permissions for an endpoint. path may be a template (/nodes/{node}/qemu) or concrete (/nodes/pve1/qemu). verbose=true includes property-string sub-keys.

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": "pve_api_describe"
  }
}

Input Schema

Name	Required	Default
`path`	Yes
`method`	No	GET
`verbose`	No

Output Schema

Name	Required	Description	Default
No arguments

Schema Changelog

Changes observed during successful MCP inspections.

First observedv0.1.0Nov 10, 2026

TDQS

A3.5/5.0

Behavior3/5

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

No annotations are supplied, but 'Show' and the subject matter (parameters, return shape, permissions) make it clear this is a non-mutating metadata lookup. The description does not address whether authentication or elevated privileges are required to inspect certain endpoints, nor whether the returned permission data is user-specific — meaningful gaps for a permission-reporting tool with zero annotation coverage.

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?

Three short sentences, front-loaded with purpose, then two concrete parameter clarifications. Every sentence conveys information not available elsewhere in the structured fields, and nothing is padded.

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?

An output schema exists, so the description needn't detail the return values it mentions. Still, for a three-parameter introspection tool with no annotations, the undefined `method` parameter and the absent when-to-use guidance leave real gaps an agent would have to guess around.

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 description must carry the burden. It explains `path` well with template and concrete examples, and clarifies `verbose` as including property-string sub-keys, but leaves `method` (GET/POST/PUT/DELETE) entirely unexplained — a notable omission since a POST endpoint has a different parameter set than the same path under GET.

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?

States a specific verb and outcome: 'Show parameters, return shape and permissions for an endpoint,' which tells an agent this is an introspection tool rather than an invocation tool like pve_api. It does not name a sibling or explicitly contrast itself with pve_api/pve_api_search, so it falls short of a 5.

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

Usage Guidelines3/5

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

The description gives useful operational guidance that 'path may be a template (/nodes/{node}/qemu) or concrete (/nodes/pve1/qemu),' which is exactly the sort of usage detail an agent needs. However, it never says when to prefer this tool over pve_api or pve_api_search, nor that it should be called before invoking an endpoint to discover required parameters.

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