Skip to main content
Glama

Get notification endpoint

proxmox_get_notification_endpoint
Read-only

Retrieve a Proxmox notification endpoint's configuration by name, including redacted credentials and decoded webhook details, to inspect mail, SMTP, Gotify, or webhook targets.

Instructions

Get one notification endpoint's configuration. The type is looked up when omitted. Tokens, passwords and webhook secrets are redacted; webhook headers and body are shown decoded (credential-like headers redacted).

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

Input Schema

NameRequiredDescriptionDefault
rawNoReturn the full unprocessed objects from the API (larger)
nameYesEndpoint/target name (see proxmox_list_notification_targets)
typeNoEndpoint type: sendmail (local mail), smtp, gotify or webhook

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.6.1

TDQS

A4.1/5.0
Behavior5/5

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

Annotations already declare readOnlyHint=true, openWorldHint=false, so safety is partly covered; the description goes well beyond by disclosing that tokens, passwords and webhook secrets are redacted, and that webhook headers/body are returned decoded with credential-like headers redacted. That is exactly the kind of output-shape information an agent needs before trusting the returned config, and it is stuff not in any structured field.

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 short sentences, front-loaded with the verb+resource and followed by behavioral caveats; there is no filler or repetition. Slightly dense in the second sentence with the redaction clauses, but every clause carries information.

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 read-only single-entity getter with full schema coverage and no output schema, the definition covers identity (name), type resolution, and the redaction behavior of returned data, which is the main thing an agent could get wrong. It stops short of describing not-found/error behavior or what `raw` changes in the payload, a minor gap at this complexity.

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 coverage is 100%, so all three parameters are already documented, giving a baseline of 3. The description adds one genuinely useful fact not in the schema, that 'type is looked up when omitted', but says nothing about the `raw` flag's trade-off, so it lifts little above the baseline.

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 ('Get one notification endpoint's configuration'), and the word 'one' plus the required 'name' parameter clearly distinguishes it from the listed sibling proxmox_list_notification_targets, which the schema explicitly cross-references. An agent can pick correctly without opening any schema.

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?

Usage is implied rather than stated: 'Get one' signals single-object retrieval, and the schema's 'see proxmox_list_notification_targets' hints at discovery-first workflow. But the description itself never says when to use this versus the list tool, nor what to do when the endpoint is unknown.

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