Skip to main content
Glama

Get ACME DNS plugin schema

proxmox_get_acme_challenge_schema
Read-only

Show which credential fields each ACME DNS API plugin requires, filter by API name, and use the schema to fill the data when saving a Proxmox ACME plugin.

Instructions

Show which credential fields each ACME DNS API plugin needs (e.g. CF_Token for Cloudflare), to fill data in proxmox_save_acme_plugin. Filter by api name.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "proxmox_get_acme_challenge_schema"
  }
}

Input Schema

NameRequiredDescriptionDefault
apiNoOnly this DNS API, e.g. cf, ovh, hetzner, route53 is 'aws'

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.6.1

TDQS

A3.8/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, openWorldHint=false, so the safe-read profile is covered structurally. The description adds that the result is a field-requirements listing used to populate a save payload, plus that it can be filtered by api name, but it says nothing about the shape of the returned schema or whether the list is static. Useful context, not rich behavioral disclosure.

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?

One tight sentence with the purpose front-loaded, a parenthetical example, the downstream use case, and the filter note, with no wasted wording.

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?

For a one-optional-parameter read-only lookup with no output schema, the description does the essential work of explaining what is returned conceptually (required credential fields) and why. It could go slightly further by sketching the returned structure, but nothing critical to correct invocation is missing.

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 100%, and the schema entry is actually richer than the description, including the non-obvious mapping that route53 is expressed as 'aws'. The description's 'Filter by api name' merely restates the parameter's purpose, so the baseline 3 is appropriate.

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 states a specific verb and resource: it shows which credential fields each ACME DNS API plugin requires, with a concrete example (CF_Token for Cloudflare). It also ties the output to a downstream action, filling `data` in proxmox_save_acme_plugin. It does not explicitly distinguish itself from the closely named sibling proxmox_get_acme_plugin, so a 4 rather than 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 Guidelines4/5

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

It gives clear context by naming the downstream consumer (proxmox_save_acme_plugin's `data` field), which tells an agent when to reach for this tool. It stops short of explicit when-not guidance or naming what to use instead for reading an existing plugin's stored configuration, so a 4.

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

Deploy Server

Other Tools