Skip to main content
Glama

Sap Get Screen Info

sap_get_screen_info

Retrieves technical details of the current SAP screen, including session context, to help agents inspect UI state before navigating or entering data.

Instructions

Get technical information about the current SAP screen

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

Input Schema

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

Output Schema

NameRequiredDescriptionDefault
urlYesCurrent URL
userNoLogged-in SAP user
errorNoError message if success=False
popupNoPresent when a popup dialog is active on screen
titleYesWindow/page title
clientNoSAP client number (e.g., '100')
dynproNoScreen number
programNoABAP program name
successNoWhether the operation succeeded
system_nameNoSAP system ID (e.g., 'DEV', 'PRD')
transactionNoCurrent transaction code
active_windowNoWhich window was operated on (e.g., 'wnd[0]', 'wnd[1]'). If 'wnd[1]' or higher, a modal dialog is open.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.4/5.0
Behavior3/5

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

No annotations are supplied, so the description carries the full burden. 'Get' implies a non-mutating read, but the description says nothing about whether it changes screen state, requires an active connection, or costs a round trip. It does add one useful behavioral detail — that session selection supports parallel agents — but the prerequisite of an existing SAP session is never stated.

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?

Short and front-loaded, with the core purpose in the first sentence. The bolded header and bullet list are slightly heavy formatting for a single trivial parameter, but no sentence is wasted.

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

Completeness3/5

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

An output schema exists, so return values need not be described. What is missing is the operational context an agent needs before calling: that it must be attached to a live SAP session, and how this differs from the adjacent screen-reading tools. Adequate but with clear gaps.

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 the baseline is 3. The description does add a rationale beyond the schema by explaining that targeting 's2' is for parallel agents, but it omits the second parameter (agent_id) entirely, so it only partially compensates.

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?

Specific verb and resource: 'Get technical information about the current SAP screen'. An agent can tell this is a metadata/read tool rather than a text or field extractor. However, 'technical information' is left vague (screen program, transaction code, screen number?) and no sibling such as sap_get_screen_text or sap_get_form_fields is named, so the boundary between these tools is left to inference.

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?

The second block is parameter guidance (session targeting), not usage guidance. There is no statement of when to call this versus sap_get_screen_text, sap_get_form_fields, or sap_get_capabilities, and no prerequisites (e.g., must already be logged in to a session) are given. Usage is only implied by the tool name.

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