YuniKorn MCP Server

Overview Schema Source Related Servers Discussions Admin

get_user_usage

Retrieves resource usage and quota details for all users or a specific user in a YuniKorn partition, enabling monitoring of CPU and memory consumption against configured limits.

Instructions

Retrieves resource usage and quota information for all users or a specific user. IMPORTANT: resource values are raw integers (bytes for memory, millicores for CPU). Convert these to human-readable formats (e.g., GiB or Cores) before presenting to the user.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "partitionName": "<partitionName>"
    },
    "name": "get_user_usage"
  }
}

Input Schema

Name	Required	Description	Default
`userName`	No
`partitionName`	Yes

Output Schema

Name	Required	Description	Default
`result`	Yes

Schema Changelog

Changes observed during successful MCP inspections.

First observedv0.1.0Aug 1, 2026

TDQS

A3.8/5.0

Behavior4/5

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

With no annotations, the description carries the behavioral burden. It prominently discloses that resource values are raw integers (bytes, millicores) and instructs conversion, which is critical for correct interpretation of results. This goes beyond simple read-only intent, though it omits details like error conditions or permission requirements.

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?

Two sentences, each earns its place. The first states the tool's purpose, and the second delivers a high-value conversion warning. No filler or redundant repetition of schema details.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The output schema covers return structure, and the description supplies the missing unit semantics. For a simple read-only usage tool, this is sufficient context; the only gap is the lack of explicit usage guidance, already scored separately.

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 0%, so description must compensate. It clarifies that the optional userName parameter can target a specific user or omit to get all users, which maps directly to the schema's default-null userName. However, it does not explain partitionName beyond the schema title, leaving partial ambiguity.

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?

Description uses a specific verb ('Retrieves') and resource ('resource usage and quota information') with clear scope ('all users or a specific user'). This clearly distinguishes it from sibling tools focused on partitions, queues, applications, nodes, and health.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No guidance on when to use this tool versus siblings, no explicit exclusions, and no prerequisites are stated. The description implies a query tool but does not help the agent decide between it and related tools.

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

Deploy Server