Skip to main content
Glama

pbs_notification_endpoint_list

Lists PBS notification endpoints with full type-specific configuration. Optionally filter by type such as gotify or webhook to limit results.

Instructions

READ-ONLY: list PBS notification endpoints with their full type-specific config. Aggregates GET .../endpoints/{type} across all 4 types (or just one if ep_type is given) — PBS's own GET .../endpoints (no type) is a directory index, not a usable list. Each item is tagged with its 'type' (the per-type responses don't carry one). Needs PROXIMO_PBS_* config.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
ep_typeNoOptional filter: one of gotify, sendmail, smtp, webhook. Omit to aggregate all 4 types.
proximo_targetNoWhich configured Proxmox target to run this call against — a target name from your multi-target config (a specific PVE/PBS/PMG/PDM box). Omit to use the single/default target from the environment; the selection applies only to this call.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior4/5

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

No annotations are provided, so the description carries the full burden. It correctly declares the tool as READ-ONLY, explains the aggregation logic across types, and notes that items are tagged with their 'type'. It also mentions the config prerequisite. Although it doesn't cover all edge cases, it provides adequate behavioral disclosure for a list operation.

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?

The description is two sentences and starts with the key 'READ-ONLY' label. The first sentence is concise, and the second provides additional context. Every sentence adds value, though the structure could be slightly more streamlined given the long second sentence.

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?

Given no annotations and full schema coverage, the description covers the tool's purpose, aggregation behavior, parameter usage, and config requirement. It does not explain the return format, but the presence of an output schema mitigates that. It is complete enough for effective use.

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%, so the parameters are already documented. The description adds context for 'ep_type' by listing the possible values (gotify, sendmail, smtp, webhook) and explaining the aggregation behavior when omitted. For 'proximo_target', it mirrors the schema. This adds marginal value beyond the schema, earning a baseline 3.

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 starts with 'READ-ONLY: list PBS notification endpoints with their full type-specific config,' clearly specifying the verb and resource. It explains the aggregation behavior across 4 types or filtering by ep_type, and distinguishes itself from PBS's own /endpoints endpoint, which is a directory index. This differentiates it from sibling tools like pbs_notification_endpoint_get or pbs_notification_endpoint_create.

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?

The description explicitly advises when to use this tool: to get a usable list of endpoints as opposed to PBS's own directory index. It also mentions the requirement for PROXIMO_PBS_* config. While it doesn't state when not to use it explicitly, the context is clear, and it provides sufficient guidance for selection.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/john-broadway/proximo'

If you have feedback or need assistance with the MCP directory API, please join our Discord server