Skip to main content
Glama

pmg_quarantine_welcomelist_add

Add an email address to the PMG quarantine welcomelist, with optional user scoping. Dry-run returns a plan; confirm to execute.

Instructions

MUTATION (LOW): add an address to the quarantine welcomelist. Dry-run by default. confirm=True to execute. Needs PROXIMO_PMG_* config.

pmail: optional per-user scope (defaults to authenticated user). Additive — reverse with pmg_quarantine_welcomelist_remove. Dry-run returns a PLAN; confirm=True executes and returns {"status": "ok", "result": ...}.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pmailNoScope the welcomelist entry to this user's mailbox; defaults to the authenticated PMG user.
addressYesEmail address to add to the quarantine welcomelist.
confirmNoFalse (default) returns a dry-run PLAN; True executes the mutation.
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 provided, so description carries full burden. It discloses mutation semantics, dry-run behavior, and return types (PLAN vs status). Could add more detail about side effects or idempotency.

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?

Very concise and well-structured. Front-loads purpose and mutation type. Every sentence provides essential information without redundancy.

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 the presence of an output schema, the description covers key behavioral aspects: prerequisites, dry-run vs execution, and reversibility. It is complete enough for a mutation tool.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, but description adds meaning: explains pmail scope, confirm behavior, and that the operation is additive. The description of the return format adds value beyond the schema.

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 clearly states the verb and resource: 'add an address to the quarantine welcomelist.' It distinguishes from the sibling tool pmg_quarantine_welcomelist_remove by noting that it is additive and the reverse operation.

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?

Provides clear context: requires PROXIMO_PMG_* config, dry-run by default with confirm=True to execute, and mentions the reverse tool. However, it could be more explicit about when to use this vs alternatives.

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