Skip to main content
Glama

session_stop

Destructive

Stop a running Veeam session and cancel its underlying operation. Use dry_run=True to preview without stopping; stopped sessions must be re-issued via the originating job or restore.

Instructions

[WRITE] Stop a running session (cancels the underlying operation).

No undo token — a stopped session must be re-issued via the originating job/restore. Pass dry_run=True to preview.

Args: session_id: Veeam session id (see session_list). dry_run: If True, preview without stopping. target: Veeam target name from config.

Input Schema

NameRequiredDescriptionDefault
targetNo
dry_runNo
session_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.10.0
  2. Removedv0.8.0
  3. First observedv0.2.0

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare destructiveHint=true, readOnlyHint=false, idempotentHint=false, so the safety profile is covered. The description goes beyond them usefully by disclosing that stopping cancels the underlying operation and is irreversible without re-issuing from the originating job/restore.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loads the [WRITE] tag and the core action, then layers reversibility and arg notes with no filler sentences. The Args block largely restates what the schema titles already convey, which is mild redundancy.

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?

For a 3-param mutation with annotations and no output schema, the description covers action, destructiveness, reversibility, and the dry-run escape hatch. Return value shape and any auth/target-selection requirements are the only notable omissions.

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

Parameters4/5

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

Schema description coverage is 0%, so the description carries the full burden and does document all three parameters. session_id points to session_list as the source, dry_run explains the preview behavior, and target is identified as a name from config — terse but adequate compensation.

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?

States a specific verb+resource ('Stop a running session') and clarifies the effect ('cancels the underlying operation'), plus tags it as [WRITE]. It does not explicitly contrast with the sibling job_stop, so an agent must infer the session-vs-job boundary itself.

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

Usage Guidelines3/5

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

Adds real consequence guidance ('No undo token — a stopped session must be re-issued via the originating job/restore') and the dry_run preview path, which is more than nothing. However, it never states when to use this instead of the adjacent job_stop/job_disable tools or what prerequisites exist.

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