# Read-Only Tools - MCP ABAP ADT Server Generated from code in `src/handlers/**` (not from docs). - Level: Read-Only - Total tools: 67 ## Navigation - [Read-Only Group](#read-only-group) - [Behavior Definition](#read-only-behavior-definition) - [ReadBehaviorDefinition](#readbehaviordefinition-read-only-behavior-definition) - [Behavior Implementation](#read-only-behavior-implementation) - [ReadBehaviorImplementation](#readbehaviorimplementation-read-only-behavior-implementation) - [Class](#read-only-class) - [ReadClass](#readclass-read-only-class) - [Data Element](#read-only-data-element) - [ReadDataElement](#readdataelement-read-only-data-element) - [Domain](#read-only-domain) - [ReadDomain](#readdomain-read-only-domain) - [Enhancement](#read-only-enhancement) - [GetBadiImplementations](#getbadiimplementations-read-only-enhancement) - [GetEnhancementImpl](#getenhancementimpl-read-only-enhancement) - [GetEnhancements](#getenhancements-read-only-enhancement) - [GetEnhancementSpot](#getenhancementspot-read-only-enhancement) - [Function Group](#read-only-function-group) - [ReadFunctionGroup](#readfunctiongroup-read-only-function-group) - [Function Module](#read-only-function-module) - [ReadFunctionModule](#readfunctionmodule-read-only-function-module) - [Gui Status](#read-only-gui-status) - [GetGuiStatusList](#getguistatuslist-read-only-gui-status) - [ReadGuiStatus](#readguistatus-read-only-gui-status) - [Include](#read-only-include) - [GetInclude](#getinclude-read-only-include) - [GetIncludesList](#getincludeslist-read-only-include) - [Interface](#read-only-interface) - [ReadInterface](#readinterface-read-only-interface) - [Metadata Extension](#read-only-metadata-extension) - [ReadMetadataExtension](#readmetadataextension-read-only-metadata-extension) - [Package](#read-only-package) - [GetPackageContents](#getpackagecontents-read-only-package) - [ReadPackage](#readpackage-read-only-package) - [Program](#read-only-program) - [GetProgFullCode](#getprogfullcode-read-only-program) - [ReadProgram](#readprogram-read-only-program) - [Screen](#read-only-screen) - [GetScreensList](#getscreenslist-read-only-screen) - [ReadScreen](#readscreen-read-only-screen) - [Search](#read-only-search) - [GetObjectsByType](#getobjectsbytype-read-only-search) - [GetObjectsList](#getobjectslist-read-only-search) - [SearchObject](#searchobject-read-only-search) - [Service Binding](#read-only-service-binding) - [ReadServiceBinding](#readservicebinding-read-only-service-binding) - [Service Definition](#read-only-service-definition) - [ReadServiceDefinition](#readservicedefinition-read-only-service-definition) - [Structure](#read-only-structure) - [ReadStructure](#readstructure-read-only-structure) - [System](#read-only-system) - [DescribeByList](#describebylist-read-only-system) - [GetAbapAST](#getabapast-read-only-system) - [GetAbapSemanticAnalysis](#getabapsemanticanalysis-read-only-system) - [GetAbapSystemSymbols](#getabapsystemsymbols-read-only-system) - [GetAdtTypes](#getadttypes-read-only-system) - [GetInactiveObjects](#getinactiveobjects-read-only-system) - [GetJobUsage](#getjobusage-read-only-system) - [GetObjectInfo](#getobjectinfo-read-only-system) - [GetObjectNodeFromCache](#getobjectnodefromcache-read-only-system) - [GetObjectStructure](#getobjectstructure-read-only-system) - [GetSession](#getsession-read-only-system) - [GetSmartFormContent](#getsmartformcontent-read-only-system) - [GetSmartFormLayout](#getsmartformlayout-read-only-system) - [GetSqlQuery](#getsqlquery-read-only-system) - [GetTcodeUsage](#gettcodeusage-read-only-system) - [GetTransaction](#gettransaction-read-only-system) - [GetTypeInfo](#gettypeinfo-read-only-system) - [GetUsageSnippets](#getusagesnippets-read-only-system) - [GetWhereUsed](#getwhereused-read-only-system) - [ReloadProfile](#reloadprofile-read-only-system) - [RenderSmartForm](#rendersmartform-read-only-system) - [RuntimeAnalyzeDump](#runtimeanalyzedump-read-only-system) - [RuntimeAnalyzeProfilerTrace](#runtimeanalyzeprofilertrace-read-only-system) - [RuntimeCreateProfilerTraceParameters](#runtimecreateprofilertraceparameters-read-only-system) - [RuntimeGetDumpById](#runtimegetdumpbyid-read-only-system) - [RuntimeGetGatewayErrorLog](#runtimegetgatewayerrorlog-read-only-system) - [RuntimeGetProfilerTraceData](#runtimegetprofilertracedata-read-only-system) - [RuntimeListDumps](#runtimelistdumps-read-only-system) - [RuntimeListFeeds](#runtimelistfeeds-read-only-system) - [RuntimeListProfilerTraceFiles](#runtimelistprofilertracefiles-read-only-system) - [RuntimeListSystemMessages](#runtimelistsystemmessages-read-only-system) - [RuntimeRunClassWithProfiling](#runtimerunclasswithprofiling-read-only-system) - [RuntimeRunProgramWithProfiling](#runtimerunprogramwithprofiling-read-only-system) - [Table](#read-only-table) - [GetTableContents](#gettablecontents-read-only-table) - [ReadTable](#readtable-read-only-table) - [Transport](#read-only-transport) - [GetTransport](#gettransport-read-only-transport) - [ListTransports](#listtransports-read-only-transport) - [View](#read-only-view) - [ReadView](#readview-read-only-view) --- ## Read-Only Group ### Read-Only / Behavior Definition #### ReadBehaviorDefinition (Read-Only / Behavior Definition) **Description:** [read-only] Read ABAP behavior definition source code and metadata (package, responsible, description, etc.). **Source:** `src/handlers/behavior_definition/readonly/handleReadBehaviorDefinition.ts` **Parameters:** - `behavior_definition_name` (string, required) - Behavior definition name (e.g., Z_MY_BDEF). - `version` (string, optional (default: active)) - Version to read: "active" (default) or "inactive". --- ### Read-Only / Behavior Implementation #### ReadBehaviorImplementation (Read-Only / Behavior Implementation) **Description:** [read-only] Read ABAP behavior implementation source code and metadata (package, responsible, description, etc.). **Source:** `src/handlers/behavior_implementation/readonly/handleReadBehaviorImplementation.ts` **Parameters:** - `behavior_implementation_name` (string, required) - Behavior implementation name (e.g., ZBP_MY_CLASS). - `version` (string, optional (default: active)) - Version to read: "active" (default) or "inactive". --- ### Read-Only / Class #### ReadClass (Read-Only / Class) **Description:** [read-only] Read ABAP class source code and metadata (package, responsible, description, etc.). **Source:** `src/handlers/class/readonly/handleReadClass.ts` **Parameters:** - `class_name` (string, required) - Class name (e.g., ZCL_MY_CLASS). - `version` (string, optional (default: active)) - Version to read: "active" (default) or "inactive". --- ### Read-Only / Data Element #### ReadDataElement (Read-Only / Data Element) **Description:** [read-only] Read ABAP data element definition and metadata (package, responsible, description, etc.). **Source:** `src/handlers/data_element/readonly/handleReadDataElement.ts` **Parameters:** - `data_element_name` (string, required) - Data element name (e.g., Z_MY_DATA_ELEMENT). - `version` (string, optional (default: active)) - Version to read: "active" (default) or "inactive". --- ### Read-Only / Domain #### ReadDomain (Read-Only / Domain) **Description:** [read-only] Read ABAP domain definition and metadata (package, responsible, description, etc.). **Source:** `src/handlers/domain/readonly/handleReadDomain.ts` **Parameters:** - `domain_name` (string, required) - Domain name (e.g., Z_MY_DOMAIN). - `version` (string, optional (default: active)) - Version to read: "active" (default) or "inactive". --- ### Read-Only / Enhancement #### GetBadiImplementations (Read-Only / Enhancement) **Description:** [read-only] Find implementations of a (classic) BAdI definition. Use during symptom analysis when a standard SAP BAdI is implicated — answers 'which Z class extends this standard BAdI?'. Example flow: PO BAPI error → ME_PROCESS_PO_CUST → list Z impls → read the impl class source via GetClass to find the bug. Currently ECC-only (routes through the ZMCP_ADT_DDIC_BADI bridge FM). Classic BAdI only; kernel BAdI returns kind='unknown'. **Source:** `src/handlers/enhancement/readonly/handleGetBadiImplementations.ts` **Parameters:** - `active_only` (boolean, optional (default: true)) - Restrict to active implementations only. Default: true. - `badi_definition` (string, required) - BAdI definition name (e.g., ME_PROCESS_PO_CUST). Will be uppercased. - `customer_only` (boolean, optional (default: true)) - Restrict to Z*/Y* implementations. Default: true. Set false to include SAP-shipped implementations. - `include_methods` (boolean, optional (default: true)) - Include the list of redefined method names per implementation (from SXC_EXIT). Default: true. --- #### GetEnhancementImpl (Read-Only / Enhancement) **Description:** [read-only] Retrieve source code of a specific enhancement implementation by its name and enhancement spot. **Source:** `src/handlers/enhancement/readonly/handleGetEnhancementImpl.ts` **Parameters:** - `enhancement_name` (string, required) - Name of the enhancement implementation - `enhancement_spot` (string, required) - Name of the enhancement spot --- #### GetEnhancements (Read-Only / Enhancement) **Description:** [read-only] Retrieve a list of enhancements for a given ABAP object. **Source:** `src/handlers/enhancement/readonly/handleGetEnhancements.ts` **Parameters:** - `object_name` (string, required) - Name of the ABAP object - `object_type` (string, required) - Type of the ABAP object --- #### GetEnhancementSpot (Read-Only / Enhancement) **Description:** [read-only] Retrieve metadata and list of implementations for a specific enhancement spot. **Source:** `src/handlers/enhancement/readonly/handleGetEnhancementSpot.ts` **Parameters:** - `enhancement_spot` (string, required) - Name of the enhancement spot --- ### Read-Only / Function Group #### ReadFunctionGroup (Read-Only / Function Group) **Description:** [read-only] Read ABAP function group source code and metadata (package, responsible, description, etc.). **Source:** `src/handlers/function_group/readonly/handleReadFunctionGroup.ts` **Parameters:** - `function_group_name` (string, required) - Function group name (e.g., Z_MY_FG). - `version` (string, optional (default: active)) - Version to read: "active" (default) or "inactive". --- ### Read-Only / Function Module #### ReadFunctionModule (Read-Only / Function Module) **Description:** [read-only] Read ABAP function module source code and metadata (package, responsible, description, etc.). **Source:** `src/handlers/function_module/readonly/handleReadFunctionModule.ts` **Parameters:** - `function_group_name` (string, required) - Function group name containing the function module (e.g., Z_MY_FG). - `function_module_name` (string, required) - Function module name (e.g., Z_MY_FM). - `version` (string, optional (default: active)) - Version to read: "active" (default) or "inactive". --- ### Read-Only / Gui Status #### GetGuiStatusList (Read-Only / Gui Status) **Description:** [read-only] List all GUI statuses belonging to an ABAP program. **Source:** `src/handlers/gui_status/readonly/handleGetGuiStatusList.ts` **Parameters:** - `program_name` (string, required) - Program name (e.g., SAPMV45A). --- #### ReadGuiStatus (Read-Only / Gui Status) **Description:** [read-only] Read ABAP GUI Status definition (statuses, function codes, menus, toolbars, titles) for a program. **Source:** `src/handlers/gui_status/readonly/handleReadGuiStatus.ts` **Parameters:** - `program_name` (string, required) - Parent program name (e.g., SAPMV45A). --- ### Read-Only / Include #### GetInclude (Read-Only / Include) **Description:** [read-only] Retrieve source code of a specific ABAP include file. **Source:** `src/handlers/include/readonly/handleGetInclude.ts` **Parameters:** - None --- #### GetIncludesList (Read-Only / Include) **Description:** [read-only] Recursively discover and list ALL include files within an ABAP program or include. **Source:** `src/handlers/include/readonly/handleGetIncludesList.ts` **Parameters:** - `detailed` (boolean, optional (default: false)) - If true, returns structured JSON with metadata and raw XML. - `object_name` (string, required) - Name of the ABAP program or include - `object_type` (string, required) - ADT object type (e.g. PROG/P, PROG/I, FUGR, CLAS/OC) - `timeout` (number, optional) - Timeout in ms for each ADT request. --- ### Read-Only / Interface #### ReadInterface (Read-Only / Interface) **Description:** [read-only] Read ABAP interface source code and metadata (package, responsible, description, etc.). **Source:** `src/handlers/interface/readonly/handleReadInterface.ts` **Parameters:** - `interface_name` (string, required) - Interface name (e.g., ZIF_MY_INTERFACE). - `version` (string, optional (default: active)) - Version to read: "active" (default) or "inactive". --- ### Read-Only / Metadata Extension #### ReadMetadataExtension (Read-Only / Metadata Extension) **Description:** [read-only] Read ABAP metadata extension (DDLX) source code and metadata (package, responsible, description, etc.). **Source:** `src/handlers/metadata_extension/readonly/handleReadMetadataExtension.ts` **Parameters:** - `metadata_extension_name` (string, required) - Metadata extension name (e.g., Z_MY_DDLX). - `version` (string, optional (default: active)) - Version to read: "active" (default) or "inactive". --- ### Read-Only / Package #### GetPackageContents (Read-Only / Package) **Description:** [read-only] Retrieve objects inside an ABAP package as a flat list. Supports recursive traversal of subpackages. **Source:** `src/handlers/package/readonly/handleGetPackageContents.ts` **Parameters:** - None --- #### ReadPackage (Read-Only / Package) **Description:** [read-only] Read ABAP package definition and metadata (super-package, responsible, description, etc.). **Source:** `src/handlers/package/readonly/handleReadPackage.ts` **Parameters:** - `package_name` (string, required) - Package name (e.g., Z_MY_PACKAGE). - `version` (string, optional (default: active)) - Version to read: "active" (default) or "inactive". --- ### Read-Only / Program #### GetProgFullCode (Read-Only / Program) **Description:** [read-only] Returns the full code for a program or function group, including all includes, in tree traversal order. Use output="file" to get paths + outlines instead of the code. **Source:** `src/handlers/program/readonly/handleGetProgFullCode.ts` **Parameters:** - `name` (string, required) - Technical name of the program or function group (e.g., '/CBY/MM_INVENTORY') - `output` (string, optional (default: inline)) - - `type` (string, required) - 'PROG/P' for program or 'FUGR' for function group --- #### ReadProgram (Read-Only / Program) **Description:** [read-only] Read ABAP program source code and metadata (package, responsible, description, etc.). **Source:** `src/handlers/program/readonly/handleReadProgram.ts` **Parameters:** - `program_name` (string, required) - Program name (e.g., Z_MY_PROGRAM). - `version` (string, optional (default: active)) - Version to read: "active" (default) or "inactive". --- ### Read-Only / Screen #### GetScreensList (Read-Only / Screen) **Description:** [read-only] List all screens (dynpros) belonging to an ABAP program. **Source:** `src/handlers/screen/readonly/handleGetScreensList.ts` **Parameters:** - `program_name` (string, required) - Program name (e.g., SAPMV45A). --- #### ReadScreen (Read-Only / Screen) **Description:** [read-only] Read ABAP Screen (Dynpro) flow logic source code, fields, and metadata. **Source:** `src/handlers/screen/readonly/handleReadScreen.ts` **Parameters:** - `program_name` (string, required) - Parent program name (e.g., SAPMV45A). - `screen_number` (string, required) - Screen number (e.g., 0100). --- ### Read-Only / Search #### GetObjectsByType (Read-Only / Search) **Description:** [read-only] Retrieves all ABAP objects of a specific type (classes, tables, programs, interfaces, etc.) under a given parent node. Useful for listing all objects of one type within a package or composite object. **Source:** `src/handlers/search/readonly/handleGetObjectsByType.ts` **Parameters:** - `format` (string, optional) - Output format: 'raw' or 'parsed' - `node_id` (string, required) - [read-only] Node ID - `parent_name` (string, required) - Parent object name - `parent_tech_name` (string, required) - Parent technical name - `parent_type` (string, required) - Parent object type - `with_short_descriptions` (boolean, optional) - Include short descriptions --- #### GetObjectsList (Read-Only / Search) **Description:** [read-only] Recursively retrieves all child ABAP repository objects for a given parent — programs (PROG), function groups (FUGR), classes (CLAS), packages (DEVC), and other composite objects — including nested includes and subcomponents. **Source:** `src/handlers/search/readonly/handleGetObjectsList.ts` **Parameters:** - `parent_name` (string, required) - Parent object name - `parent_tech_name` (string, required) - Parent technical name - `parent_type` (string, required) - Parent object type (e.g. PROG/P, FUGR) - `with_short_descriptions` (boolean, optional (default: true))) - Include short descriptions (default: true) --- #### SearchObject (Read-Only / Search) **Description:** [read-only] Find, search, locate, or check if an ABAP repository object exists by name or wildcard pattern (e.g. 'ZOK*'). Use this tool to answer questions like 'is there a program named...', 'find all objects starting with...', 'does this class exist?', 'list objects matching...'. Supports all repository object types — optionally filter by type (PROG, CLAS, INTF, DEVC, TABL, DDLS, DTEL, FUGR, SRVD, SRVB, BDEF, DDLX, etc.). **Source:** `src/handlers/search/readonly/handleSearchObject.ts` **Parameters:** - `include_raw_xml` (boolean, optional (default: false)) - Also return the raw ADT XML (the parsed results already carry every field). Default false. - `maxResults` (number, optional (default: DEFAULT_MAX_RESULTS)) - Maximum number of results to return (default ${DEFAULT_MAX_RESULTS}). The response has truncated=true when this limit was hit. - `object_name` (string, required) - Object name or mask (e.g. 'MARA*') - `object_type` (string, optional) - Optional ABAP object type (e.g. 'TABL', 'CLAS/OC') --- ### Read-Only / Service Binding #### ReadServiceBinding (Read-Only / Service Binding) **Description:** [read-only] Read ABAP service binding source/payload and metadata (package, responsible, description, etc.). **Source:** `src/handlers/service_binding/readonly/handleReadServiceBinding.ts` **Parameters:** - `service_binding_name` (string, required) - Service binding name (e.g., ZUI_MY_BINDING). --- ### Read-Only / Service Definition #### ReadServiceDefinition (Read-Only / Service Definition) **Description:** [read-only] Read ABAP service definition source code and metadata (package, responsible, description, etc.). **Source:** `src/handlers/service_definition/readonly/handleReadServiceDefinition.ts` **Parameters:** - `service_definition_name` (string, required) - Service definition name (e.g., Z_MY_SRVD). - `version` (string, optional (default: active)) - Version to read: "active" (default) or "inactive". --- ### Read-Only / Structure #### ReadStructure (Read-Only / Structure) **Description:** [read-only] Read ABAP structure definition and metadata (package, responsible, description, etc.). **Source:** `src/handlers/structure/readonly/handleReadStructure.ts` **Parameters:** - `structure_name` (string, required) - Structure name (e.g., Z_MY_STRUCTURE). - `version` (string, optional (default: active)) - Version to read: "active" (default) or "inactive". --- ### Read-Only / System #### DescribeByList (Read-Only / System) **Description:** [read-only] Batch description for a list of ABAP objects. Input: objects: Array<{ name: string, type?: string }>. Each object may be of type: PROG/P, FUGR, PROG/I, CLAS/OC, FUGR/FC, INTF/OI, TABLE, STRUCTURE, etc. **Source:** `src/handlers/system/readonly/handleDescribeByList.ts` **Parameters:** - `objects` (array, required) - Object name (required, must be valid ABAP object name or mask) --- #### GetAbapAST (Read-Only / System) **Description:** [read-only] Parse ABAP code and return AST (Abstract Syntax Tree) in JSON format. **Source:** `src/handlers/system/readonly/handleGetAbapAST.ts` **Parameters:** - `code` (string, required) - ABAP source code to parse - `filePath` (string, optional) - Optional file path to write the result to --- #### GetAbapSemanticAnalysis (Read-Only / System) **Description:** [read-only] Perform semantic analysis on ABAP code and return symbols, types, scopes, and dependencies. **Source:** `src/handlers/system/readonly/handleGetAbapSemanticAnalysis.ts` **Parameters:** - `code` (string, required) - ABAP source code to analyze - `filePath` (string, optional) - Optional file path to write the result to --- #### GetAbapSystemSymbols (Read-Only / System) **Description:** [read-only] Resolve ABAP symbols from semantic analysis with SAP system information including types, scopes, descriptions, and packages. **Source:** `src/handlers/system/readonly/handleGetAbapSystemSymbols.ts` **Parameters:** - `code` (string, required) - ABAP source code to analyze and resolve symbols for - `filePath` (string, optional) - Optional file path to write the result to --- #### GetAdtTypes (Read-Only / System) **Description:** [read-only] Retrieve all valid ADT object types (CLAS, TABL, PROG, DEVC, FUGR, INTF, DDLS, DTEL, DOMA, SRVD, SRVB, BDEF, DDLX, etc.) or validate a specific type name. **Source:** `src/handlers/system/readonly/handleGetAllTypes.ts` **Parameters:** - `validate_type` (string, optional) - Type name to validate (optional) --- #### GetInactiveObjects (Read-Only / System) **Description:** [read-only] Get a list of inactive ABAP objects — modified but not yet activated, pending activation. Shows classes, tables, CDS views, and other objects awaiting activation. **Source:** `src/handlers/system/readonly/handleGetInactiveObjects.ts` **Parameters:** - None --- #### GetJobUsage (Read-Only / System) **Description:** [read-only] Check whether programs are used as background job steps (SM37 jobs, TBTCO/TBTCP): true when the program is a step of a job that is scheduled now (released/ready/active, incl. periodic) or that finished/was cancelled in the last N months. SE38/SA38 dialog runs do not count. `oldest` = start date of the oldest finished job still kept; job reorganization deletes older ones, so when `complete` is false a false means "no job since ". No user names are returned. ECC-only (ZMCP_WL_JOB_USAGE bridge FM). **Source:** `src/handlers/system/readonly/handleGetJobUsage.ts` **Parameters:** - `months` (number, optional (default: 12)) - Months back including the current one (1-36). Default: 12. - `programs` (array, required) - ABAP program names to check (e.g. ["ZMY_REPORT"]). --- #### GetObjectInfo (Read-Only / System) **Description:** [read-only] Return ABAP object tree structure for packages (DEVC), classes (CLAS), programs (PROG), function groups (FUGR), and other objects. Shows root, group nodes, and terminal leaves up to maxDepth. Enrich each node with description and package via SearchObject if enrich=true. **Source:** `src/handlers/system/readonly/handleGetObjectInfo.ts` **Parameters:** - `enrich` (boolean, optional (default: true)) - Whether to add description and package via SearchObject (default true) - `maxDepth` (integer, optional (default: 1)) - Maximum tree depth (default depends on type) - `parent_name` (string, required) - Parent object name - `parent_type` (string, required) - Parent object type (e.g. DEVC/K, CLAS/OC, PROG/P) --- #### GetObjectNodeFromCache (Read-Only / System) **Description:** [read-only] Returns a node from the in-memory objects list cache by OBJECT_TYPE, OBJECT_NAME, TECH_NAME, and expands OBJECT_URI if present. **Source:** `src/handlers/system/readonly/handleGetObjectNodeFromCache.ts` **Parameters:** - `object_name` (string, required) - [read-only] Object name - `object_type` (string, required) - [read-only] Object type - `tech_name` (string, required) - [read-only] Technical name --- #### GetObjectStructure (Read-Only / System) **Description:** [read-only] Retrieve ADT object structure as a compact JSON tree. **Source:** `src/handlers/system/readonly/handleGetObjectStructure.ts` **Parameters:** - `objectname` (string, required) - ADT object name (e.g. /CBY/ACQ_DDL) - `objecttype` (string, required) - ADT object type (e.g. DDLS/DF) --- #### GetSession (Read-Only / System) **Description:** [read-only] Get a new session ID and current session state (cookies, CSRF token) for reuse across multiple ADT operations. Use this to maintain the same session and lock handle across multiple requests. **Source:** `src/handlers/system/readonly/handleGetSession.ts` **Parameters:** - `force_new` (boolean, optional) - Force creation of a new session even if one exists. Default: false --- #### GetSmartFormContent (Read-Only / System) **Description:** [read-only] Read what a SmartForm prints, for a preview: per page and window (position in mm) the content tree — text nodes with their lines (paragraph format + text with inline tags and &symbols&), include texts, tables / templates / loops with line types and cells, graphics, addresses, conditions; code nodes appear only as markers (no program lines). Also fetches the SmartStyles as CSS, the SE78 graphics with a fixed key as BMP files (with printed size) and the include texts with a fixed key. Graphics / texts whose key holds a &symbol& are listed under dynamicReferences. Active version, texts in the logon language. Files go under the MCP output directory (smartforms/
/), including .content.json with the full result; summary=true answers with an overview (windows, data declarations, &symbols&, files) instead of the content tree. Needs the ZMCP_SSF_CONTENT FM and the SSF_CONTENT dispatcher action. **Source:** `src/handlers/system/readonly/handleGetSmartFormContent.ts` **Parameters:** - `device` (string, optional) - Output device whose printer fonts the preview should assume. Default: a device whose type has fonts for most of the families of the form. - `form_name` (string, required) - SmartForm name (e.g. "ZMY_FORM"). - `include_graphics` (boolean, optional) - Fetch SE78 graphics with a fixed key as BMP files. Default true. - `include_styles` (boolean, optional) - Fetch the SmartStyles (form default + text node styles) as CSS. Default true. - `include_texts` (boolean, optional) - Fetch include texts (SO10) with a fixed key. Default true. - `summary` (boolean, optional) - Answer with an overview (windows, data declarations, &symbols&, graphics, files) instead of the full content tree; the full result is always written to files.content. Default false. - `text_language` (string, optional) - Language for include texts whose key has no language: 1-char SAP key (e.g. "3") or 2-letter ISO code (e.g. "KO"). Default: the form language. - `values` (object, optional) - Sample values for &symbols& in graphic keys (e.g. {"IM_SIGN": "ZSIGN"}): graphics named by a variable are then fetched too. --- #### GetSmartFormLayout (Read-Only / System) **Description:** [read-only] Read the page and window layout of a SmartForm (active version; a never-activated form is read from its saved version, then `active` is false): per page the format, orientation, next page, CPI / LPI and style, and per window its type (MAIN / SECONDARY / ...), position and size as stored (value + unit) and converted to millimetres. Layout only: no texts, code or form interface. Needs the ZMCP_SSF_LAYOUT FM and the SSF_LAYOUT dispatcher action. **Source:** `src/handlers/system/readonly/handleGetSmartFormLayout.ts` **Parameters:** - `form_name` (string, required) - SmartForm name (e.g. "ZMY_FORM"). - `language` (string, optional) - Form language: 1-char SAP key (e.g. "E", "3") or 2-letter ISO code (e.g. "EN", "KO"). Default: the master language of the form. --- #### GetSqlQuery (Read-Only / System) **Description:** [read-only] Execute ABAP SQL SELECT queries on database tables and CDS views via SAP ADT Data Preview API. Use for ad-hoc data retrieval, row counts, and filtered queries. **Source:** `src/handlers/system/readonly/handleGetSqlQuery.ts` **Parameters:** - `acknowledge_risk` (boolean, optional (default: false)) - Set to true ONLY after the user has explicitly authorized row extraction from an 'ask'-tier protected table. The approval is logged to stderr for audit. Has no effect on 'deny'-tier tables. - `row_number` (number, optional (default: 100)) - Maximum number of rows to return - `sql_query` (string, required) - SQL query to execute --- #### GetTcodeUsage (Read-Only / System) **Description:** [read-only] Check whether transactions were used in the last N months, from the ST03N workload monthly aggregates. Returns one boolean per transaction plus `coverage` = months that actually hold workload data; when coverage < months, false means "not used in the last months". No user names are returned. ECC-only (ZMCP_WL_TCODE_USAGE bridge FM). **Source:** `src/handlers/system/readonly/handleGetTcodeUsage.ts` **Parameters:** - `destination` (string, optional) - SM59 RFC destination (on the connected system) of the system to measure, e.g. the QA or PRD system. Omitted → SAP_USAGE_RFCDEST from the profile sap.env, else the connected system. "" or "LOCAL" → the connected system. - `months` (number, optional (default: 12)) - Months back including the current one (1-36). Default: 12. - `tcodes` (array, required) - Transaction codes to check (e.g. ["VA01","ZMY_TCODE"]). --- #### GetTransaction (Read-Only / System) **Description:** [read-only] Retrieve ABAP transaction (t-code) details from TSTC / TSTCP — program, screen, and kind (program, parameter transaction with its target t-code and parameters such as an SM30 view, variant transaction). Pass transaction_names for many t-codes in one call. **Source:** `src/handlers/system/readonly/handleGetTransaction.ts` **Parameters:** - `transaction_name` (string, optional) - Name of the ABAP transaction - `transaction_names` (array, optional) - Several transactions in one call (e.g. ["VA01","ZMY_TCODE"]). --- #### GetTypeInfo (Read-Only / System) **Description:** [read-only] Retrieve ABAP type information for domains (DOMA), data elements (DTEL), table types, and structures. Returns field definitions, value ranges, fixed values, and DDIC metadata. **Source:** `src/handlers/system/readonly/handleGetTypeInfo.ts` **Parameters:** - `include_structure_fallback` (boolean, optional (default: true)) - When true (default), tries DDIC structure lookup only if type lookup returns 404/empty. - `type_name` (string, required) - Name of the ABAP type --- #### GetUsageSnippets (Read-Only / System) **Description:** [read-only] Line-level where-used hits: for each referencing object, the source lines that use the searched object, with uri ".../source/main#start=,", line, column and the source line. Pass object_identifiers from GetWhereUsed references[].object_identifier, or object_name + object_type to run the where-used search first (customer_only / package filters apply to that search). Works on ECC 7.40 and S/4HANA. **Source:** `src/handlers/system/readonly/handleGetUsageSnippets.ts` **Parameters:** - `customer_only` (boolean, optional (default: false)) - With object_name: only customer referencing objects (Z / Y name, or package Z* / Y* / $*). Default: false. - `include_context` (boolean, optional (default: false)) - Include the multi-line context SAP returns per hit (description). Default: false. - `max_objects` (number, optional) - Cap on referencing objects whose snippets are fetched. Default: ${DEFAULT_MAX_OBJECTS}. truncated=true when more were available. - `object_identifiers` (array, optional) - object_identifier values from GetWhereUsed references[]. Takes precedence over object_name / object_type. - `object_name` (string, optional) - Object to search (used when object_identifiers is not given). - `object_type` (string, optional) - Object type for object_name: ${SUPPORTED_WHERE_USED_TYPES} - `package` (string, optional) - With object_name: package filter on the referencing objects (exact, or prefix with trailing *). - `timeout_ms` (number, optional) - Optional request timeout in ms per SAP request (the where-used search and each snippet batch). --- #### GetWhereUsed (Read-Only / System) **Description:** [read-only] Find where-used references (cross-references, usages, dependencies) for ABAP objects — classes, interfaces, tables, data elements, programs, function modules, etc. Returns list of all referencing objects with their types and packages. On ECC a function module may be given by plain name (no GROUP|FM needed). Widely used SAP standard tables (e.g. VBAK) can take about 60 s and return thousands of references — use customer_only / package / max_results to shrink the answer (filtering happens after the SAP search, so it does not shorten the search time). Pass references[].object_identifier to GetUsageSnippets for line-level hits. **Source:** `src/handlers/system/readonly/handleGetWhereUsed.ts` **Parameters:** - `customer_only` (boolean, optional (default: false)) - Optional. Keep only customer objects: name starting with Z / Y, or package Z* / Y* / $*. Objects in /namespace/ (SAP industry solutions, partners, generated /1.../) are dropped; for a registered customer namespace use package: "/ACME/*" instead. Default: false. - `enable_all_types` (boolean, optional (default: false)) - If true, searches in all available object types (Eclipse 'select all' behavior). Default: false (uses SAP default scope). Ignored on ECC (no scope resource). - `max_results` (number, optional) - Optional cap on references[] after filtering. Omit or 0 = no cap. truncated=true when more were found. - `object_name` (string, required) - Name of the ABAP object - `object_type` (string, required) - Type of the ABAP object: ${SUPPORTED_WHERE_USED_TYPES} - `package` (string, optional) - Optional package filter on references[].package_name: exact name, or prefix with a trailing * (e.g. ZSD*). - `timeout_ms` (number, optional) - Optional request timeout in ms for the SAP search. Default: SAP_TIMEOUT_LONG (120 s) on ECC, SAP_TIMEOUT_DEFAULT (45 s) otherwise. --- #### ReloadProfile (Read-Only / System) **Description:** [system] Reload the active SAP profile from .sc4sap/active-profile.txt and reset the cached connection. Called by the sc4sap plugin after switching profiles. Returns the newly active alias, host, tier, and readonly status. **Source:** `src/handlers/system/readonly/handleReloadProfile.ts` **Parameters:** - None --- #### RenderSmartForm (Read-Only / System) **Description:** [runs the form, no output] The output of a SmartForm as SAP prints it, for given interface values: calls the generated function module with GETOTF (no dialog, no print, no spool) and writes the OTF (text: positions, fonts, strings) and the PDF under the MCP output directory (smartforms//.sap.otf.txt / .sap.pdf). The form's own program lines run as in a real print and may read the database — pass invented sample values only. Needs the ZMCP_SSF_RENDER FM and the SSF_RENDER dispatcher action. **Source:** `src/handlers/system/readonly/handleRenderSmartForm.ts` **Parameters:** - `device` (string, optional) - Output device whose device type sets fonts and character widths (e.g. the printer the form goes to). Default: the user default device, else a SAPWIN / PDF device. - `families` (array, optional) - Font families the form uses (from GetSmartFormContent styles). Without `device`, a device whose type has printer fonts for most of them is used, so the output shows the fonts the form was made for. - `form_name` (string, required) - SmartForm name (e.g. "ZMY_FORM"). - `language` (string, optional) - Output language: 1-char SAP key or 2-letter ISO code. Default: logon language. - `values` (object, optional) - Interface parameter → value, in internal format: structures as objects with the ABAP component names, TABLES parameters / table types as arrays, dates "2026-10-16", times "14:00:00", amounts and quantities as numbers. Parameters left out are passed initial. - `values_file` (string, optional) - Path of a JSON file with the same object as `values` (for large interfaces). Ignored when `values` is given. --- #### RuntimeAnalyzeDump (Read-Only / System) **Description:** [runtime] Read runtime dump by ID and return key facts (runtime error, exception, program, termination object/line, user, date, chapter index). Set include_payload=false for facts only. Pass chapters=["developer"] to get the ST22 long text reduced to the developer chapters (~10 KB instead of ~50 KB). **Source:** `src/handlers/system/readonly/handleRuntimeAnalyzeDump.ts` **Parameters:** - `chapters` (array, optional) - Formatted long text only (implies view="formatted"): keep just these chapters, without box borders or padding. "developer" = Short Text, What happened?, Error analysis, Chain of Exception Objects, Information on where terminated, Source Code Extract, Active Calls/Events, User and Transaction. Other entries match chapter titles by prefix. - `dump_id` (string, required) - Runtime dump ID. - `include_payload` (boolean, optional (default: true)) - Include full parsed payload in response. - `view` (string, optional (default: default)) - Dump view mode to analyze: default payload, summary section, or formatted long text. --- #### RuntimeAnalyzeProfilerTrace (Read-Only / System) **Description:** [runtime] Read profiler trace view and return compact analysis summary (totals + top entries). **Source:** `src/handlers/system/readonly/handleRuntimeAnalyzeProfilerTrace.ts` **Parameters:** - `top` (number, optional) - Number of top rows for summary. Default: 10. - `trace_id_or_uri` (string, required) - Profiler trace ID or full trace URI. - `view` (string, optional (default: hitlist)) - - `with_system_events` (boolean, optional) - Include system events. --- #### RuntimeCreateProfilerTraceParameters (Read-Only / System) **Description:** [runtime] Create ABAP profiler trace parameters and return profilerId (URI) for profiled execution. **Source:** `src/handlers/system/readonly/handleRuntimeCreateProfilerTraceParameters.ts` **Parameters:** - `aggregate` (boolean, optional) - - `all_db_events` (boolean, optional) - - `all_dynpro_events` (boolean, optional) - - `all_internal_table_events` (boolean, optional) - - `all_misc_abap_statements` (boolean, optional) - - `all_procedural_units` (boolean, optional) - - `all_system_kernel_events` (boolean, optional) - - `amdp_trace` (boolean, optional) - - `description` (string, required) - Human-readable trace description. - `explicit_on_off` (boolean, optional) - - `max_size_for_trace_file` (number, optional) - - `max_time_for_tracing` (number, optional) - - `sql_trace` (boolean, optional) - - `with_rfc_tracing` (boolean, optional) - --- #### RuntimeGetDumpById (Read-Only / System) **Description:** [runtime] Read a specific ABAP runtime dump by dump ID. Default view (~7 KB): dump metadata, termination link (object + line) and chapter index. Use response_mode="summary" for key facts only (runtime error, exception, program, termination object/line, user, date). For the ST22 long text pass chapters=["developer"] (or chapter titles) to get only those chapters, compacted (~10 KB instead of ~50 KB). **Source:** `src/handlers/system/readonly/handleRuntimeGetDumpById.ts` **Parameters:** - `chapters` (array, optional) - Formatted long text only (implies view="formatted"): keep just these chapters, without box borders or padding. "developer" = Short Text, What happened?, Error analysis, Chain of Exception Objects, Information on where terminated, Source Code Extract, Active Calls/Events, User and Transaction. Other entries match chapter titles by prefix, e.g. "Selected Variables". - `dump_id` (string, required) - Runtime dump ID (for example: 694AB694097211F1929806D06D234D38). - `response_mode` (string, optional (default: payload)) - Controls what is returned: "payload" (default, legacy) — full parsed dump data only, "summary" — compact key facts only (title, exception, program, line, user, date...), "both" — summary + full payload. - `view` (string, optional (default: default)) - Dump view mode: default payload, summary section, or formatted long text. --- #### RuntimeGetGatewayErrorLog (Read-Only / System) **Description:** [runtime] List SAP Gateway error log (/IWFND/ERROR_LOG) or get error detail. Returns structured entries with type, shortText, transactionId, dateTime, username. With error_url returns full detail including serviceInfo, errorContext, sourceCode, callStack. **Source:** `src/handlers/system/readonly/handleRuntimeGetGatewayErrorLog.ts` **Parameters:** - `error_url` (string, optional) - Feed URL of a specific error entry (from a previous list response link field). When provided, returns detailed error info instead of listing. - `from` (string, optional) - Start of time range in YYYYMMDDHHMMSS format. - `max_results` (number, optional) - Maximum number of errors to return. - `to` (string, optional) - End of time range in YYYYMMDDHHMMSS format. - `user` (string, optional) - Filter errors by SAP username. --- #### RuntimeGetProfilerTraceData (Read-Only / System) **Description:** [runtime] Read profiler trace data by trace id/uri: hitlist, statements, or db accesses. Returns parsed JSON payload. **Source:** `src/handlers/system/readonly/handleRuntimeGetProfilerTraceData.ts` **Parameters:** - `auto_drill_down_threshold` (number, optional) - Auto drill-down threshold (for statements view). - `id` (number, optional) - Statement node ID (for statements view). - `trace_id_or_uri` (string, required) - Profiler trace ID or full ADT trace URI. - `view` (string, required) - Trace view to retrieve. - `with_details` (boolean, optional) - Include statement details (for statements view). - `with_system_events` (boolean, optional) - Include system events. --- #### RuntimeListDumps (Read-Only / System) **Description:** [runtime] List ABAP runtime dumps with optional user filter and paging. Returns parsed JSON payload. Each entry's HTML summary (~13 KB per dump) is omitted unless include_summary=true — use RuntimeGetDumpById / RuntimeAnalyzeDump for one dump's details. **Source:** `src/handlers/system/readonly/handleRuntimeListDumps.ts` **Parameters:** - `include_summary` (boolean, optional) - Keep each entry's HTML summary (atom:summary). Default false — it is ~96% of the payload and duplicates what RuntimeGetDumpById returns. - `inlinecount` (string, optional) - Include total count metadata. - `orderby` (string, optional) - ADT order by expression. - `skip` (number, optional) - Number of records to skip. - `top` (number, optional) - Maximum number of records to return. - `user` (string, optional) - Optional username filter. If omitted, dumps for all users are returned. --- #### RuntimeListFeeds (Read-Only / System) **Description:** [runtime] List available ADT runtime feeds or read a specific feed type. Feed types: dumps, system_messages, gateway_errors. Without feed_type returns available feed descriptors. **Source:** `src/handlers/system/readonly/handleRuntimeListFeeds.ts` **Parameters:** - `feed_type` (string, optional (default: descriptors)) - Feed to read. "descriptors" lists available feeds, "variants" lists feed variants, others read that specific feed. Default: descriptors. - `from` (string, optional) - Start of time range in YYYYMMDDHHMMSS format. - `max_results` (number, optional) - Maximum number of entries to return. - `to` (string, optional) - End of time range in YYYYMMDDHHMMSS format. - `user` (string, optional) - Filter feed entries by SAP username. --- #### RuntimeListProfilerTraceFiles (Read-Only / System) **Description:** [runtime] List ABAP profiler trace files available in ADT runtime. Returns parsed JSON payload. **Source:** `src/handlers/system/readonly/handleRuntimeListProfilerTraceFiles.ts` **Parameters:** - None --- #### RuntimeListSystemMessages (Read-Only / System) **Description:** [runtime] List SM02 system messages. Returns structured entries with id, title, text, severity, validity period, and author. **Source:** `src/handlers/system/readonly/handleRuntimeListSystemMessages.ts` **Parameters:** - `from` (string, optional) - Start of time range in YYYYMMDDHHMMSS format. - `max_results` (number, optional) - Maximum number of messages to return. - `to` (string, optional) - End of time range in YYYYMMDDHHMMSS format. - `user` (string, optional) - Filter by author username. --- #### RuntimeRunClassWithProfiling (Read-Only / System) **Description:** [runtime] Execute ABAP class with profiler enabled and return created profilerId + traceId. **Source:** `src/handlers/system/readonly/handleRuntimeRunClassWithProfiling.ts` **Parameters:** - `aggregate` (boolean, optional) - - `all_db_events` (boolean, optional) - - `all_dynpro_events` (boolean, optional) - - `all_internal_table_events` (boolean, optional) - - `all_misc_abap_statements` (boolean, optional) - - `all_procedural_units` (boolean, optional) - - `all_system_kernel_events` (boolean, optional) - - `amdp_trace` (boolean, optional) - - `class_name` (string, required) - ABAP class name to execute. - `description` (string, optional) - Profiler trace description. - `explicit_on_off` (boolean, optional) - - `max_size_for_trace_file` (number, optional) - - `max_time_for_tracing` (number, optional) - - `sql_trace` (boolean, optional) - - `with_rfc_tracing` (boolean, optional) - --- #### RuntimeRunProgramWithProfiling (Read-Only / System) **Description:** [runtime] Execute ABAP program with profiler enabled and return created profilerId + traceId. **Source:** `src/handlers/system/readonly/handleRuntimeRunProgramWithProfiling.ts` **Parameters:** - `aggregate` (boolean, optional) - - `all_db_events` (boolean, optional) - - `all_dynpro_events` (boolean, optional) - - `all_internal_table_events` (boolean, optional) - - `all_misc_abap_statements` (boolean, optional) - - `all_procedural_units` (boolean, optional) - - `all_system_kernel_events` (boolean, optional) - - `amdp_trace` (boolean, optional) - - `description` (string, optional) - Profiler trace description. - `explicit_on_off` (boolean, optional) - - `max_size_for_trace_file` (number, optional) - - `max_time_for_tracing` (number, optional) - - `program_name` (string, required) - ABAP program name to execute. - `sql_trace` (boolean, optional) - - `with_rfc_tracing` (boolean, optional) - --- ### Read-Only / Table #### GetTableContents (Read-Only / Table) **Description:** [read-only] Retrieve contents (data preview) of an ABAP database table or CDS view, like SE16. Compact by default: column names only, empty cell values left out of each row, 20 rows. Use fields to keep only some columns and include_metadata for column types/descriptions. **Source:** `src/handlers/table/readonly/handleGetTableContents.ts` **Parameters:** - None --- #### ReadTable (Read-Only / Table) **Description:** [read-only] Read ABAP table definition and metadata (package, responsible, description, etc.). **Source:** `src/handlers/table/readonly/handleReadTable.ts` **Parameters:** - `table_name` (string, required) - Table name (e.g., Z_MY_TABLE). - `version` (string, optional (default: active)) - Version to read: "active" (default) or "inactive". --- ### Read-Only / Transport #### GetTransport (Read-Only / Transport) **Description:** [read-only] Retrieve ABAP transport request information including metadata, included objects, and status from SAP system. **Source:** `src/handlers/transport/readonly/handleGetTransport.ts` **Parameters:** - `include_objects` (boolean, optional (default: true))) - Include list of objects in transport (default: true) - `include_tasks` (boolean, optional (default: true))) - Include list of tasks in transport (default: true) - `owner` (string, optional) - SAP user who owns the transport. On ECC the session-user-scoped path endpoint silently filters out other users' TRs — pass `owner` to retry via the list endpoint. On S/4 usually unnecessary, but provide it if the path read is rejected by authorization. - `transport_number` (string, required) - Transport request number (e.g., E19K905635, DEVK905123) --- #### ListTransports (Read-Only / Transport) **Description:** [read-only] List transport requests for the current or specified user. Returns modifiable and/or released workbench and customizing requests. **Source:** `src/handlers/transport/readonly/handleListTransports.ts` **Parameters:** - `modifiable_only` (boolean, optional) - Only return modifiable (not yet released) transports. Default: true. - `user` (string, optional) - SAP user name. If not provided, returns transports for the current user. --- ### Read-Only / View #### ReadView (Read-Only / View) **Description:** [read-only] Read ABAP view (CDS view) source code and metadata (package, responsible, description, etc.). **Source:** `src/handlers/view/readonly/handleReadView.ts` **Parameters:** - `version` (string, optional (default: active)) - Version to read: "active" (default) or "inactive". - `view_name` (string, required) - View name (e.g., Z_MY_VIEW). --- *Last updated: 2026-10-28*