Skip to main content
Glama

router_get

Read-onlyIdempotent

Reads a single router configuration section by friendly name or catalog path, and lists available sections when none is specified; secrets stay masked unless reveal is enabled.

Instructions

Read one section of the router config by friendly name (e.g. dhcp, dhcp_reservations, dhcp_leases, clients, wifi, vpn_client_profiles, static_routes, access_control, upnp_mappings, firewall, time) or any form path from router_catalog. Call with no section to list sections. Secrets masked unless reveal.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "router_get"
  }
}

Input Schema

NameRequiredDescriptionDefault
revealNoShow secrets (passwords/keys) unmasked.
routerNoWhich router (see router_status 'routers'); default main.main
sectionNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.1.0

TDQS

A4.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint=false, so the safety profile is fully covered elsewhere. The description contributes real behavioral information beyond that: secrets are masked unless reveal is set, and omitting section returns the section list rather than an error. It says nothing about response shape, size limits, or what happens for an unknown section, which keeps it at a solid but not rich 3.

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 compact sentences: resource scope first, the discovery mode second, the secret-masking caveat last. Every clause carries actionable information and there is 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?

For a read-only, three-parameter tool with no output schema, the description covers what is read, how to discover sections, and how secrets are handled. Remaining omissions (response format, behavior on an invalid section) are minor for a simple getter whose annotations already establish the safety profile.

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 67%, and the one undocumented parameter is exactly the one the description carries: section accepts friendly names or a form path from router_catalog, and may be omitted to list sections. Router and reveal are already documented in the schema, and the description adds that router defaults to 'main' via router_status 'routers'. The enumerated section names are marked 'e.g.', so the value space is illustrative rather than exhaustive.

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?

Uses a specific verb (Read) plus a bounded resource (one section of the router config), then enumerates concrete valid section names such as dhcp, clients, wifi, firewall, and explains the no-argument mode lists sections. That distinction separates it cleanly from router_raw_read, router_catalog, and the write-oriented siblings like wifi_set without opening any schema.

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 clear operative guidance: 'Call with no section to list sections' enables self-discovery, and 'any form path from router_catalog' tells the agent where to look when a friendly name is not enough. It stops short of explicitly excluding alternatives (e.g. use router_raw_read for unparsed output, use dhcp_server_set for changes), so the when-not is only implied.

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