Skip to main content
Glama

Server Configuration

Describes the environment variables required to run the server.

NameRequiredDescriptionDefault
CDP_URLNoChrome DevTools Protocol URL. Required when `BROWSER_MODE=connect`. WebGUI only.http://localhost:9222
SAP_URLNoOverride WebGUI URL (default: derived from `host` in systems.json).
LOG_LEVELNo`DEBUG`, `INFO`, `WARNING`, or `ERROR`.INFO
GITHUB_PATNoGitHub PAT for `log_feedback` issues and abapGit auth.
LOG_FORMATNoSet to `json` for JSON log output.
OUTPUT_DIRNoDirectory that `output_file` tool arguments (e.g. `sap_se16_query`) are sandboxed to. Set this when the server's cwd isn't your project directory.
ABAPGIT_PATNoSeparate PAT for abapGit (overrides `GITHUB_PAT` if set).
CHROME_PATHNoExplicit path to Chrome binary. If empty, auto-detected. WebGUI only.
GITHUB_REPONoRepository for feedback issues.Hochfrequenz/sapwebgui.mcp
GITHUB_USERNoGitHub username for abapGit (falls back to `x-access-token`).
BACKEND_TYPENoBackend to use: `webgui` (browser automation) or `desktop` (SAP GUI COM, Windows only).webgui
BROWSER_MODENo`connect` (existing Chrome) or `launch` (Playwright). WebGUI only.connect
BROWSER_TYPENo`chromium`, `firefox`, or `webkit`. WebGUI only.chromium
SCRIPT_ROOTSNoAllowed root directories for `sap_run_script`'s `script_path` parameter, separated by `os.pathsep` (`;` on Windows, `:` on macOS/Linux). Roots must be absolute paths. Desktop backend only.
PAPERTRAIL_HOSTNoPapertrail syslog host (empty to disable).
PAPERTRAIL_PORTNoPapertrail syslog port.0
SAP_CONFIG_FILENoPath to systems.json. Defaults to %USERPROFILE%\.config\sap-mcp\systems.json on Windows or ~/.config/sap-mcp/systems.json on macOS/Linux.
BROWSER_HEADLESSNoRun browser in headless mode. WebGUI only.false
COM_MIN_INTERVAL_MSNoMinimum ms between COM calls (prevents overload). Desktop only.100
CHROME_USER_DATA_DIRNoUser data directory for auto-launched Chrome. WebGUI only.<tempdir>/chrome-debug

Instructions

Guidance the server publishes about itself, which clients place ahead of the tool catalog so the model reads it before choosing anything.

WHEN TO USE THIS SERVER vs sap-adt MCP: If sap-adt (SAP ADT MCP) tools are available, prefer them for:

  • Reading/writing ABAP source code (get_source, patch_source, set_source_from_file)

  • Creating ABAP objects (create_object: PROG, CLAS, INTF, FUGR, MSAG, DDLS, TABL, DTEL, DOMA)

  • Transport management (get_transport_requests, create_transport, release_transport on S4)

  • Activation, syntax checks, ATC checks, unit tests

  • Code completion, pretty printing, refactoring

  • Debugging (breakpoints, stepping, variable inspection)

  • DDIC lookups (get_object_info, get_ddic_info)

Use THIS server (sap-desktop/sap-webgui) for:

  • Customizing transactions (SPRO, SM30, SM34)

  • Transport release on ECC (SE09 — ADT release may silently fail on ECC)

  • Complex GUI interactions (popups, drag-and-drop, tree navigation)

  • Transactions without ADT endpoints (SE21 on ECC, SM37, SLG1, ST22, SQVI)

  • Visual verification of screen state

  • abapGit operations via SAP GUI (SE80 > abapGit)

TRANSACTION SELECTION:

  • Prefer dedicated transactions (SE38, SE24, SE37, SE21) over SE80

  • SE80 has a complex split-screen layout that tools struggle to parse

SAP Web GUI automation server. Controls SAP through a Chrome browser with remote debugging enabled.

BROWSER SETUP: Chrome is auto-launched with debugging flags when not already running. If Chrome cannot be found automatically, set CHROME_PATH in the .env file. The user may also pre-launch Chrome manually with --remote-debugging-port=9222.

IMPORTANT: Do NOT attempt to install Chrome or any browser.

PREREQUISITES:

  • Chrome installed (auto-detected, or CHROME_PATH set in .env)

  • VPN connected (if SAP system is on internal network)

  • CDP proxy running (for Docker setups)

IF CONNECTION FAILS: Do NOT try to install browsers. Instead, ask the user to verify:

  1. "Is Chrome installed?" (set CHROME_PATH in .env if not auto-detected)

  2. "Is your VPN connected?" (for internal SAP systems)

  3. "Is the CDP proxy running?" (docker compose up -d)

