Skip to main content
Glama

Get Device Details

cnc_get_device
Read-onlyIdempotent

Retrieve the full inventory record for a single Cisco Crosswork device by uuid or exact host name. Read-only; pass one selector to fetch all node fields such as state, profile, and connectivity info.

Instructions

Get the full inventory record of one device by uuid or host name.

Read-only. Pass exactly one selector. Returns every field Crosswork holds for the node: uuid, host_name, node_ip, admin_state, reachability_state, operational_state, reachability_check, profile, connectivity_info, product_info, routing_info, tag_names, dg_name/dg_uuid, nso_state, errors, creation_time, last_upd_time, ...

Note the read/write asymmetry: node_ip.inet_af reads as a string ('ROBOT_INET_ADDR_TYPE_v4') but is the integer 0 in write bodies, so do not feed this object straight back into a write.

Returns: str: JSON object of the node, or "Error: ..." (not found -> no device matched the selector; ambiguous -> a wildcard host_name matched several devices, use the uuid).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
uuidNoDevice uuid (e.g. '2a9b7c1e-0f3d-4b8a-9c6e-1d2f3a4b5c6d').
host_nameNoDevice host name, exact match, case-insensitive (e.g. 'PE1').

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.6/5.0
Behavior5/5

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

Annotations already declare readOnly/idempotent/non-destructive, yet the description adds real behavioral context: the read/write type asymmetry on node_ip.inet_af that makes round-tripping into a write unsafe, plus precise error-string semantics. That is value well beyond the annotation set.

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?

Front-loads the purpose, then constraints, then error semantics — a sensible order. Slightly long: enumerating every returned field is redundant given an output schema exists, so a few lines do not fully earn their 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?

Covers selection rules, read-only nature, notable data pitfalls, and both error shapes. With an output schema present it does not need to describe the return payload, so nothing an agent needs to call this correctly is missing.

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 100%, so uuid/host_name are already documented. The description still adds meaning: exactly one selector must be supplied, and the two selectors behave differently on ambiguity since only uuid guarantees a unique match. Minor tension: it mentions a 'wildcard host_name' while the schema declares exact match.

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?

States a specific verb ('Get'), resource ('full inventory record of one device'), and both accepted selectors (uuid or host name). The singular 'one device' cleanly separates it from the sibling cnc_list_devices.

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?

Explicitly instructs 'Pass exactly one selector' and explains the two failure modes and their remedy (not found vs. ambiguous wildcard -> use the uuid). It does not name cnc_list_devices as the alternative for enumeration, but the singular scope makes the choice inferable.

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