Skip to main content
Glama
vmware-skills

vmware-vdi

by vmware-skills
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Remote

session_logoff

Destructive

Force-logoff VMware Horizon sessions by session ID or user, previewing affected sessions for confirmation to prevent accidental disconnects.

Instructions

[WRITE] Force-logoff Horizon session(s) — kicks the user, triggers profile write-back.

Identify targets by explicit session_ids OR by user (all of that user's sessions). A bare call returns blast_radius — session ids, count and affected users — and logs off nothing; confirm=True logs off. A session whose user cannot be read is refused. Show blast_radius to the user and wait for their decision. Do not set confirm=True on your own because the user asked for this earlier: they have not seen the blast radius yet. Audited.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
userNoLog off all sessions of this AD user (substring match); refuses if none match.
targetNoHorizon target from config.yaml; omit to use the default.
confirmNoFalse (default) returns the blast radius and changes nothing. True logs off.
session_idsNoSession ids to log off (from session_list).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.2.0
    • changedInput schema / properties / confirm / description
      Previous value: -"False previews; True logs off."New value: +"False (default) returns the blast radius and changes nothing. True logs off."
  2. Changed5 schema fields changedv1.1.1
    • addedInput schema / additionalProperties
      Added value: +false
    • addedInput schema / properties / confirm / description
      Added value: +"False previews; True logs off."
    • addedInput schema / properties / session_ids / description
      Added value: +"Session ids to log off (from session_list)."
    • addedInput schema / properties / target / description
      Added value: +"Horizon target from config.yaml; omit to use the default."
    • addedInput schema / properties / user / description
      Added value: +"Log off all sessions of this AD user (substring match); refuses if none match."
  3. First observedv1.0.1

TDQS

A4.3/5.0
Behavior5/5

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

Beyond the destructive/readOnly annotations, the description discloses the write-back trigger, the safe dry-run blast radius behavior, the refusal condition for unreadable users, and the audit trail. This is substantial behavioral context an agent needs before invoking a destructive tool.

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 front-loaded with the core operation and side effect, then packs target selection, confirmation semantics, user-consent requirement, and audit status into a compact block. Every sentence earns its place with no redundant filler.

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 destructive tool with no output schema, the description is complete: it explains the safe default, what the blast radius contains, how to confirm, when a call is refused, and that the operation is audited. An agent has everything needed to invoke it correctly and safely.

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% and the parameter descriptions already cover substring matching, session_list origin, blast-radius behavior, and default target. The description adds little parameter-level meaning beyond reinforcing the session_ids-or-user choice, so the baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly identifies the action (force-logoff), the resource (Horizon sessions), and the side effect (kicks the user, triggers profile write-back), with target identification by session_ids or user. It doesn't explicitly name or contrast session_disconnect, but the 'force-logoff/write-back' framing is specific enough to avoid confusion with the disconnect sibling.

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?

It gives explicit workflow guidance: bare call returns blast radius, confirm=True performs the logoff, show blast radius to user, and do not set confirm=True unilaterally. It doesn't explicitly state when to prefer this over session_disconnect or other siblings, so it stops short of a full when/when-not comparison.

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