COMMON ERROR CAUSES:

  • "Chrome not found" / "Chrome konnte nicht ... gefunden werden": Set CHROME_PATH in .env

  • "SAP URL not reachable": VPN not connected

  • Login fails: Check user/password/client in ~/.config/sap-mcp/systems.json

WORKFLOW:

  1. Call sap_login first to open SAP and authenticate

  2. Use sap_transaction to navigate to transactions (e.g., VA01, SE16, BP)

  3. Use browser_snapshot to see current screen state

  4. Use browser_fill/browser_click for interactions

  5. Prefer SAP-specific tools (sap_fill_form, sap_click_button) over browser_* tools when available

ESCAPE HATCHES (when SAP-specific tools are insufficient):

  • browser_snapshot: See current DOM/ARIA tree

  • browser_evaluate: Execute arbitrary JavaScript

  • browser_click / browser_fill: Interact with elements by CSS selector

  • browser_navigate: Navigate to a URL (e.g., SAP Help Portal)

Capabilities

Features and capabilities supported by this server

Protocol revision2025-11-25

CapabilityDetails
tools
{
  "listChanged": true
}
logging
{}
prompts
{
  "listChanged": true
}
resources
{
  "subscribe": false,
  "listChanged": true
}

Tools

Functions exposed to the LLM to take actions

NameDescription
sap_keepalive_startB

Start a background task that keeps the SAP session alive

sap_keepalive_stopC

Stop the background keepalive task

sap_loginA

Log into SAP. On WebGUI: requires Chrome with --remote-debugging-port=9222 and VPN (if internal SAP). On Desktop: opens a NEW parallel session each call — re-login does NOT replace prior logins. You can be logged into the same SAP Logon entry as multiple distinct (client, user) tuples concurrently. The returned LoginResult.session_id is the registry ID ('s1', 's2', ...) you pass on subsequent tool calls to address THIS specific login. Concurrency note: sessions on one connection share one single-threaded COM engine; parallel scripting loops on that connection run sequentially (no speedup). For bulk work on one connection, prefer one large loop in a single script. Parallelism helps only across separate connections/systems. Use sap_session_list to see all currently active sessions. Credentials are read from ~/.config/sap-mcp/systems.json. Use system_key (dictionary key from systems.json) to select a non-default system. Call sap_list_connections first to see available system keys.

sap_list_connectionsA

List available SAP systems. Returns two sections: 'configured_systems' from systems.json (pass the 'key' field as system_key to sap_login), and 'connections' from SAP Logon (SAPUILandscape.xml, Desktop only). IMPORTANT: pass a configured_systems 'key' as system_key to sap_login, NOT a SAP Logon entry name. If configured_systems is empty, check config_error.

sap_transactionA

Enter and execute an SAP transaction code. IMPORTANT: Do NOT use this for SE11, SE16, SE24, SE37, or SE93; use sap_se11_lookup, sap_se16_query, sap_se24_lookup, sap_se37_lookup, or sap_se93_lookup.

Multi-Session Support (for parallel agents): new_window=True opens a new SAP session and returns session_id/session_count; pass session on later calls to target it.

Concurrency note: SAP GUI COM scripting is single-threaded per connection. Running parallel scripting loops across new_window=True sessions of the same connection is serialized (no speedup). For bulk work on one connection, use one script with a larger loop; parallelize only across separate connections.

⚠️ CRITICAL: Always close sessions you opened! Close new_window=True sessions with sap_session_close to avoid hitting SAP session limits. Use sap_session_list to review open IDs.

sap_session_statusC

Check the current SAP session status

sap_get_capabilitiesA

RECOMMENDED: Call at the start of every SAP session. Returns all available tools with their full descriptions. Reading this first helps you understand what capabilities are available, work faster, and avoid common mistakes like clicking buttons when keyboard shortcuts are available.

sap_press_keyA

Send a keyboard shortcut to SAP

Note on 'Escape': on the desktop backend it sends SAP VKey 12 (F12 / Cancel), not the Windows Esc key; its meaning is screen dependent (some editor screens open an 'Exit editor' dialog). On the WebGUI backend the key is passed to the browser as a normal key press (no VKey mapping). To dismiss a popup use sap_close_popup.

Session parameter:

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

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

sap_get_screen_textA

Get all readable text from the current SAP screen. Use include_dropdown_options=True to also fetch available options for dropdown fields.

Session parameter:

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

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

sap_get_form_fieldsA

