Skip to main content
Glama
legacy-switch-mcp

legacy-switch-mcp

describe_switch

Generates a Markdown overview of a switch's configuration for wiki documentation, enabling quick read-only inspection without changing device settings.

Instructions

Markdown description of a switch's configuration for a wiki. Read-only.

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": {
      "switch": "<switch>"
    },
    "name": "describe_switch"
  }
}

Input Schema

NameRequiredDescriptionDefault
switchYes

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

C2.8/5.0
Behavior3/5

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

No annotations are supplied, so the description carries the full behavioral burden. It does disclose the two most important traits: the operation is read-only and the output is Markdown formatted for a wiki. It says nothing about error behavior for an unknown switch, cost/latency, or whether the output is templated versus free-form.

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?

Two short sentences with no filler, and the key output characteristic (Markdown for a wiki) is stated up front. The trailing 'Read-only' fragment is terse but earns its place as a safety signal.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/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 not be explained, and the description covers purpose and read-only safety. The remaining gap is the parameter identifier format and any routing guidance among the many config-reading siblings, which leaves the definition only minimally sufficient.

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

Parameters2/5

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

Schema coverage is 0% for the single required parameter 'switch', and the description only says it concerns 'a switch's configuration'. It does not clarify whether the parameter is a name, an index, an IP, or an ID, so an agent gets no help identifying the accepted identifier format.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description identifies the resource (a switch's configuration) and the output form (Markdown text intended for a wiki), which is more specific than the name alone. But it is written as a noun phrase with no verb, and it never says whether this returns a rendered document, a file path, or a string, so the agent must infer the operation from the tool name.

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

Usage Guidelines2/5

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

There is no statement of when to call this instead of siblings such as get_state, overview, or backup_config, all of which plausibly touch switch configuration. The only usage signal is the word 'Read-only', which describes safety, not selection criteria.

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