Skip to main content
Glama

openwisp_get_template_configuration

Download the rendered configuration tarball for a template via its UUID, retrieving the final config to deploy on OpenWISP-managed devices.

Instructions

[Category: Templates] Download the rendered configuration tarball for a template. (HTTP GET /api/v1/controller/template/{id}/configuration/)

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesTemplate UUID

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.0.0

TDQS

A3.5/5.0
Behavior3/5

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

No annotations exist, so the description carries the burden. It usefully discloses that the response is a rendered tarball (a binary artifact, distinct from JSON metadata) and gives the underlying endpoint, but says nothing about auth requirements, error behavior, or whether rendering is triggered on demand.

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?

Two compact sentences that front-load the action and artifact, with the endpoint path as a useful secondary detail. The '[Category: Templates]' prefix is mild boilerplate but not wasteful.

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-parameter download tool with no output schema and no annotations, stating the returned artifact (tarball) and endpoint is reasonably complete. Missing only ancillary detail like auth or rendering preconditions.

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?

Only one parameter (id) with full schema description coverage ('Template UUID'), so the schema already documents it. The description adds no format or source-of-id guidance; baseline 3 applies.

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?

States a specific verb (Download) and resource (rendered configuration tarball for a template), which is clearly distinguishable from openwisp_get_template (metadata) and openwisp_update_template. It does not explicitly name those siblings, so 4 rather than 5.

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 purpose implies when to use it (when the rendered config download is needed), but there is no explicit when-to-use, when-not-to-use, or alternative-tool guidance against the many sibling template/device tools.

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