Skip to main content
Glama

export_teleporter

Download a Teleporter backup ZIP of all Pi-hole settings and lists into a specified directory. The archive includes the password hash; store it securely, and existing files are never overwritten.

Instructions

Download a Teleporter backup zip of all Pi-hole settings and lists into output_dir.

The archive contains the password hash, so store it securely. Existing files are never overwritten.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
output_dirYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv1.1.0

TDQS

A4/5.0
Behavior4/5

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

With no annotations, the description carries the full disclosure burden and does notable work: it warns the archive contains the password hash (a real security consideration for downstream handling) and that existing files are never overwritten (destructive-overwrite behavior). It stops short of describing failure modes, resulting filename/location conventions, or archive size.

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 tight sentences, front-loaded with the action and artifact, followed by the two caveats an agent actually needs. No filler.

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?

An output schema exists, so return formatting need not be explained, and the description covers the key caveats (sensitive contents, no-overwrite). It is essentially complete for such a simple tool, missing only minor operational detail like error behavior on an invalid directory.

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%, but the sole parameter 'output_dir' is referenced in the description as the destination directory, giving it meaning beyond the bare string type. The self-descriptive name plus this in-text mention is minimally adequate for a single-parameter tool.

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?

Names a specific verb (Download) and resource (a Teleporter backup zip of all Pi-hole settings and lists), with the scope explicitly stated. No sibling tool performs backups or exports, so it is trivially distinguishable from the getters/mutators around it.

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 explains what gets exported but never states when an agent should choose to run a backup or any preconditions. Since no sibling performs a comparable export, there is no alternative to route away from, leaving usage merely implied rather than stated.

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