Skip to main content
Glama

scan_datastore_images

Read-onlyIdempotent

Scan a datastore to list deployable images (OVA, ISO, OVF, VMDK) for live inventory; use list_cached_images for cached results.

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. datastore_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
pathNoDatastore-relative subdirectory (empty for root); a leading '/' or '..' is refused. The images found replace this datastore's cached entries under that folder, for list_cached_images.
targetNoOptional vCenter/ESXi target name from config.
datastore_nameYesDatastore name.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv2.4.2
    • changedInput schema / properties / path / description
      Previous value: -"Subdirectory path (empty for root)."New value: +"Datastore-relative subdirectory (empty for root); a leading '/' or '..' is refused. The images found replace this datastore's cached entries under that folder, for list_cached_images."
  2. Changed3 schema fields changedv2.0.0
    • addedInput schema / properties / datastore_name
      Added value: +{
      +  "description": "Datastore name.",
      +  "title": "Datastore Name",
      +  "type": "string"
      +}
    • removedInput schema / properties / ds_name
      Removed value: -{
      -  "description": "Datastore name.",
      -  "title": "Ds Name",
      -  "type": "string"
      -}
    • changedInput schema / required
      Previous value: -[
      -  "ds_name"
      -]New value: +[
      +  "datastore_name"
      +]
  3. 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."
  4. 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
  5. First observedv1.3.2

TDQS

A4.7/5.0
Behavior4/5

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

Annotations already declare readOnly/idempotent/non-destructive, but the description adds live-vs-cached semantics and describes the return envelope ('items', 'returned'/'total'/'truncated') that no output schema provides. It also discloses that 'all patterns are browsed, so truncated is always false', a behavioral guarantee not derivable from annotations. It does not mention that the scan repopulates cached entries (that detail lives only in the schema).

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 short blocks: purpose, routing guidance, return contract. Front-loaded with the verb and resource, no filler, and every sentence carries information an agent needs.

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?

With no output schema, the description fills the gap by explaining the list envelope and truncation semantics, and it covers the live-vs-cached decision plus parameter provenance. For a 3-parameter read tool this is complete.

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 nudges above it by explaining that datastore_name is sourced from list_all_datastores, tying the parameter to a concrete workflow step. It does not elaborate on 'path' or 'target', which the schema already documents.

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 (scan) and resource (datastore images) and enumerates the artifact types it finds (OVA, ISO, OVF, VMDK). The '[READ]' prefix plus the explicit contrast with list_cached_images makes it immediately distinguishable from its closest 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?

Explicitly scopes usage: 'live scan of one datastore; prefer list_cached_images for a cached answer' names the alternative and the condition that selects it. It also tells the agent where the required datastore_name value comes from (list_all_datastores).

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