Skip to main content
Glama

Read cached device parameters

get_parameter
Read-onlyIdempotent

Reads cached TR-069 parameter values for a device without contacting it, such as firmware version, serial number, uptime, or WiFi SSID. Pass one path or a comma-separated list; object paths return all cached leaves.

Instructions

Read TR-069 parameter values GenieACS has cached for a device, without contacting the device: firmware version, serial number, uptime, WiFi SSID, IP addresses and so on. Values are what the device reported at its last inform or refresh, with a timestamp each; call refresh_parameter first when you need a value from the device now. Give one path or a comma-separated list; an object path such as "Device.WiFi" returns every cached leaf under it. Returns found=false for an unknown device id, and lists paths with no cached value under missing.

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_path": "<parameter_path>"
    },
    "name": "get_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.
parameter_pathYesComma-separated TR-069 paths. Example: "Device.DeviceInfo.SoftwareVersion" or "InternetGatewayDevice.DeviceInfo.SoftwareVersion,InternetGatewayDevice.DeviceInfo.UpTime".

Output Schema

NameRequiredDescriptionDefault
foundYesfalse when no device has this id.
missingYesRequested paths with no cached value; refresh_parameter can fetch them.
device_idYes
parametersYesEvery cached leaf parameter at or under the requested paths, keyed by full path.

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 (e.g. \"00236A-SmartRG585-SMRT00236a42\"). 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_path / description
      Previous value: -"Comma-separated TR-069 parameter paths to retrieve from the ACS cache. Example: \"Device.DeviceInfo.SoftwareVersion\" or \"Device.DeviceInfo.SoftwareVersion,Device.DeviceInfo.UpTime,Device.ManagementServer.PeriodicInformInterval\""New value: +"Comma-separated TR-069 paths. Example: \"Device.DeviceInfo.SoftwareVersion\" or \"InternetGatewayDevice.DeviceInfo.SoftwareVersion,InternetGatewayDevice.DeviceInfo.UpTime\"."
    • addedInput schema / properties / parameter_path / minLength
      Added value: +1
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "additionalProperties": false,
      +  "properties": {
      +    "device_id": {
      +      "type": "string"
      +    },
      +    "found": {
      +      "description": "false when no device has this id.",
      +      "type": "boolean"
      +    },
      +    "missing": {
      +      "description": "Requested paths with no cached value; refresh_parameter can fetch them.",
      +      "items": {
      +        "type": "string"
      +      },
      +      "type": [
      +        "null",
      +        "array"
      +      ]
      +    },
      +    "parameters": {
      +      "additionalProperties": {
      +        "additionalProperties": false,
      +        "properties": {
      +          "timestamp": {
      +            "description": "When GenieACS last read it from the device (ISO 8601).",
      +            "type": "string"
      +          },
      +          "type": {
      +            "description": "Its xsd type, e.g. xsd:string.",
      +            "type": "string"
      +          },
      +          "value": {
      +            "description": "The last value the device reported."
      +          }
      +        },
      +        "required": [
      +          "value"
      +        ],
      +        "type": "object"
      +      },
      +      "description": "Every cached leaf parameter at or under the requested paths, keyed by full path.",
      +      "type": "object"
      +    }
      +  },
      +  "required": [
      +    "device_id",
      +    "found",
      +    "parameters",
      +    "missing"
      +  ],
      +  "type": "object"
      +}
  2. Addedv0.3.3

TDQS

A5/5.0
Behavior5/5

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

Annotations already declare readOnly/idempotent/non-destructive, but the description adds what they cannot: values are cached snapshots from the last inform or refresh, each carrying a timestamp, and the call is served without touching the device. It also discloses the failure semantics — found=false for unknown device ids and unmatched paths listed under missing — which is real behavioral context an agent needs to interpret results.

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 front-loaded sentences: what it does and its cache scope first, the refresh_parameter alternative second, input/return semantics last. No filler, and the most decision-relevant facts (cache staleness, alternative tool) come before the mechanics.

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?

Despite an output schema being present, the description supplies the two return-shape facts an agent actually needs to branch on (found=false, missing list) and the freshness caveat that governs whether the answer is trustworthy. Nothing needed to call this correctly or interpret its output is absent.

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

Parameters5/5

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

Schema coverage is 100%, so the baseline is 3, but the description earns more: it explains that parameter_path accepts a comma-separated list and that an object path like "Device.WiFi" fans out to every cached leaf, behavior not visible in the schema's flat string type. It also reinforces that device_id must be a GenieACS-stored id.

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 (read) and resource (TR-069 parameter values cached by GenieACS) plus the defining constraint 'without contacting the device', with concrete examples of the data returned. The distinction from refresh_parameter is built into the framing, so an agent can separate the two without opening either schema.

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?

Explicitly routes the agent: 'call refresh_parameter first when you need a value from the device now' names both the alternative and the condition that selects it. It also gives the accepted input forms (single path or comma-separated list) and notes that an object path returns all cached leaves beneath it.

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