Skip to main content
Glama

get_top_consumers

Read-onlyIdempotent

Identify top consumers of a given metric. Query virtual machines with highest CPU, memory, or disk usage to locate capacity bottlenecks.

Instructions

[READ] Query resources with highest consumption of a given metric. Then call get_resource_metrics on a returned id for its history.

Returns a paginated envelope: items, returned, limit, total (null when the API reports no size), truncated, hint. Check truncated before calling this the complete set.

Args: metric_key: Metric to rank by, e.g. cpu|usage_average, mem|usage_average, disk|usage_average. resource_kind: Resource kind to scope the query. Default VirtualMachine. top_n: Number of top consumers to return (max 50). Default 10. target: Aria target name from config; default when omitted.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
top_nNo
targetNo
metric_keyNocpu|usage_average
resource_kindNoVirtualMachine
Behavior5/5

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

Despite strong annotations (readOnly, idempotent, etc.), the description adds valuable behavioral context by defining the paginated envelope, including the 'truncated' flag and the note that 'total' may be null. This goes beyond annotation hints and helps the agent handle responses correctly.

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?

The description is tightly organized into a summary line, output details, and parameter list. Every sentence adds value, with no unnecessary filler. The structure makes it easy to scan and parse.

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?

Given the 4 parameters and no output schema, the description provides all essential information: purpose, usage guidance, response envelope structure, and parameter semantics. It is fully adequate for an agent to select and invoke the tool correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The schema provides no descriptions (0% coverage), but the description compensates fully with detailed Arg explanations: metric_key gets example values, resource_kind gets a default, top_n gets a max and default, and target is explained as a config reference. This is exemplary parameter documentation.

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 action ('Query resources with highest consumption of a given metric') and clearly identifies the resource type and metric. It also distinguishes itself by mentioning the follow-up call to get_resource_metrics for history, making its role clear among siblings.

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?

The description explicitly indicates when to use the tool (to get top consumers) and directs the agent to call get_resource_metrics on a returned id for history, providing a clear alternative/additional step. It does not leave ambiguity about its primary use case.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/vmware-skills/VMware-Aria'

If you have feedback or need assistance with the MCP directory API, please join our Discord server