Skip to main content
Glama

Get Serial Console Access to a VM

get_vm_console_access
Destructive

Mint serial-over-SSH credentials so the USER can open their own interactive console session on a virtual machine, and return the exact ssh command to run. Use this when a person wants to drive the console themselves — poke around, watch a boot, run an interactive installer or a TUI. To run a specific command and get its output back, use run_vm_command instead; do NOT take these credentials and try to drive an interactive shell yourself.

What comes back: the ssh command, the connection address, the connection secret (used at ssh's own password prompt), and the token's expiry. The credentials reach the VM's serial console through the Cycle gateway — no VM networking required, so this works even with public networking disabled or the guest's network broken.

Logging IN to the guest is separate: past ssh, the console lands at the guest's own login prompt. The response includes the generated root password when it is still retrievable (~10 minutes after creation); after that the user needs their own guest credentials or an attached SSH key.

Relay the credentials to the user plainly so they can paste the command. They are short-lived and they grant root-capable console access — treat them as a secret, do not write them into files, commits, or issues.

action:"revoke" expires ALL serial-over-SSH tokens for the VM, immediately disconnecting every active console session on it (including a session the user is in the middle of, and anyone else's). It is a mutation: confirm with the user before calling it.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
actionNogrant (default) mints credentials for a new console session. revoke expires ALL of the VM's console tokens, disconnecting every active session — confirm with the user first.grant
contextNoWhy are you calling this tool? Briefly describe the user's goal.
environmentYesEnvironment the VM lives in.
conversation_idNoConversation tracking id. Omit on your first tool call; every result then includes a conversation_id line — pass that exact value on all later calls in this conversation.
virtual_machineYesVM to get console access to.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.7/5.0
Behavior5/5

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

Goes well beyond the annotations: it explains that credentials reach the console via the Cycle gateway (works with networking disabled), that returning root password is only retrievable ~10 minutes, and critically that action:'revoke' destroys ALL tokens for the VM and disconnects every active session including a mid-session user, with an instruction to confirm first. This is rich disclosure for a destructive, non-idempotent mutation.

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?

Front-loaded with the core purpose and sibling routing, then layered detail (what comes back, login nuance, secret handling, revoke semantics) in distinct, purposeful paragraphs. Despite its length, the security-critical nature of minting root-capable credentials justifies every section.

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?

No output schema exists, yet the description enumerates the return payload (ssh command, address, secret, expiry, root password) and covers the two-mode behavior (grant vs revoke), credential handling, and login separation. An agent has everything needed to call and relay results 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 description coverage is 100% and the schema already defines 'action' enum semantics, so the baseline is 3. The description reinforces the meaning of action:'revoke' and clarifies what the grant returns, but adds no parameter syntax or format detail 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 verb+resource combination ('Mint serial-over-SSH credentials' for a virtual machine) and the scope of use (interactive console session driven by the user). It explicitly distinguishes itself from the sibling run_vm_command, so an agent can select between the two without opening either schema.

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 names the when ('a person wants to drive the console themselves — poke around, watch a boot, run an interactive installer or a TUI') and the alternative ('To run a specific command and get its output back, use run_vm_command instead'), plus a hard exclusion ('do NOT take these credentials and try to drive an interactive shell yourself').

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources