Skip to main content
Glama

router_read

Read-onlyIdempotent

Read a router or modem settings object for all instances or a specific stack, returning each row’s _stack needed for changes; secrets are masked unless enabled.

Instructions

Read a settings object: every instance, or the one at stack (e.g. "1,2"). Each row carries its _stack, which router_change needs. Passwords and keys are masked unless TPLINK_SHOW_SECRETS=1.

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": {
      "object": "<object>"
    },
    "name": "router_read"
  }
}

Input Schema

NameRequiredDescriptionDefault
stackNo
objectYes
attributesNo

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

A4/5.0
Behavior4/5

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

Annotations already cover read-only, idempotent, closed-world, so the bar is lower; the description still adds real behavior: stack addressing syntax ("1,2"), the fact that each row returns its own _stack, and that passwords/keys are masked unless TPLINK_SHOW_SECRETS=1. That masking rule is exactly the kind of non-obvious output caveat an agent needs and cannot get from the annotations.

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, both load-bearing, front-loaded with the core action and mode choice before the cross-tool hint and the masking caveat. No filler or restatement of the tool name.

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?

An output schema exists so return values need no explanation, and the description covers the two non-obvious risks (stack addressing and secret masking) plus the handoff to router_change. The one remaining hole is the undocumented 'attributes' parameter, which leaves the definition slightly short of complete for a 3-parameter tool.

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?

Schema description coverage is 0%, so the description must compensate, and it only partly does: 'stack' gets a concrete format example and 'object' is implied by "settings object". The third parameter, 'attributes', is never mentioned, so an agent has no guidance on how to project or filter fields.

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 concrete verb and resource ("Read a settings object") and clarifies the two modes: all instances or the one addressed by stack. The read-vs-change distinction against router_change is implicit in the description's framing of _stack as input to that tool, but it never names router_change as the alternative for writes.

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?

The description explains the selection condition between two read modes ("every instance, or the one at stack") and explains the downstream workflow reason to care about _stack, which points the agent toward router_change for mutations. No explicit when-not or named-alternatives statement beyond that.

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