Skip to main content
Glama

Get SwOS Endpoint

get_swos_endpoint
Read-onlyIdempotent

Fetch and decode a single SwOS .b endpoint as structured data, preserving unknown keys under _raw for flexible network automation.

Instructions

Fetch and decode a single SwOS '.b' endpoint (link.b, sys.b, poe.b, lacp.b, rstp.b, snmp.b, fwd.b, vlan.b, stats.b, sfp.b, host.b, acl.b, ...) as structured data. Unknown keys are preserved under '_raw'.

Input Schema

NameRequiredDescriptionDefault
endpointYes'.b' endpoint to fetch (see list_swos_endpoints)
routerIdNoRouter ID; omit to use the default router.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.14.1
    • changedInput schema / properties / endpoint / enum
      Previous value: -[
      -  "!aclstats.b",
      -  "!dhost.b",
      -  "!igmp.b",
      -  "!stats.b",
      -  "acl.b",
      -  "fwd.b",
      -  "host.b",
      -  "lacp.b",
      -  "link.b",
      -  "poe.b",
      -  "rstp.b",
      -  "sfp.b",
      -  "snmp.b",
      -  "sys.b",
      -  "vlan.b"
      -]New value: +[
      +  "!aclstats.b",
      +  "!dhost.b",
      +  "!igmp.b",
      +  "!stats.b",
      +  "acl.b",
      +  "fwd.b",
      +  "host.b",
      +  "lacp.b",
      +  "link.b",
      +  "poe.b",
      +  "rstp.b",
      +  "sfp.b",
      +  "snmp.b",
      +  "stats.b",
      +  "sys.b",
      +  "vlan.b"
      +]
  2. Addedv1.9.0

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already cover the read-only, idempotent, non-destructive profile. The description adds a valuable behavioral detail: unknown keys are preserved under '_raw', which tells the agent how to handle unexpected fields. It does not mention authentication or error behavior, but given the annotation coverage this is a solid addition.

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 tight sentences: the first front-loads the purpose with examples, the second adds a key behavioral note. No filler or redundancy, every clause earns its place.

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

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple read tool with 100% schema coverage, rich annotations, and no output schema, the description covers what the tool does and a key behavior (_raw). Nothing critical is missing for an agent to invoke it correctly.

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 100%, so both parameters are documented in the schema. The description lists many endpoint examples, but this largely duplicates the enum and adds no syntax or semantic detail beyond what the schema provides. Baseline 3 is appropriate.

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 ('Fetch and decode') and resource ('a single SwOS '.b' endpoint') with examples, and the word 'single' implicitly distinguishes it from list_swos_endpoints. However, it does not explicitly name the sibling or contrast it with get_swos_config or other SwOS tools, so it falls short of full sibling differentiation.

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?

The description implies usage (fetch one endpoint's structured data) but provides no explicit when-to-use, when-not-to-use, or alternative tool guidance. An agent must infer that list_swos_endpoints is for listing and this is for retrieving a specific endpoint.

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

Deploy Server

Other Tools