Skip to main content
Glama

Sap Read Status Bar

sap_read_status_bar

Read the current message from SAP's status bar and return a language-independent message ID plus parameters, so agents can detect errors or confirmations after an action.

Instructions

Read the current message from SAP's status bar

Also returns message_id / message_number (desktop only), which identify the message independently of the logon language, plus message_parameters (its &1-&4 runtime values, which may themselves be translated).

Session parameter:

  • session=None (default): Uses primary session ("s1")

  • session="s2": Targets specific session (for parallel agents)

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_read_status_bar"
  }
}

Input Schema

NameRequiredDescriptionDefault
sessionNoSession ID (e.g., "s1", "s2"). None uses primary session.
agent_idNoAgent identifier for binding check. Optional.

Output Schema

NameRequiredDescriptionDefault
typeYesMessage type: 'S' (success), 'E' (error), 'W' (warning), 'I' (info), or 'none'
errorNoError message if success=False
popupNoPresent when a popup dialog is active on screen
messageNoStatus bar text
successNoWhether the operation succeeded
message_idNoT100 message class (e.g. 'DS'), padding stripped; None when the bar is empty or the SAP GUI does not expose it. Together with message_number it identifies a message independently of the logon language, so check these instead of the text. Desktop backend only; the WebGUI backend leaves it None.
active_windowNoWhich window was operated on (e.g., 'wnd[0]', 'wnd[1]'). If 'wnd[1]' or higher, a modal dialog is open.
message_numberNoT100 message number, zero-padded (e.g. '017'); None when the bar is empty or the SAP GUI does not expose it. Language-independent. Desktop backend only; the WebGUI backend leaves it None.
message_parametersNoMessage variables &1-&4 (index 0 is &1), trailing empty values removed; [] when the bar is empty. These are runtime values and may themselves be translated text, so they are not a language-independent identity. Desktop backend only; the WebGUI backend leaves it empty.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.8/5.0
Behavior4/5

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

With no annotations, the description carries behavioral context and usefully discloses that message_id/message_number are desktop-only and language-independent, and that message_parameters may be translated. It still omits permissions, error behavior, and whether reading affects the status message, so it is not fully complete.

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?

The purpose is front-loaded in the first sentence, followed by return-value context and session guidance. The structure is clear, but the session section partly repeats schema descriptions and could be slightly tighter.

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 simple read tool with two optional parameters and an output schema, the description is largely complete: it covers purpose, key return semantics, and session targeting. Remaining gaps are mainly guidance about alternatives and edge-case behavior.

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 coverage is 100%, so the schema already documents both parameters. The description adds meaning beyond the schema by explaining that session='s2' targets a specific session for parallel agents, though it leaves agent_id entirely to the schema.

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 states a specific verb and resource: 'Read the current message from SAP's status bar.' It is immediately clear what the tool does, though it does not explicitly distinguish itself from nearby read tools such as sap_get_screen_text or sap_session_status.

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?

Usage guidance is limited to session targeting, including that session='s2' is for parallel agents. It does not explain when to choose this tool over alternatives or when not to use it, so the guidance is implied rather than explicit.

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