Discover fillable form fields on the current SAP screen (or active popup dialog). Returns field IDs, labels, types (text/dropdown/checkbox/radio), and current values. Automatically targets the active window — if a popup is open, shows popup fields. Use include_dropdown_options=True to also fetch available options for dropdown fields.

Session parameter:

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

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

sap_read_tableA

Read data from an ALV grid or table on the current screen

Session parameter:

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

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

sap_click_table_cellA

Click a cell in an ALV grid table. Automatically targets the correct clickable element (hotspot span vs TD). Use after sap_read_table to navigate to detail views.

Session parameter:

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

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

sap_read_status_barA

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)

sap_get_screen_infoB

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)

sap_lookup_fieldsA

Look up known field CSS selectors for an SAP transaction (WebGUI only). Returns pre-discovered selectors from a static registry. On Desktop, use sap_discover_fields instead — it discovers fields dynamically.

sap_discover_fieldsA

Discover input fields on the current SAP screen (or active popup dialog). Returns fields with label, name, value, and a selector/ID for targeting the field. Automatically targets the active window — if a popup is open, shows popup fields. Use the label with sap_fill_form or sap_set_field to fill fields (works on both backends). The 'selector' field is a CSS selector on WebGUI or a SAP GUI element ID on Desktop. For buttons, use sap_discover_buttons instead.

Session parameter:

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

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

sap_discover_buttonsA

Discover clickable buttons on the current SAP screen. Returns buttons with label, selector/ID, shortcut (e.g. F3), and accesskey. Prefer keyboard shortcuts (sap_press_key) when available — they're faster and more reliable. To press a discovered button: use browser_click(selector) on WebGUI, or sap_com_evaluate(element_id, action='call', method='Press') on Desktop. For input fields use sap_discover_fields instead.

Session parameter:

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

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

sap_get_shortcutsA

Discover keyboard shortcuts available on the current SAP screen. Use BEFORE clicking buttons - shortcuts like F5, Ctrl+S are faster and more reliable. Returns action text and key combination for each available shortcut.

Session parameter:

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

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

sap_close_popupA

Close an active popup dialog by clicking a button. Use when active_window shows 'wnd[1]' or higher and you want to dismiss the dialog. Note: Not all popups need closing - if the popup is a form you need to fill, use sap_discover_fields and sap_fill_form instead (they automatically target the active window). Specify button by label ('Ja', 'Nein') or accesskey ('J', 'N'), or use close=True to click the X button if available.

Session parameter:

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

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

sap_fill_formA

Fill multiple SAP form fields in a single call. Use this when filling 2+ fields on the SAME screen without UI navigation between them.

Keys can be:

  • Visible label text (e.g., 'First Name', 'Straße') — works on both backends

  • CSS selectors starting with '#' (WebGUI, e.g., '#M0:46:1:1::0:21')

  • SAP GUI element names (Desktop, e.g., 'BUT000-NAME_LAST')

When to use:

  • Filling a form with multiple input fields

  • All fields visible on current screen

  • No button clicks or navigation needed between fields

When NOT to use:

  • Single field only (use sap_set_field)

  • Fields on different screens/tabs

  • Need to click buttons between fills

Session parameter:

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

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

Example payload: {"fields": {"Vorname": "Mario", "Nachname": "Rossi"}, "strict": false}

sap_set_fieldA

Set a single SAP form field by label, CSS selector, or element name. Finds the field dynamically and fills it with the given value.

The label parameter can be:

  • Visible label text (e.g., 'Last Name', 'Nachname') — works on both backends

  • CSS selector (WebGUI, e.g., '#M0:46:1:1::0:21')

  • SAP GUI element name (Desktop, e.g., 'BUT000-NAME_LAST')

This is simpler than sap_fill_form for single fields.

Session parameter:

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

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

sap_set_checkboxA

Set a SAP checkbox to checked or unchecked by its label text.

Use sap_get_form_fields first to see available checkboxes and their current state.

Args:

  • label: Checkbox label text (e.g., 'Workbench-Aufträge', 'Freigegeben')

  • checked: True to check, False to uncheck

Only label lookup is supported. If the label is ambiguous or not found: on the desktop backend use sap_com_evaluate or sap_run_script and set .selected = True/False on the element by id (both are desktop-only); on the WebGUI backend use browser_evaluate.

Session parameter:

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

  • session="s2": Targets specific session

sap_set_radio_buttonA

Select a SAP radio button by its label text.

Use sap_get_form_fields first to see available radio buttons and which is selected.

Args:

  • label: Radio button label text (e.g., 'Datenbanktabelle', 'Database table')

Session parameter:

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

  • session="s2": Targets specific session

sap_click_buttonA

