Skip to main content
Glama
netmiko-mcp-linksys

netmiko-mcp-linksys

by WackEarl

port_set_description

Sets or clears a switch port's interface description, omitting text clears it; changes are not saved.

Instructions

Set an interface description, or clear it when text is omitted. Does not save.

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": {
      "port": "<port>"
    },
    "name": "port_set_description"
  }
}

Input Schema

NameRequiredDescriptionDefault
portYes
textNo

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.6/5.0
Behavior3/5

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

With no annotations, the description carries the full burden and does disclose two valuable traits: the mutation is not persisted ("Does not save") and omitting text destroys the existing description. It does not cover permissions, error behavior, or whether the change applies immediately.

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 short sentences, zero waste, with the primary action front-loaded and the non-persistence caveat immediately after.

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 two-parameter mutation tool with an output schema, the description covers the essential non-obvious behaviors: clearing semantics and the need for a separate save step. The remaining gap is port identifier format, which the schema also leaves undocumented.

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 coverage is 0%, so the description must compensate. It adds critical semantics for `text` (omitted/null clears the field), but says nothing about the required `port` parameter's format or how ports are identified.

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 specific verb and resource ("Set an interface description") plus the inverse operation (clear when text is omitted). It is distinguishable from siblings like port_overview or poe_set, though it never names an alternative explicitly.

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

Usage Guidelines3/5

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

"Does not save" implicitly tells the agent to follow with save_config, and the omitted-text clause tells when clearing happens. There is still no explicit when-to-use or when-not-to-use guidance relative to other port tools.

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