ignition-mcp

Overview Schema Source Related Servers Discussions Admin

gateway_backup

Download a .gwbk Gateway backup to a specified file path. Provide the save location and optionally confirm the operation.

Instructions

Mutating-safe (heavy read), REST plane. Download a .gwbk gateway backup.

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

Input Schema

Name	Required	Description	Default
`confirm`	No
`save_to`	Yes

Output Schema

Name	Required	Description	Default
No arguments

Schema Changelog

Changes observed during successful MCP inspections.

First observedv0.1.0Jul 5, 2026

TDQS

A3.6/5.0

Behavior3/5

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

Discloses it is a heavy read and non-mutating, but with no annotations, more detail on potential impacts, auth, or rate limits would be beneficial. The term 'REST plane' is technical but adds context.

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?

Two sentences, front-loaded with key behavioral trait, no wasted words. Efficient for a simple tool.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Mentions file type and safety, but lacks details on parameter format (e.g., save_to path), confirm usage, or potential duration. Output schema exists but description could be more complete for a backup operation.

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

Parameters2/5

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

With 0% schema description coverage, the description should compensate but does not explain the 'confirm' or 'save_to' parameters beyond their names. Adds no semantic value to the input 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?

Clearly states the verb 'Download' and resource 'gateway backup' with file extension '.gwbk', distinguishing it from sibling tools that perform other gateway operations.

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?

Implies it is a safe read operation ('Mutating-safe'), but no explicit guidance on when to use vs. alternatives or prerequisites. Sibling tools exist for gateway info but no direct backup alternative.

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