Skip to main content
Glama

sylve_network_overview

Read-onlyIdempotent

Query one network subsystem—interfaces, switches, routes, DHCP, firewall, objects, or WireGuard—on a FreeBSD cluster node or cluster-wide to inspect configuration and status.

Instructions

Query one network subsystem (interfaces, switches, routes, DHCP, firewall, objects, WireGuard).

Input Schema

NameRequiredDescriptionDefault
kindNo
nodeNoTarget cluster node hostname or UUID. Omit for cluster-wide.
contextNoNamed login context from ~/.config/sylve/config.yaml.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.4/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 without prose. The description adds only the scoping notion of "one subsystem" and says nothing about result volume, cost of the broad `all` value, or failure modes when `node` is unreachable.

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?

A single front-loaded sentence with no filler; the scope word "one" appears early. Its brevity is a virtue, though the parenthetical enumeration could have been spent on the values it actually omits.

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?

With no output schema, the description carries the burden of conveying what comes back, and it says nothing about return shape or granularity. The discrepancy between "one subsystem" and the available `all` value is left for the agent to discover from the schema.

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?

Node and context are documented in the schema (67% coverage); `kind` is enum-only, so the description is the only prose source — but its list is both incomplete and imprecise, collapsing four distinct firewall values into "firewall" and omitting `global_config` and `all`. That leaves the most consequential enum values (`all`, `global_config`) unexplained.

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?

Specific verb ("Query") plus resource class ("one network subsystem") and an illustrative enumeration of the subsystems, so an agent knows this is the network read tool. Sibling differentiation is implicit rather than stated — none of the listed siblings cover networking, so the gap is minor.

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?

Implies one call per subsystem, which hints at how to drive the `kind` parameter, but gives no explicit when/when-not, no mention that `kind` is optional, and no guidance on combining `node` with cluster-wide queries. Usage is inferable from the parenthetical list only.

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