Skip to main content
Glama

scan_datastore_images

Read-onlyIdempotent

Scan a datastore for deployable images (OVA, ISO, OVF, VMDK). Returns each image found with complete listing details, supporting optional subdirectory path.

Instructions

[READ] Scan a datastore for deployable images (OVA, ISO, OVF, VMDK).

Use this for a live scan of one datastore; prefer list_cached_images for a cached answer. ds_name comes from list_all_datastores.

Returns the list envelope: 'items' holds one row per image, and 'returned'/'total'/'truncated' state whether the listing is complete. All patterns are browsed, so truncated is always false.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathNoSubdirectory path (empty for root).
targetNoOptional vCenter/ESXi target name from config.
ds_nameYesDatastore name.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv1.8.15
    • addedInput schema / additionalProperties
      Added value: +false
    • addedInput schema / properties / ds_name / description
      Added value: +"Datastore name."
    • addedInput schema / properties / path / description
      Added value: +"Subdirectory path (empty for root)."
    • addedInput schema / properties / target / description
      Added value: +"Optional vCenter/ESXi target name from config."
  2. Changed1 schema field changedv1.8.9
    • changedOutput schema / (root)
      Previous value: -{
      -  "properties": {
      -    "result": {
      -      "items": {
      -        "additionalProperties": true,
      -        "type": "object"
      -      },
      -      "title": "Result",
      -      "type": "array"
      -    }
      -  },
      -  "required": [
      -    "result"
      -  ],
      -  "title": "scan_datastore_imagesOutput",
      -  "type": "object"
      -}New value: +null
  3. First observedv1.3.2

TDQS

A4.9/5.0
Behavior5/5

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

The description adds return-structure detail beyond annotations: 'items' holds one row per image and 'returned'/'total'/'truncated' state completeness. It also discloses a non-obvious behavior: 'All patterns are browsed, so truncated is always false.' This complements readOnlyHint/openWorldHint/idempotentHint without contradicting them.

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?

Four compact sentences front-load the action, then give usage routing, parameter provenance, and response shape. No filler or repetition of schema/annotations.

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 read-only scan tool with no output schema, the description covers what an agent needs: purpose, when to choose it vs list_cached_images, where to get ds_name, and what the response envelope looks like. The schema covers parameter details, and annotations cover safety semantics.

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?

The input schema already covers all three parameters at 100% (path, target, ds_name). The description adds one meaningful relationship—'ds_name comes from list_all_datastores'—which helps the agent populate the required parameter correctly.

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 action ('Scan a datastore for deployable images') with concrete artifact types (OVA, ISO, OVF, VMDK). The '[READ]' prefix and 'live scan of one datastore' frame exactly what it does, and the explicit contrast with list_cached_images distinguishes it from a sibling.

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?

Directly instructs when to use: 'Use this for a live scan of one datastore; prefer list_cached_images for a cached answer.' It also chains the required parameter to another tool ('ds_name comes from list_all_datastores'), giving the agent a clear call path.

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