Skip to main content
Glama

Push firmware or file to device

download_firmware
Destructive

Instruct a CPE device to download and apply a firmware or config file stored on GenieACS, queue the task, and trigger a connection request; verify file metadata first.

Instructions

Tell a CPE device to download and apply a file stored on GenieACS: a firmware image, a configuration file or another file the device accepts. A wrong image can leave a device unusable, so check the file's metadata (genieacs://file/{name}: OUI, product class, version) against the device first. GenieACS queues a download task and sends a connection request at once; the transfer itself can take minutes after the tool returns. Check genieacs://tasks/{device_id} and genieacs://faults/{device_id} afterwards. Example: download_firmware(device_id="202BC1-BM632w-000001", file_id="firmware-v2.0.bin").

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": {
      "device_id": "<device_id>",
      "file_id": "<file_id>"
    },
    "name": "download_firmware"
  }
}

Input Schema

NameRequiredDescriptionDefault
file_idYesThe _id of the file on GenieACS, which is its filename, e.g. "firmware-v2.0.bin". Check it exists with genieacs://file/{name}.
filenameNoOptional target file name sent to the device (TR-069 TargetFileName). Omit it to let the device choose.
device_idYesThe GenieACS device id (the _id field), exactly as GenieACS stores it, usually OUI-ProductClass-SerialNumber, e.g. "202BC1-BM632w-000001". GenieACS escapes characters other than letters and digits inside the product class and serial as %XX (a "-" there becomes "%2D"), so copy ids from genieacs://devices/list or search_devices rather than typing them.

Output Schema

NameRequiredDescriptionDefault
taskNoThe task document GenieACS returned.
statusYesdone: the device ran the task in the session GenieACS opened at once. queued: the device did not answer within 3 seconds, so the task runs at its next inform or connection request.
messageYesWhat happened, in one sentence.
task_idNoThe GenieACS task id; use it with delete_task or retry_task, or look for it in genieacs://tasks/{device_id}.
device_idYesThe device the task was queued on.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed7 schema fields changedv0.4.1
    • addedInput schema / additionalProperties
      Added value: +false
    • changedInput schema / properties / device_id / description
      Previous value: -"The exact GenieACS device identifier (_id field). Typically in the format OUI-ProductClass-SerialNumber. Obtain valid IDs from the genieacs://devices/list resource."New value: +"The GenieACS device id (the _id field), exactly as GenieACS stores it, usually OUI-ProductClass-SerialNumber, e.g. \"202BC1-BM632w-000001\". GenieACS escapes characters other than letters and digits inside the product class and serial as %XX (a \"-\" there becomes \"%2D\"), so copy ids from genieacs://devices/list or search_devices rather than typing them."
    • addedInput schema / properties / device_id / minLength
      Added value: +1
    • changedInput schema / properties / file_id / description
      Previous value: -"The GridFS _id (filename) of the file to push to the device. Must match an existing file in GenieACS — use genieacs://file/{name} to verify it exists."New value: +"The _id of the file on GenieACS, which is its filename, e.g. \"firmware-v2.0.bin\". Check it exists with genieacs://file/{name}."
    • addedInput schema / properties / file_id / minLength
      Added value: +1
    • changedInput schema / properties / filename / description
      Previous value: -"Optional display name passed to the CPE during the download. If omitted, the CPE receives the file_id as the filename."New value: +"Optional target file name sent to the device (TR-069 TargetFileName). Omit it to let the device choose."
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "additionalProperties": false,
      +  "properties": {
      +    "device_id": {
      +      "description": "The device the task was queued on.",
      +      "type": "string"
      +    },
      +    "message": {
      +      "description": "What happened, in one sentence.",
      +      "type": "string"
      +    },
      +    "status": {
      +      "description": "done: the device ran the task in the session GenieACS opened at once. queued: the device did not answer within 3 seconds, so the task runs at its next inform or connection request.",
      +      "enum": [
      +        "done",
      +        "queued"
      +      ],
      +      "type": "string"
      +    },
      +    "task": {
      +      "description": "The task document GenieACS returned."
      +    },
      +    "task_id": {
      +      "description": "The GenieACS task id; use it with delete_task or retry_task, or look for it in genieacs://tasks/{device_id}.",
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "device_id",
      +    "status",
      +    "message"
      +  ],
      +  "type": "object"
      +}
  2. Changed3 schema fields changedv0.3.3
    • changedInput schema / properties / device_id / description
      Previous value: -"Target device ID"New value: +"The exact GenieACS device identifier (_id field). Typically in the format OUI-ProductClass-SerialNumber. Obtain valid IDs from the genieacs://devices/list resource."
    • changedInput schema / properties / file_id / description
      Previous value: -"GridFS _id of the file to download"New value: +"The GridFS _id (filename) of the file to push to the device. Must match an existing file in GenieACS — use genieacs://file/{name} to verify it exists."
    • changedInput schema / properties / filename / description
      Previous value: -"(optional) file name to pass to the CPE"New value: +"Optional display name passed to the CPE during the download. If omitted, the CPE receives the file_id as the filename."
  3. First observedv0.0.10

TDQS

A4.6/5.0
Behavior5/5

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

Adds substantial context beyond the annotations: a wrong image can leave a device unusable, the tool queues a download task and fires a connection request immediately, and the actual transfer can take minutes after the tool returns. That async/non-blocking contract and the bricking risk are exactly what annotations cannot convey.

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?

Front-loaded with the action, then risk warning, then async behavior, then verification resources, then example — a logical order with no filler. The trailing example is slightly redundant with the schema examples but still aids selection.

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

Completeness5/5

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

For a destructive, open-world, non-idempotent mutation with an output schema, the description covers risk, async timing, and where to verify results. Nothing an agent needs in order to invoke it safely is missing.

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%, so baseline is 3; the description adds real value by explaining what file metadata (OUI, product class, version) to compare before choosing file_id, and supplies a worked example with both required parameters. It does not explain the optional filename parameter, which the schema covers instead.

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?

States a specific verb and resource ('Tell a CPE device to download and apply a file stored on GenieACS') and enumerates the file kinds accepted (firmware image, config file, other). This is clearly distinguishable from sibling tools like reboot_device, connection_request or set_parameter.

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?

Gives strong preconditions ('check the file's metadata ... against the device first') and a post-condition workflow (check genieacs://tasks/{device_id} and genieacs://faults/{device_id}). It does not, however, name any sibling alternative or state a when-not-to-use condition, so it falls short of a full 5.

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