Skip to main content
Glama

VNISH Global Operator

Find a VNISH Ninja reference

find_ninja_reference
Read-onlyIdempotent

Return a selected public VNISH Ninja guide about control-board identification, installation SSH errors, or return-to-stock preparation. A reference is not a device-specific installation or recovery instruction. No device connection or action is performed.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
topicYes
languageNoen

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false, and idempotentHint=true. The description adds value by explicitly stating 'No device connection or action is performed,' which reinforces the read-only nature and clarifies that no side effects occur. It also notes the guide is public, implying no auth needs, which is useful context beyond annotations.

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?

Three sentences with no waste. The primary purpose is front-loaded, followed by a clarifying exclusion and a final note on behavior. Every sentence earns its place, and the structure is easy to parse.

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 simple lookup tool with two parameters and strong annotations, the description covers the purpose, the scope of topics, the non-device-specific nature, and the no-action behavior. It does not mention return format or the language parameter, but the schema covers those. The description is largely complete for an agent to invoke correctly, though a bit more on the language parameter would make it fully complete.

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 0%, so the description must compensate. It mentions the three topics (control-board identification, installation SSH errors, return-to-stock preparation) which align with the topic enum, giving meaning to that parameter. However, it does not explain the language parameter or its default, and it does not explicitly map the topics to the enum values. The description adds some context but not full parameter semantics for both parameters.

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 states a specific verb ('Return') and resource ('a selected public VNISH Ninja guide'), and enumerates the exact topics covered. It distinguishes itself from siblings by clarifying it is a reference, not a device-specific instruction, so an agent can tell it apart from calculate_roi_scenario and lookup_firmware without inspecting schemas.

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?

It clearly states that the tool is not for device-specific installation or recovery instructions, providing a clear exclusion. However, it does not explicitly name alternative tools or conditions for when to use this tool vs. others, though the exclusion implies the boundary. The context is clear enough for typical use.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.