Click a button on the current SAP screen by its label text.

Use sap_discover_buttons first to see available buttons. Prefer sap_press_key with keyboard shortcuts (F-keys, Ctrl+*) when available — they are faster and more reliable. Use this tool when no shortcut exists.

Args:

  • label: Button label text (e.g., 'Execute', 'Save', 'Ausführen')

Session parameter:

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

  • session="s2": Targets specific session

sap_select_tabA

Select a tab on the current SAP screen by its label text.

Use sap_get_screen_text to see available tab labels on the current screen.

Args:

  • label: Tab label text (e.g., 'Address', 'Details', 'Allgemeine Daten')

Session parameter:

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

  • session="s2": Targets specific session

sap_select_dropdownA

Select a value from a dropdown (combobox) field on the current SAP screen.

Use sap_get_form_fields(include_dropdown_options=True) first to see available dropdown fields and their options.

Unlike sap_set_field which auto-detects field type, this tool is specifically for dropdown selection and returns available_options on failure.

Args:

  • label: Dropdown field label text (e.g., 'Country', 'Language', 'Buchungskreis')

  • value: Exact option text to select from the dropdown

Session parameter:

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

  • session="s2": Targets specific session

sap_screenshotA

Take a screenshot of the current SAP screen.

Returns a PNG screenshot as an image. Works on both WebGUI and Desktop backends. ⚠️ Screenshots consume significant context tokens. Prefer sap_get_screen_text or sap_get_form_fields for reading screen content. Use screenshots only for visual debugging or when the user explicitly requests one.

Session parameter:

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

  • session="s2": Targets specific session

sap_session_listA

List all active SAP sessions.

Returns session IDs, current transaction, screen title, client, user, and system_name for each. Use this to see what sessions exist before targeting one.

