Skip to main content
Glama
vmware-skills

vmware-vdi

by vmware-skills
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Remote

session_list

Read-onlyIdempotent

List Horizon VDI sessions filtered by user, pool, or state to retrieve session IDs for verifying or targeting logoff/disconnect operations.

Instructions

[READ] List Horizon VDI sessions, filtered by user / pool id / state. Paginated.

Returns a {items, returned, limit, total, truncated, hint} envelope; each item has id, user, type (DESKTOP/APPLICATION), state (CONNECTED/DISCONNECTED/PENDING), protocol (BLAST/PCOIP/RDP), pool_id, machine_id, start_time. This is the verify pair for logoff/disconnect — get a session id or confirm a user's sessions here first.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
poolNoExact desktop-pool / farm id.
userNoSubstring-match the AD user name.
limitNoPage size (default 50).
stateNoCONNECTED, DISCONNECTED, or PENDING.
offsetNoPage offset.
targetNoHorizon target from config.yaml; omit to use the default.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed7 schema fields changedv1.1.1
    • addedInput schema / additionalProperties
      Added value: +false
    • addedInput schema / properties / limit / description
      Added value: +"Page size (default 50)."
    • addedInput schema / properties / offset / description
      Added value: +"Page offset."
    • addedInput schema / properties / pool / description
      Added value: +"Exact desktop-pool / farm id."
    • addedInput schema / properties / state / description
      Added value: +"CONNECTED, DISCONNECTED, or PENDING."
    • addedInput schema / properties / target / description
      Added value: +"Horizon target from config.yaml; omit to use the default."
    • addedInput schema / properties / user / description
      Added value: +"Substring-match the AD user name."
  2. First observedv1.0.1

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already cover read-only, idempotent, non-destructive. Description adds the return envelope shape and field enumeration, plus pagination. It also states the READ nature upfront. That adds context beyond annotations, though it doesn't discuss any edge cases like empty results or errors.

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, front-loaded with [READ] and purpose, then compact return spec. No wasted words.

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 paginated list with rich output spec, the description is complete: it explains the envelope, item fields, and the verify use-case. Given annotations cover safety, nothing critical is missing.

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 covers all 6 parameters with descriptions (100% coverage). Description summarizes filters but doesn't add new meaning beyond what schema provides; baseline 3 is appropriate.

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 'List' and resource 'Horizon VDI sessions', with explicit filters (user/pool/state) and pagination. Distinguishes from siblings by calling itself the 'verify pair' for logoff/disconnect, so the agent knows it's the listing tool for those actions.

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 tells when to use it: 'This is the verify pair for logoff/disconnect — get a session id or confirm a user's sessions here first.' This gives clear context for when to invoke it, though it doesn't list alternatives or exclusions. Still, it's strong guidance.

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