Skip to main content
Glama

Refresh parameter from device

refresh_parameter
Idempotent

Fetch a fresh TR-069 parameter value from a CPE device and store it in GenieACS when cached data may be stale; no device settings are changed.

Instructions

Ask a CPE device for the current value of a TR-069 parameter, or of every parameter under an object path, and store it in GenieACS. Use it when get_parameter's cached value may be stale. It changes nothing on the device. GenieACS queues a getParameterValues task and sends a connection request at once: status "done" means the fresh value is already stored, so read it with get_parameter; "queued" means it arrives at the device's next inform. Example: refresh_parameter(device_id="202BC1-BM632w-000001", parameter="Device.DeviceInfo.SoftwareVersion").

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>",
      "parameter": "<parameter>"
    },
    "name": "refresh_parameter"
  }
}

Input Schema

NameRequiredDescriptionDefault
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.
parameterYesFull dotted TR-069 path in the device's data model. Examples: "Device.DeviceInfo.SoftwareVersion", "InternetGatewayDevice.LANDevice.1.WLANConfiguration.1.SSID", or an object such as "Device.WiFi." for everything under it.

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. Changed6 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 / parameter / description
      Previous value: -"Full TR-069 dotted parameter path to refresh. Examples: \"Device.DeviceInfo.SoftwareVersion\", \"Device.DeviceInfo.SerialNumber\", \"InternetGatewayDevice.LANDevice.1.WLANConfiguration.1.SSID\". Must be a valid path in the device's CWMP data model."New value: +"Full dotted TR-069 path in the device's data model. Examples: \"Device.DeviceInfo.SoftwareVersion\", \"InternetGatewayDevice.LANDevice.1.WLANConfiguration.1.SSID\", or an object such as \"Device.WiFi.\" for everything under it."
    • addedInput schema / properties / parameter / minLength
      Added value: +1
    • 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. Changed2 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 / parameter / description
      Previous value: -"Full TR-069 path, e.g. Device.DeviceInfo.SerialNumber"New value: +"Full TR-069 dotted parameter path to refresh. Examples: \"Device.DeviceInfo.SoftwareVersion\", \"Device.DeviceInfo.SerialNumber\", \"InternetGatewayDevice.LANDevice.1.WLANConfiguration.1.SSID\". Must be a valid path in the device's CWMP data model."
  3. First observedv0.0.10

TDQS

A4.8/5.0
Behavior5/5

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

Resolves the apparent conflict in the annotations: readOnlyHint=false but destructiveHint=false is explained by "It changes nothing on the device" — the write is to the GenieACS store via a queued getParameterValues task with an immediate connection request. It further discloses the async lifecycle ("done" = value already stored, "queued" = arrives at the next inform), which the 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 the usage condition, then the side-effect note, then status semantics. Tight throughout, but the closing example call largely restates examples already present in the parameter schema descriptions, making the final sentence the weakest.

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 two-parameter, non-destructive, idempotent tool with an output schema, the description covers everything an agent needs: what it does, when to prefer it over get_parameter, that the device is untouched, and how to interpret the two task states. Nothing material 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 both parameters are already documented in detail; the description nonetheless adds that an object path (e.g. "Device.WiFi.") fetches everything beneath it, and includes a worked call example. That is genuine added meaning, though partly redundant with the schema's own examples.

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 concrete verb+resource: ask a CPE device for the current value of a TR-069 parameter (or every parameter under an object path) and store it in GenieACS. It immediately distinguishes itself from get_parameter by contrasting fresh device-fetched values against cached ones.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicit trigger given: "Use it when get_parameter's cached value may be stale," plus the follow-up action (read the result with get_parameter). It also tells the agent what to do in each outcome state, so no inference is required about when to call it or what to call next.

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