Skip to main content
Glama

Sap Keepalive Stop

sap_keepalive_stop

Stops the background keepalive task to prevent unnecessary session activity. Use it to halt periodic pings and free up resources or reduce idle traffic in a SAP GUI session.

Instructions

Stop the background keepalive task

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "sap_keepalive_stop"
  }
}

Input Schema

NameRequiredDescriptionDefault
sessionNoSession ID to target (e.g. 's1', 's2'). Defaults to the primary session.
agent_idNoAgent ID for session binding (optional).

Output Schema

NameRequiredDescriptionDefault
errorNoError message if success=False
popupNoPresent when a popup dialog is active on screen
runningYesWhether keepalive is now running
successNoWhether the operation succeeded
active_windowNoWhich window was operated on (e.g., 'wnd[0]', 'wnd[1]'). If 'wnd[1]' or higher, a modal dialog is open.
interval_secondsNoPing interval if running

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

C2.9/5.0
Behavior2/5

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

No annotations are supplied, so the description carries the full behavioral burden. It does not say whether the call is idempotent when no task is running, whether it affects only the targeted session or all sessions, what permissions are needed, or what happens to an in-flight keepalive.

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?

A single front-loaded sentence with no filler or redundancy. It is efficient, though the terseness leaves little structural support for an agent needing more context.

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

Completeness2/5

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

The tool mutates runtime state with two optional scoping parameters, no annotations, and no explanation of effects or side effects on the SAP session. An output schema exists, so return values need not be explained, but the behavioral gaps remain significant for a state-changing tool.

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%, so both 'session' and 'agent_id' are already fully documented, including the default-to-primary-session behavior. The description adds no additional meaning about how session or agent binding affects which keepalive is stopped.

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 and resource: 'Stop the background keepalive task'. This is clearly the inverse of the sibling sap_keepalive_start, so an agent can distinguish the pair without opening schemas, though no other sibling is explicitly named.

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 when-to-use guidance, no prerequisites, and no mention of the natural alternative (letting the keepalive run, or restarting it with sap_keepalive_start). The pairing with a start tool is only inferable from the shared prefix.

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