Skip to main content
Glama
Sign In
vmware-knight

vmware-knight

by CyberKnightLabs
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Remote

scan_datastore_images

Read-onlyIdempotent

Discover deployable images across all accessible datastores when you don't know which one holds them. Refreshes the local image registry and returns OVA, ISO, OVF, and VMDK files.

Instructions

[READ] Scan all accessible datastores for deployable images (OVA/ISO/OVF/VMDK).

Returns the images found and refreshes the cache at ~/.vmware-knight/image_registry.json. Use this when you do not know which datastore holds an image; prefer browse_datastore once you do, because this walks every datastore and may take minutes on a large estate.

Returns: The family list envelope {items, returned, limit, total, truncated, hint} plus last_scan; each item is one image. images is kept as a deprecated alias for items.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "scan_datastore_images"
  }
}

Input Schema

NameRequiredDescriptionDefault
targetNoOptional vCenter/ESXi target name from config.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.12.10

TDQS

A4.4/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, so the safety profile is covered. The description adds valuable context: it refreshes a local cache file, may be slow on large estates, and describes the return envelope (including a deprecated alias). This goes beyond what annotations convey and is consistent with them.

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?

The description is well-organized: a one-line purpose, a usage note, and a returns section. It front-loads the core action and packs the return format into a compact paragraph. While not as terse as the best examples, every sentence earns its place and there is no filler.

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 scan tool with one optional parameter and no output schema, the description explains the return envelope, the cache side effect, and the performance caveat. It gives the agent everything needed to decide when to call it and what to expect, making it complete for its complexity.

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?

The single parameter 'target' is fully described in the schema (coverage 100%) as 'Optional vCenter/ESXi target name from config.' The description does not add any additional meaning or syntax details about this parameter, so the baseline of 3 applies since the schema handles it completely.

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 opens with a specific verb-resource pair, 'Scan all accessible datastores for deployable images (OVA/ISO/OVF/VMDK)', and immediately contrasts itself with browse_datastore, so an agent can distinguish it without opening the schema. It names the exact image types it looks for, which is concrete and unambiguous.

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 states the triggering condition ('Use this when you do not know which datastore holds an image') and the alternative ('prefer browse_datastore once you do'), including a rationale about performance ('walks every datastore and may take minutes on a large estate'). This is textbook when/when-not guidance.

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