Skip to main content
Glama
Sign In
vmware-aria

vmware-aria

by vmware-skills
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Remote

list_resources

Read-onlyIdempotent

Retrieve resource UUIDs from Aria Operations by filtering on kind, name, or collection status. Start here to identify resources before fetching details with other tools.

Instructions

[READ] List resources in Aria Operations filtered by kind. Start here: this turns a name or kind into the UUID other resource tools need. Then call get_resource for detail on one row.

Each row carries aria_state (Aria's lifecycle state — STARTED even for a powered-off VM, so not a power state) and collection_status (whether data is arriving: DATA_RECEIVING, NO_DATA_RECEIVING, ...; null when Aria did not report one). status is kept for existing callers and equals aria_state.

Returns a paginated envelope: items, returned, limit, total (null when the API reports no size, or when name_filter / collection_status filtered the rows), truncated, hint, and note when a collection_status filter matched nothing (it names the statuses seen). Check truncated before calling this the complete set.

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": "list_resources"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNoMaximum number of results. Default 100. Paginated automatically, so a larger limit spans more than one page.
targetNoAria target name from config; default when omitted.
name_filterNoSubstring filter on resource name (case-insensitive).
resource_kindNoe.g. VirtualMachine, HostSystem, ClusterComputeResource, Datastore, Datacenter — or "all" for every kind (an adapter instance's objects span several kinds).VirtualMachine
collection_statusNoKeep only rows with this collection_status, case-insensitive. NO_DATA_RECEIVING lists the objects an "Objects are not receiving data from adapter instance" alert is about.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv1.15.0
    • addedInput schema / properties / collection_status
      Added value: +{
+  "anyOf": [
+    {
+      "type": "string"
+    },
+    {
+      "type": "null"
+    }
+  ],
+  "default": null,
+  "description": "Keep only rows with this collection_status, case-insensitive. NO_DATA_RECEIVING lists the objects an \"Objects are not receiving data from adapter instance\" alert is about.",
+  "title": "Collection Status"
+}
    • changedInput schema / properties / resource_kind / description
      Previous value: -"e.g. VirtualMachine, HostSystem, ClusterComputeResource, Datastore, Datacenter."New value: +"e.g. VirtualMachine, HostSystem, ClusterComputeResource, Datastore, Datacenter — or \"all\" for every kind (an adapter instance's objects span several kinds)."
  2. Changed5 schema fields changedv1.10.0
    • addedInput schema / additionalProperties
      Added value: +false
    • addedInput schema / properties / limit / description
      Added value: +"Maximum number of results. Default 100. Paginated automatically, so a larger limit spans more than one page."
    • addedInput schema / properties / name_filter / description
      Added value: +"Substring filter on resource name (case-insensitive)."
    • addedInput schema / properties / resource_kind / description
      Added value: +"e.g. VirtualMachine, HostSystem, ClusterComputeResource, Datastore, Datacenter."
    • addedInput schema / properties / target / description
      Added value: +"Aria target name from config; default when omitted."
  3. 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": "list_resourcesOutput",
-  "type": "object"
-}New value: +null
  4. Addedv1.5.29
  5. Removedv1.5.28
  6. First observedv1.3.2

TDQS

A4.5/5.0
Behavior5/5

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

Adds substantial behavior beyond the annotations: clarifies that aria_state is a lifecycle state, not a power state; explains collection_status semantics; notes the status alias; details the paginated envelope; and warns to check truncated. No contradiction with 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?

Well-structured and front-loaded with [READ] and the core purpose. The longer sections on row fields and return envelope earn their place because there is no output schema to carry that information otherwise.

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?

Complete for a read-only list tool: the description details the return envelope, pagination behavior, caveats around null total, and special note behavior. Combined with the annotations and full schema coverage, an agent has everything needed to call it correctly.

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 coverage is 100%, so the schema already documents all five parameters. The description adds some context around filtering and output caveats, but it does not significantly enrich the meaning of individual parameters beyond the schema.

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 ('List resources in Aria Operations filtered by kind') and a clear purpose: translating a name or kind into the UUID that other resource tools require. It distinguishes itself from get_resource by describing the list-to-detail workflow.

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?

Gives explicit workflow guidance: 'Start here' to resolve a UUID, then 'call get_resource for detail on one row.' This clearly establishes context for use, though it does not explicitly enumerate exclusions such as 'skip this if you already have the UUID.'

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