Skip to main content
Glama

Raw GET on the NBI

acs_read
Read-onlyIdempotent

Read permitted GenieACS NBI GET paths to inspect devices, tasks, faults, files, presets, provisions, virtual parameters, or objects; non-GET requests and restricted write paths are refused.

Instructions

Escape hatch: GET any readable NBI path, e.g. "/devices?limit=3&projection=id" or "/virtualparameters". Allowed collections: /devices /tasks /faults /files /presets /provisions /virtualparameters /objects. Only GET is sent; POST/PUT/PATCH/DELETE, /devices/{id}/tasks, tag changes and the connection_request flag are refused by policy. Prefer the dedicated acs* tools.

Input Schema

NameRequiredDescriptionDefault
pathYesNBI path with optional query string, starting with "/".
methodNoMust be GET (default). Anything else is refused.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.6/5.0
Behavior4/5

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

The annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false, and openWorldHint=false. The description adds meaningful policy context beyond those annotations: only GET is sent, write methods are refused, and certain paths and flags such as /devices/{id}/tasks and connection_request are blocked. It does not cover authentication, rate limits, or response shape, so it is not fully rich, but it substantially improves behavioral transparency.

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?

The description is front-loaded with the core purpose as an escape hatch, then gives examples, allowed paths, policy restrictions, and the sibling-tool preference. Every sentence carries operational value, and there is no redundant or filler text.

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 raw GET tool with full schema coverage and read-only annotations, the description covers purpose, allowed paths, method restrictions, refusals, and alternatives. Since there is no output schema, it need not explain return values in detail. It could mention authentication or response format, but the essential invocation context is present.

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 description coverage is 100%, so the baseline is 3. The description still adds value by enumerating allowed collections for the path parameter and showing concrete path-with-query examples such as /devices?limit=3&projection=_id. It also reinforces that method must be GET, though it does not explain query parameter semantics in depth.

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?

The description gives a specific verb and resource: a raw GET against any readable NBI path, with examples and an explicit allowed-collection list. It also distinguishes the tool from dedicated siblings by calling itself an escape hatch and saying to prefer the acs_* tools. An agent can immediately tell what this tool is for and how it differs from acs_devices, acs_tasks, etc.

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

Usage Guidelines5/5

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

It explicitly frames the tool as an escape hatch and says to prefer the dedicated acs_* tools, which directly names the alternatives. It also states which methods and paths are refused by policy, giving clear when-not guidance. This is strong routing guidance rather than implied usage.

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