The first sap_login() registers "s1". Additional sessions come from:

  • repeated sap_login() calls (parallel multi-mandant — each new login adds a session alongside the existing ones, not replacing them — see #671)

  • sap_transaction(tcode, new_window=True) (a /o sub-session of an existing connection, sharing its login)

Desktop: when another call has been running on the connection's single COM engine for a while, the result carries a com_engine block saying which connection is busy and since when. That running call is why other tool calls on the same connection hang — wait for it instead of retrying.

sap_session_closeA

Close a SAP session.

Closes the underlying SAP GUI session/tab and removes it from the registry. Any session ID can be closed, including "s1". With the parallel-multi-mandant contract (#671), the registry can hold multiple concurrent logins and you may legitimately want to close any of them — including the lowest-numbered one. If you close the only remaining session, the next tool call will fail with a clear "no session" error and you should call sap_login() again.

Sessions with origin "attached" (a window the user already had open) are never closed by this server: the call is refused and points at sap_session_detach.

Args: session_id: Session to close (e.g. "s1", "s2", ...)

sap_session_detachA

Stop using a session WITHOUT closing it (desktop backend only).

Removes the session from the registry, drops its agent binding and stops watching its connection. No SAP GUI call is made: the SAP window stays open. This is the only way to drop an "attached" session (a window the user already had open, which sap_session_close refuses to close); it also works on sessions this server opened. The WebGUI backend has no detach; use sap_session_close there.

Args: session_id: Session to detach (e.g. "s2")

sap_session_bindA

Claim exclusive ownership of a SAP session for the calling agent. Strict by default (#643): if the session is already bound to a different agent, the call fails — pick a different session via sap_session_list, or retry with force=true to take over (use only for crash recovery, otherwise prefer leaving the existing binding intact). Re-binding the same agent is a no-op success.

sap_session_releaseA

Release agent binding from a session. Use when an agent finishes work and wants to free the session for other agents or general use.

sap_session_reset_to_primaryA

Bulk-close every SAP session except the primary one (s1). Use this when parallel agents have left orphaned/extra windows and you want to return to a known-clean state with only s1 open. Reconciles the registry first (drops any sessions that died externally), then closes the rest. WARNING: if you call this from a non-primary session, your own session will be closed and you will appear in killed_agents — your next tool call will fail until you rebind to s1 (or another surviving session) via sap_session_bind. See issue #637 for the parallel-agent drift scenario this addresses.

sap_se11_lookupA

Look up table or structure metadata from SE11 (ABAP Dictionary). If sap-adt is available, prefer its get_table_fields or get_object_info tools. USE THIS instead of sap_transaction('SE11') - faster and returns structured data. Returns field names, data types, lengths, and descriptions. Supports single name or list of names. Always queries live from SAP. Use object_type='table' for database tables, 'structure' for data structures. For large requests (>10 objects), provide output_file to write results to JSON file instead of returning inline (avoids context overflow).

sap_se16_queryA

Query SAP table data via SE16N (Data Browser). If sap-adt is available, prefer its run_query tool for simple queries. USE THIS for complex queries with dynamic filtering or when ADT is unavailable.

Filters: If a filter cannot be applied (e.g. the field is unknown or not offered by SE16N), the call fails before running the query; the error lists the SE16N selection fields when they could be read. On the WebGUI backend a filter goes into the row whose technical name matches, and only the first ~30 rows of the selection grid are rendered, so a field further down a wide table cannot be filtered (the error says so).

Performance: ~7 rows/second due to pagination.

  • 100 rows: ~14 seconds

  • 500 rows: ~1.5 minutes

  • 1000 rows: ~2.5 minutes

  • 5000 rows: ~12 minutes

For large results, use output_file to write JSON to disk and receive a summary.

sap_se24_lookupA

Look up class/interface metadata from SE24 (Class Builder). If sap-adt is available, prefer its get_source/get_class_definition tools. USE THIS instead of sap_transaction('SE24') - faster and returns structured data. Returns class structure including methods with parameters, attributes, and implemented interfaces. Supports single class or list of classes. Each method includes: name, visibility, parameters, exceptions, and description.

sap_se37_lookupA

Look up function module metadata from SE37 (Function Builder). If sap-adt is available, prefer its get_source tool for reading FM source code. USE THIS instead of sap_transaction('SE37') - faster and returns structured data. Returns function module signature including import/export/changing/tables parameters and exceptions. Supports single FM or list of FMs. Each parameter includes: name, typing (LIKE/TYPE), reference type, default value, optional flag, and description.

sap_se09_lookupA

Look up transport requests from SE09 (Transport Organizer). If sap-adt is available, prefer its get_transport_requests for listing transports. USE THIS for transport release on ECC (ADT release silently fails on ECC) or when ADT is unavailable. Returns transport requests with owner, description, status, type, and target system. By default shows only modifiable requests for the current user. Supports filtering by username, request type (workbench/customizing), and status (modifiable/released/all).

sap_se93_lookupA

Look up transaction metadata from SE93 (Transaction Maintenance). USE THIS instead of sap_transaction('SE93') - faster and returns structured data. Returns transaction description, program, screen/selection info, and GUI capabilities. Supports single tcode or list of tcodes. Currently supports 'dialog' and 'report' transaction types.

sap_slg1_lookupA

Search and read SAP application logs from SLG1. USE THIS instead of sap_transaction('SLG1') - faster and returns structured data. Returns log entries with metadata (date, time, user, object, subobject, external ID, message count, log number). Best used when the log object is known (e.g., /SDF/CALM for Cloud ALM, /SDF/AIMAX for AI). Use '*' as object to search all logs. Requires at minimum the 'object' parameter. Returns up to 50 logs.

sap_sm30_lookupA

Look up SAP table maintenance view entries from SM30 (read-only display mode). USE THIS instead of sap_transaction('SM30') - faster and returns structured data. Returns entries from the maintenance view with dynamically-parsed columns. Supports any flat table view (e.g., V_T005 for countries, custom Z* views). Non-flat views (SM34/cluster/hierarchical) are detected and reported as unsupported. Note: only the first page of rows is returned (typically ~12 rows); views with more entries will report the total row_count from the view header.

sap_sm37_lookupA

List background jobs from SM37 (Job Overview). USE THIS instead of sap_transaction('SM37') - faster and returns structured data.

Filters: job name (wildcards like BILLING), username, status (scheduled/released/ready/active/finished/canceled), date range.

Note: status=None keeps SAP defaults (all checked except 'Scheduled'). Pass status=['scheduled'] explicitly to include only scheduled jobs.

When include_log=True and exactly one job matches, the job log is included.

Returns job list with name, status, start time, duration, user, and SAP client (mandant).

sap_spro_searchA

Search the SAP Implementation Guide (IMG) for customizing activities by keyword. USE THIS to find where specific SAP configuration is maintained (e.g., 'country', 'pricing', 'tax'). Returns matching IMG activities with their parent node and area. The WebGUI search covers all IMG text content; the desktop search only the top two levels of the IMG tree (the result's scope_note says so). Results can then be used to navigate to specific configuration via SM30 or other transactions.

Note: First search in a language may be slow (30-60s) while the text index is built. Subsequent searches are faster.

sap_st22_lookupA

Look up ABAP short dumps (runtime errors) from ST22. If sap-adt is available, prefer its list_short_dumps/get_short_dump_details tools. USE THIS instead of sap_transaction('ST22') - faster and returns structured data. Two-step workflow: call once without dump_index to list dumps, then call again with dump_index=N to read a specific dump's detail. By default lists today's dumps. Use date parameter for other dates.

search_transactionsA

Search for SAP transactions by description or transaction code. Use this when the user asks things like:

  • 'How do I create a sales order?'

  • 'What transaction displays customer master?'

  • 'Show me material management transactions'

  • 'What is VA01?'

Returns matching transactions with relevance scores.

search_tablesA

Search for SAP tables by name, description, or field. Use this when the user asks things like:

  • 'What table stores material master data?'

  • 'Which table has the MATNR field?'

  • 'Find tables related to purchase orders'

Returns matching tables with relevance scores.

search_function_modulesA

Search for SAP function modules by name, description, or parameter. Use this when the user asks things like:

  • 'What FM reads installation data?'

  • 'Find function modules for Anlage'

  • 'Which FMs work with business partners?'

  • 'Show me FKK function modules'

The catalog contains IS-U and FI-CA function modules. Returns matching FMs with relevance scores.

search_classesA

Search for SAP classes by name or description. Use this when the user asks things like:

  • 'What class handles installations?'

  • 'Find classes for IS-U contracts'

  • 'Which class works with devices?'

  • 'Show me FI-CA classes'

The catalog contains IS-U and FI-CA classes. Returns matching classes with relevance scores.

sap_se24_editA

Edit an existing class method in SE24 (Class Builder). If sap-adt is available, prefer its patch_source or set_source_from_file tools — faster, no GUI needed.

Replaces the method's source code, runs syntax check (Ctrl+F2), and activates (Ctrl+F3). Auto-reverts if check or activation fails.

Important: Only for EXISTING classes and methods. To create new ones, use abapGit.

Workflow: Read current class with sap_se24_lookup first to see methods, then call this tool with the full new method source.

sap_se38_editA

Edit an existing ABAP report in SE38. If sap-adt is available, prefer its patch_source or set_source_from_file tools — faster, no GUI needed.

Replaces the entire source code, runs syntax check (Ctrl+F2), and activates (Ctrl+F3). Auto-reverts if check or activation fails.

Important: Only for EXISTING reports. To create new reports, use abapGit.

Workflow: Read current source with sap_read_se38_source first, modify it, then call this tool with the full new source.

sap_breakpoint_setA

HIGHLY DANGEROUS — DO NOT CALL unless a human user has explicitly asked for a breakpoint to be set. Live-verified (issue #791): once the breakpoint fires, the SAP session stops and SAP GUI opens the ABAP debugger. The call that triggered it and every later call on that session fail after a few seconds with an error naming the debugger, as can slow calls on other sessions of the same SAP connection; sessions of other connections are not affected. The session works again once a human continues or exits the debugger in SAP GUI.

Set an external ABAP breakpoint on a specific line of a program, class method, or function module. Desktop backend only — WebGUI does not support external breakpoints.

Provide either line_number (1-indexed SAP display line) or match_pattern (substring or regex matched against source lines).

SAP toggles breakpoints: if the line already has a breakpoint, VKey 45 deletes it. This tool only sets the breakpoint — it does not run anything.

IMPORTANT — before calling this tool, ask the human operator for explicit permission and explain the consequences: there is NO tool to step, continue, or read variables in the resulting debugger. If the breakpoint later fires during a GUI run, SAP GUI opens a modal interactive ABAP debugger that only a human can drive — the agent cannot see or control it, and it may fire once per row/iteration if the code path repeats. The halted session is unusable for the agent until then, as described above. Only proceed once the human has confirmed they intend to sit at the SAP GUI and step through the debugger themselves; do not use this to silently 'verify a code path is reached' from an unattended flow.

sap_breakpoint_deleteA

Delete an external ABAP breakpoint on a specific line of a program, class method, or function module. Desktop backend only.

Provide either line_number (1-indexed SAP display line) or match_pattern (substring or regex matched against source lines).

If the line has no breakpoint, SAP sets one. This tool detects that and re-applies to undo it, then reports action='was_not_set'.

Note: this only removes the breakpoint from the source editor. It does NOT step or continue a debugger that is currently stopped and showing a modal dialog — there is no tool for that; only a human at the SAP GUI can dismiss it.

sap_breakpoint_listA

List all external ABAP breakpoints for the current user on a program, class method, or function module. Desktop backend only.

Opens 'Hilfsmittel > Breakpoints > Anzeigen...' dialog in the source editor, reads the grid, and returns matching breakpoints.

Note: if this session is currently stopped at a breakpoint, this tool fails with an error naming the ABAP debugger instead of opening the dialog — continue or exit the debugger in SAP GUI first.

log_intentA

MANDATORY: Log intent when using SAP. You MUST call this at the start of every SAP task and before any SAP write operation. Required for compliance and accountability. WHEN TO CALL: (1) ALWAYS at the start of every SAP-related user request, (2) ALWAYS before any SAP write operation (create, update, delete, post), (3) At milestones during multi-step workflows (e.g., 'Order 3 of 10'), (4) Before running transactions that modify data. Args: intent = high-level description (e.g., 'User requested to create sales order'), context = optional dict (e.g., {'tcode': 'VA01', 'customer': '12345'}).

log_feedbackA

Log technical feedback about tool usage patterns, friction points, or optimization opportunities. ENCOURAGED whenever you notice something that could improve tooling. If GITHUB_PAT configured, auto-posts as GitHub issue. BE DETAILED: include transaction code, steps to reproduce, tool names, selectors, timing observations, what you tried, error messages. TAGS: 'tool-combination' (tools always used together), 'repetition' (same tool repeated), 'selector' (hard to find), 'timing' (slow/timeout), 'workflow' (could be simplified), 'missing-tool', 'error-handling', 'deadlock' (got stuck), 'problem' (blocked progress). Use markdown formatting: backticks for code, bold for emphasis.

sap_abapgit_list_reposA

List registered abapGit repositories with their metadata. Returns repo names, Git URLs, packages, branches, last pull timestamps and (when the report provides it) the repository key, plus total_count and matched_count. Use name/package/url/key to filter instead of listing everything (a system can have hundreds of repositories): name, package and url are case-insensitive substrings, or globs when they contain * or ?; key is an exact match, digits, zero-padded to 12; all given filters must match. compact=True returns only name, package and key. Use this to discover the correct repo name before calling sap_abapgit_pull.

sap_abapgit_pullA

Pull changes from a remote git repository using abapGit API. WARNING: overwrites local ABAP objects. Select the repository by repo (name/URL) or by key (from sap_abapgit_list_repos), not both. If a transport is required the error says so: retry with trkorr=... If 'status unknown', the pull may have run: check the last pull time before retrying. Optional branch switches the repository to that branch persistently (kept only if the pull succeeds) and clears a commit pin.

sap_read_se38_sourceA

Read ABAP report source code from SE38. If sap-adt is available, prefer its get_source tool. Navigates to SE38, enters the program name, and displays the source code. Useful for verifying abapGit pull operations.

browser_snapshotA

Get accessibility tree snapshot of the current page. Returns a YAML representation of the ARIA tree - useful for understanding page structure when other tools fail. Args: selector = optional CSS selector to scope the snapshot.

Session parameter:

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

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

browser_screenshotA

⚠️ WRONG TOOL — use browser_snapshot instead. browser_snapshot returns a compact text-based accessibility tree that is sufficient for 95% of use cases.

ONLY use browser_screenshot when:

  1. The user EXPLICITLY asks for a screenshot

  2. You need to verify visual rendering/layout issues that cannot be diagnosed from the accessibility tree

This tool returns a large image that rapidly fills up conversation context and degrades performance.

Args: full_page = capture entire scrollable page, selector = optional CSS selector to capture specific element.

Session parameter:

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

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

browser_clickB

Click an element by CSS selector. BEFORE clicking buttons, use sap_get_shortcuts to check if a keyboard shortcut is available - shortcuts are faster and more reliable than clicks.

Session parameter:

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

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

browser_fillA

Fill a single input field by CSS selector. For filling multiple fields on the same screen, use sap_fill_form instead - it fills all fields in a single call, which is much faster.

Session parameter:

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

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

browser_keyboardA

Send keyboard input (key press or text typing). Important: For SAP shortcuts like Ctrl+S, prefer sap_press_key which auto-reads the status bar! For filling multiple form fields, use sap_fill_form - much faster. Args: key = key to press (e.g., 'Enter', 'Tab', 'F3'), text = text to type character by character.

Session parameter:

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

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

browser_navigateA

Navigate to a URL. For SAP login, use sap_login instead - it handles credentials and session setup.

Session parameter:

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

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

browser_evaluateA

Execute JavaScript in the browser. Use with caution - this has full access to the page context. Prefer SAP-specific tools when available. Returns: JSON-serialized result.

Session parameter:

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

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

browser_waitA

Wait for an element to reach a specific state. IMPORTANT: Only useful with a selector - calling without a selector is pointless because MCP round-trip time already provides natural delays. Good uses: wait for element to appear (state='visible') or loading spinner to disappear (state='hidden'). Args: selector = CSS selector to wait for, timeout = max wait in ms, state = 'visible'/'hidden'/'attached'/'detached'.

Session parameter:

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

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

browser_get_htmlA

Get HTML content of an element or the full page. For large HTML (>50KB), returns a File to avoid context bloat. Prefer sap_get_screen_text or sap_get_form_fields for structured SAP data. Args: selector = CSS selector (None for full page), outer = include element itself (outerHTML) or just children (innerHTML).

Session parameter:

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

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

browser_select_optionA

Select an option from a dropdown/select element. For SAP dropdowns, prefer sap_fill_form or sap_set_field which handle SAP-specific dropdown behavior. Args: selector = CSS selector for select element, value = option value to select, label = option text (alternative to value).

Session parameter:

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

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

sap_se37_editA

Edit an existing ABAP function module in SE37. If sap-adt is available, prefer its patch_source or set_source_from_file tools — faster, no GUI needed.

Replaces the entire source code, runs syntax check (Ctrl+F2), and activates (Ctrl+F3). Auto-reverts if check or activation fails.

Important: Only for EXISTING function modules. To create new ones, use abapGit.

Workflow: Read current source with sap_se37_lookup first (check the Quelltext/Source Code tab), modify it, then call this tool with the full new source.

sap_quick_reportA

Execute a transaction, fill the selection screen (fields, checkboxes, radio buttons), press Execute (F8), and return the result — all in one call.

Works with any SAP report/list transaction that has a selection screen (VA05, ME2M, MB51, FBL1N, Z-transactions, etc.).

After execution, you remain on the result screen. If the result is 'unknown', use individual tools to investigate further.

If you already know a transaction shows a popup after F8 (e.g., a variant selection dialog), pass post_f8_keys=['Enter'] to dismiss it automatically.

Do NOT use for:

  • SE16 (use sap_se16_query instead)

  • SM37 (use sap_sm37_lookup instead — has job log support)

  • Transactions without selection screens (e.g., BP, VA01)

  • SE11/SE24/SE37 (use dedicated lookup tools)

WebGUI-only. Returns an error on desktop backend.

chooseA

Present the user with a set of options to choose from.

Call this tool when you need the user to make a decision between discrete alternatives. Use it proactively — don't ask the user to type their choice in chat when you can present clean, clickable options instead.

The user will see a card with one button per option. When they click one, their choice appears as a message in the conversation (as if the user typed it), like:

"Which deployment strategy?" — I selected: Blue-green

IMPORTANT: After calling this tool, you MUST stop and wait for the user's response. Do not continue or take any other actions until you see the "I selected:" message.

Prompts

Interactive templates invoked by user choice

NameDescription
abapgit_workflowEnd-to-end ABAP development workflow using Claude Code with abapGit and this MCP server for testing
create_business_partnerCreate a business partner (person or organization) by composing generic SAP tools
explore_classLook up an ABAP class or interface with methods, attributes, and events using SE24
explore_function_moduleFind and understand a function module's signature using SE37
explore_tableLook up an SAP table structure with SE11 and optionally browse its data with SE16
se16_bulk_readStep-by-step guide for reading SAP table data using SE16 with filters

Resources

Contextual data attached and managed by the client

NameDescription
Prefab Renderer (choose)

TDQS

B3.3/5.0

Scored across 71 tools

Disambiguation2/5

Many tools are transaction- or object-specific, but the set contains clear overlaps: sap_get_form_fields vs sap_discover_fields, sap_set_field vs sap_select_dropdown/sap_fill_form, sap_screenshot vs browser_screenshot, and browser_* UI controls vs the SAP-native click/fill/keyboard tools. Descriptions give preferred-order hints, but boundaries remain fuzzy enough that an agent can easily choose the wrong discovery or interaction tool.

Naming Consistency3/5

All names use lower_snake_case, but there is no uniform verb_noun pattern: sap_get_screen_text and sap_set_field coexist with sap_transaction, sap_session_list, sap_keepalive_start, and sap_abapgit_list_repos. The sap_*, browser_*, search_*, log_*, and bare choose prefixes namespace some tools, but verb order and prefix conventions are mixed.

Tool Count1/5

At 71 tools this surface is extremely oversized for a single MCP server, even for the broad SAP GUI automation domain. It includes overlapping UI layers, auxiliary logging/choice tools, and multiple session-management utilities that would be better consolidated or split into focused servers.

Completeness4/5

Coverage is unusually broad: login/session management, screen/form interaction, transactions, table/query lookups, ABAP metadata and editing, transports, logs, jobs, dumps, IMG search, and abapGit. Gaps remain around ABAP debugger control and creating new ABAP objects, but those are explicitly scoped limitations rather than fatal omissions.

Maintenance

ActivityActive
ResponsivenessMixed handling