Zendesk Help Center. Specify the operation and its parameters.

Available operations:
- **search_articles**: Full-text search across Help Center articles (metadata only, no body).
- **get_article**: Retrieve an article by ID with full body content.
- **list_categories**: List all Help Center categories.
- **list_sections**: List Help Center sections.
- **list_articles**: List articles (metadata only, no body).
- **list_promoted_articles**: List the promoted ("featured") Help Center articles — the small, editorially-curated set surfaced at the top of their sections.
- **list_article_translations**: List all available translations for an article (metadata only, no body: locale, title, draft, updated_at).
- **create_article_translation**: Create a translation for an existing article in a specific locale. (write)
- **update_article_translation**: Update article content (title, body) in a specific locale. (write)
- **list_section_translations**: List the translations of a Help Center section: for each locale, the localized name, whether a description is set, and whether the translation is published or still a draft.
- **list_category_translations**: List the translations of a Help Center category: for each locale, the localized name, whether a description is set, and whether the translation is published or still a draft.
- **find_translation_gaps**: Audit the Help Center tree for a target locale and report every category and section that has no translation, or one that is still an unpublished draft.
- **set_section_translation**: Create or update the translation of a Help Center section in one locale, and return the resulting translation (locale, localized name, draft state). (write)
- **set_category_translation**: Create or update the translation of a Help Center category in one locale, and return the resulting translation (locale, localized name, draft state). (write)
- **list_permission_groups**: List all Guide permission groups.
- **create_article**: Create a new article in a section and return the created article with its id. (write)
- **update_article**: Update article metadata only (draft, promoted, labels, tags, visibility, section, sort position, etc.) and return the updated article. (write)
- **reorder_article**: Reorder an article within its current section by moving it relative to its siblings (top, bottom, or before/after another article), and return whether the new order was applied. (write)
- **archive_article**: Archive (soft-delete) a Help Center article: it is removed from the Help Center but can be restored from the Guide admin UI. (write)
- **list_content_tags**: List Guide content tags, which are end-user-visible labels that help readers find related articles.
- **create_content_tag**: Create a new content tag for Guide articles. (write)
- **list_labels**: List all article labels.
- **list_user_segments**: List all user segments.
- **list_article_attachments**: List all attachments for an article.
- **get_article_outline**: Return a compact outline of an article (list of sections delimited by h1/h2/h3, with word counts) for the given locale (defaults to source_locale).
- **get_article_section**: Retrieve the content of a single section of an article in a given locale.
- **update_article_section**: Replace the content of a single section of an article in a given locale, keeping the rest of the body intact. (write)
- **compare_translations**: Compare two locales of the same article to decide whether the target translation needs work, reporting independent signals instead of one ambiguous verdict.
- **create_article_attachment**: Upload a file to a Help Center article and return the created attachment (its id, file name, content type, size and content URL). (write)

One of: search_articles, get_article, list_categories, list_sections, list_articles, list_promoted_articles, list_article_translations, create_article_translation, update_article_translation, list_section_translations, list_category_translations, find_translation_gaps, set_section_translation, set_category_translation, list_permission_groups, create_article, update_article, reorder_article, archive_article, list_content_tags, create_content_tag, list_labels, list_user_segments, list_article_attachments, get_article_outline, get_article_section, update_article_section, compare_translations, create_article_attachment

Operation parameters

Zendesk Help Center

Zendesk Tickets. Specify the operation and its parameters.

Available operations:
- **get_ticket**: Retrieve a Zendesk ticket by ID, including its live SLA state (per-metric stage and breach countdown) when an SLA policy applies, plus its comments if requested.
- **get_ticket_history**: Read a ticket's change history — its audit trail — as a chronological, oldest-first timeline of who changed what and when.
- **get_ticket_attachments**: Retrieve ticket attachments.
- **search_tickets**: Search tickets using Zendesk query syntax, returning each result with its live SLA state (per-metric stage and breach countdown) when an SLA policy applies.
- **create_ticket**: Create a new Zendesk support ticket with subject, description, and optional priority/type/assignee/tags. (write)
- **update_ticket**: Update an existing ticket (status, priority, type, assignee, group, subject, tags, custom fields). (write)
- **add_private_note**: Add an internal note (not visible to requester) to a ticket, optionally with file attachments (uploaded via the Zendesk Uploads API and carried on the note). (write)
- **add_public_comment**: Add a public comment (visible to requester) to a ticket, optionally with file attachments (uploaded via the Zendesk Uploads API and carried on the comment). (write)
- **list_tickets**: List tickets with cursor-based pagination, in Zendesk's default order (ascending ticket id), not by recency.
- **get_linked_incidents**: Get all incident tickets linked to a problem ticket.
- **manage_tags**: Add or remove tags on a ticket. (write)
- **list_sla_policies**: List the configured SLA policies with their filter conditions and per-priority reply/resolution targets.
- **list_ticket_fields**: List the ticket field definitions configured on this Zendesk (both system fields and custom fields), returning each field's id, type, whether it is active/required, and — for dropdown and multiselect fields — the valid option values.
- **list_views**: List the agent's active Zendesk views — the saved ticket queues ("Unassigned tickets", "My open tickets", "Breaching today") the agent sees in the Zendesk UI — each with its current ticket count so you can tell at a glance where the workload sits.
- **get_view_tickets**: Read the tickets inside a Zendesk view, in the view's own configured sort order — the same order the agent sees in the Zendesk UI — which is the natural way to work a named queue like "Unassigned tickets" or "Breaching today".
- **list_macros**: List the active macros available to the authenticated user.
- **preview_macro_diff**: Preview the exact changes a macro would make to a specific ticket, as a before → after diff, WITHOUT saving anything. (write)
- **search**: Search across tickets, users, and organizations.

One of: get_ticket, get_ticket_history, get_ticket_attachments, search_tickets, create_ticket, update_ticket, add_private_note, add_public_comment, list_tickets, get_linked_incidents, manage_tags, list_sla_policies, list_ticket_fields, list_views, get_view_tickets, list_macros, preview_macro_diff, search

Operation parameters

Zendesk Tickets

Zendesk Users. Specify the operation and its parameters.

Available operations:
- **get_current_user**: Get the currently authenticated Zendesk user.
- **search_users**: Search for users by name, email, or other criteria using Zendesk search query syntax.
- **get_user**: Retrieve a single user by their numeric id.
- **get_organization**: Retrieve a single organization by its numeric id.
- **list_organizations**: List all organizations with pagination.

One of: get_current_user, search_users, get_user, get_organization, list_organizations

Operation parameters

Zendesk Users


ActivateBehaviorDefinition

Activate a RAP behavior definition. Use after CreateBehaviorDefinition or UpdateBehaviorDefinition if the object remains inactive.

Behavior definition name (root entity, e.g., ZI_MY_ENTITY).

Session ID from GetSession. If not provided, a new session will be created.

Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.

ActivateClass

Activate an ABAP class. Use after CreateClass or UpdateClass if the object remains inactive.

Class name (e.g., ZCL_MY_CLASS).

ActivateDataElement

Activate an ABAP data element. Use after CreateDataElement or UpdateDataElement if the object remains inactive.

Data element name (e.g., ZDT_MY_ELEMENT).

ActivateDomain

Activate an ABAP domain. Use after CreateDomain or UpdateDomain if the object remains inactive.

Domain name (e.g., ZDM_MY_DOMAIN).

ActivateFunctionGroup

Activate an ABAP function group. Use after CreateFunctionGroup or UpdateFunctionGroup if the object remains inactive.

Function group name (e.g., Z_FG_TEST).

ActivateFunctionModule

Activate an ABAP function module. Use after UpdateFunctionModule if the object remains inactive.

Function group name (e.g., Z_FG_TEST).

Function module name (e.g., Z_FM_TEST).

ActivateInterface

Activate an ABAP interface. Use after CreateInterface or UpdateInterface if the object remains inactive.

Interface name (e.g., ZIF_MY_INTERFACE).

ActivateMetadataExtension

Activate a CDS metadata extension. Use after CreateMetadataExtension or UpdateMetadataExtension if the object remains inactive.

Metadata extension name (e.g., ZC_MY_EXTENSION).

ActivateObjects

Activate one or multiple ABAP repository objects. Use after Create/Update when objects remain inactive, or for group activation of related objects (e.g., domains + data elements + tables together). Works with any object type.

Array of objects to activate. Each object must have 'name' and 'type'.

Object name in uppercase (e.g., ZOK7_D_MTART, ZCL_MY_CLASS)

Object type code: DOMA (domain), DTEL (data element), TABL (table), STRU (structure), DDLS (CDS view), CLAS (class), INTF (interface), PROG (program), FUGR (function group), FUGR/FF (function module), TTYP (table type), SRVD (service definition), SRVB (service binding), BDEF (behavior definition), DDLX (metadata extension), DCLS (access control), ENHO (enhancement)

Request pre-audit before activation. Default: true

ActivateStructure

Activate an ABAP structure. Use after CreateStructure or UpdateStructure if the object remains inactive.

Session ID from GetSession. If not provided, a new session will be created.

Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.

Structure name (e.g., ZST_MY_STRUCTURE).

ActivateTable

Activate an ABAP table. Use after CreateTable or UpdateTable if the object remains inactive.

Table name (e.g., ZTB_MY_TABLE).

ActivateView

Activate a CDS view. Use after CreateView or UpdateView if the object remains inactive.

View name (e.g., ZVW_MY_VIEW).

CreateBehaviorDefinition

Create a new ABAP Behavior Definition (BDEF) in SAP system. Defines RAP business object behavior: CRUD operations, validations, determinations, actions, and draft handling.

Activate after creation. Default: true

Description

Implementation type: 'Managed', 'Unmanaged', 'Abstract', 'Projection'

Behavior Definition name (usually same as Root Entity name)

Package name

Root Entity name (CDS View name)

Transport request number

CreateBehaviorImplementation

Create a new ABAP behavior implementation class for a behavior definition. Creates the object in initial state. Use UpdateBehaviorImplementation to set implementation code afterwards.

Behavior Definition name (e.g., ZI_MY_ENTITY). The behavior definition must exist.

Behavior Implementation class name (e.g., ZBP_MY_ENTITY). Must follow SAP naming conventions (typically starts with ZBP_ for behavior implementations).

Class description. If not provided, class_name will be used.

Package name (e.g., ZOK_LOCAL, $TMP for local objects)

Transport request number (e.g., E19K905635). Required for transportable packages.

CreateCdsUnitTest

Create a CDS unit test class with CDS validation. Creates the test class in initial state.

CDS view name to validate for unit test doubles.

Global test class name (e.g., ZCL_CDS_TEST).

Optional description for the global test class.

Package name (e.g., ZOK_TEST_PKG_01, $TMP).

Transport request number (required for transportable packages).

CreateClass

Create a new ABAP class in SAP system. Creates the class object in initial state. Use UpdateClass to set source code afterwards.

Mark class as abstract. Default: false

Class name (e.g., ZCL_TEST_CLASS_001).

Protected constructor. Default: false

Class description (defaults to class_name).

Mark class as final. Default: false

Package name (e.g., ZOK_LAB, $TMP).

Optional superclass name.

CreateDataElement

Create a new ABAP data element in SAP system with all required steps: create, activate, and verify.

Data element name (e.g., ZZ_E_TEST_001). Must follow SAP naming conventions.

Data type (e.g., CHAR, NUMC) or domain name when type_kind is 'domain'.

Decimal places. Usually inherited from domain.

Data element description. If not provided, data_element_name will be used.

Heading field label (max 55 chars). Applied during update step after creation.

Data type length. Usually inherited from domain.

Long field label (max 40 chars). Applied during update step after creation.

Medium field label (max 20 chars). Applied during update step after creation.

Package name (e.g., ZOK_LOCAL, $TMP for local objects)

Search help name. Applied during update step after creation.

Search help parameter. Applied during update step after creation.

Set/Get parameter ID. Applied during update step after creation.

Short field label (max 10 chars). Applied during update step after creation.

Transport request number (e.g., E19K905635). Required for transportable packages.

Type kind: 'domain' (default), 'predefinedAbapType', 'refToPredefinedAbapType', 'refToDictionaryType', 'refToClifType'. If not specified, defaults to 'domain'.

domain predefinedAbapType refToPredefinedAbapType refToDictionaryType refToClifType

Type name: domain name (when type_kind is 'domain'), data element name (when type_kind is 'refToDictionaryType'), or class name (when type_kind is 'refToClifType')

CreateDomain

Create a new ABAP domain in SAP system with all required steps: lock, create, check, unlock, activate, and verify.

(optional) Activate domain after creation (default: true)

(optional) Conversion exit routine name (without CONVERSION_EXIT_ prefix)

(optional) Data type: CHAR, NUMC, DATS, TIMS, DEC, INT1, INT2, INT4, INT8, CURR, QUAN, etc.

(optional) Decimal places (for DEC, CURR, QUAN types)

(optional) Domain description. If not provided, domain_name will be used.

Domain name (e.g., ZZ_TEST_0001). Must follow SAP naming conventions.

(optional) Array of fixed values for domain value range

Fixed value (e.g., '001', 'A')

Description text for the fixed value

(optional) Field length (max depends on datatype)

(optional) Allow lowercase input

(optional) Package name (e.g., ZOK_LOCAL, $TMP for local objects)

(optional) Field has sign (+/-)

(optional) Transport request number (e.g., E19K905635). Required for transportable packages.

(optional) Value table name for foreign key relationship

CreateFunctionGroup

Create a new ABAP function group in SAP system. Function groups serve as containers for function modules. Uses stateful session for proper lock management.

Activate function group after creation. Default: true. Set to false for batch operations.

Function group description. If not provided, function_group_name will be used.

Function group name (e.g., ZTEST_FG_001). Must follow SAP naming conventions (start with Z or Y, max 26 chars).

Package name (e.g., ZOK_LAB, $TMP for local objects)

Transport request number (e.g., E19K905635). Required for transportable packages.

CreateFunctionModule

Create a new ABAP function module within an existing function group. Creates the function module in initial state. Use UpdateFunctionModule to set source code afterwards.

Optional description for the function module

Parent function group name (e.g., ZTEST_FG_001)

Function module name (e.g., Z_TEST_FUNCTION_001). Must follow SAP naming conventions (start with Z or Y, max 30 chars).

CreateInterface

Create a new ABAP interface in SAP system. Creates the interface object in initial state. Use UpdateInterface to set source code afterwards.

Interface description. If not provided, interface_name will be used.

Interface name (e.g., ZIF_TEST_INTERFACE_001). Must follow SAP naming conventions (start with Z or Y).

CreateMetadataExtension

Create a new ABAP Metadata Extension (DDLX) in SAP system. Defines Fiori UI annotations, field labels, search help, and list/object page layout for CDS views.

Activate after creation. Default: true

Description

Metadata Extension name

Package name

Transport request number

CreatePackage

Create a new ABAP package in SAP system. Packages are containers for development objects and are essential for organizing code.

Application component (optional, e.g., BC-ABA)

Package description. If not provided, package_name will be used.

Package name (e.g., ZOK_TEST_0002). Must follow SAP naming conventions (start with Z or Y for customer namespace).

Package type: 'development' (default) or 'structure'

Enable change recording for the package. Required for transportable packages. Default: false.

Software component (e.g., HOME, ZLOCAL). If not provided, SAP will set a default (typically ZLOCAL for local packages).

Parent package name (e.g., ZOK_PACKAGE). Required for structure packages.

Transport layer (e.g., ZE19). Required for transportable packages.

Transport request number (e.g., E19K905635). Required if package is transportable.

CreateServiceBinding

Create ABAP service binding via ADT Business Services endpoint. XML is generated from high-level parameters.

Activate service binding after create. Default: true.

OData binding type.

Optional description. Defaults to service_binding_name when omitted.

ABAP package name.

Service binding name.

Service binding ADT version. Default inferred from type.

Referenced service definition name.

Published service name. Default: service_binding_name if omitted.

Published service version. Default: 0001.

Optional transport request for transport checks.

CreateServiceDefinition

Create a new ABAP service definition for OData services. Service definitions define the structure and behavior of OData services. Uses stateful session for proper lock management.

Activate service definition after creation. Default: true.

Service definition description. If not provided, service_definition_name will be used.

Package name (e.g., ZOK_LOCAL, $TMP for local objects)

Service definition name (e.g., ZSD_MY_SERVICE). Must follow SAP naming conventions (start with Z or Y).

Service definition source code (optional). If not provided, a minimal template will be created.

Transport request number (e.g., E19K905635). Required for transportable packages.

CreateStructure

Create a new ABAP structure in SAP system with fields and type references. Includes create, activate, and verify steps.

Activate structure after creation. Default: true. Set to false for batch operations (activate multiple objects later).

Structure description. If not provided, structure_name will be used.

Array of structure fields

Data element name for type reference (optional)

Data type: CHAR, NUMC, DATS, TIMS, DEC, INT1, INT2, INT4, INT8, CURR, QUAN, etc.

Decimal places (for DEC, CURR, QUAN types)

Field description

Domain name for type reference (optional)

Field length

Field name (e.g., CLIENT, MATERIAL_ID)

Include another structure (optional)

Reference to table type (optional)

Include other structures in this structure

Include structure name

Optional suffix for include fields

Structure name (e.g., ZZ_S_TEST_001). Must follow SAP naming conventions.

CreateTable

Create a new ABAP table via the ADT API. Creates the table object in initial state. Use UpdateTable to set DDL code afterwards.

Table description for validation and creation.

Table name (e.g., ZZ_TEST_TABLE_001). Must follow SAP naming conventions.

CreateTransport

Create a new ABAP transport request in SAP system for development objects.

Transport request description (mandatory)

Transport owner (optional, defaults to current user)

Target system for transport (optional, e.g., 'PRD', 'QAS'). If not provided or empty, uses 'LOCAL'

Transport type: 'workbench' (cross-client) or 'customizing' (client-specific)

CreateUnitTest

Start an ABAP Unit test run for provided class test definitions. Returns run_id for status/result queries.

Optional context string shown in SAP tools.

List of container/test class pairs to execute.

Class that owns the test include (e.g., ZCL_MAIN_CLASS).

Test class name inside the include (e.g., LTCL_MAIN_CLASS).

Optional title for the ABAP Unit run.

CreateView

Create CDS View or Classic View in SAP. Creates the view object in initial state. Use UpdateView to set DDL source code afterwards.

Optional description (defaults to view_name).

Package name (e.g., ZOK_LAB, $TMP for local objects)

Transport request number (required for transportable packages).

View name (e.g., ZOK_R_TEST_0002, Z_I_MY_VIEW).

DeleteBehaviorDefinition

Delete an ABAP behavior definition from the SAP system. Includes deletion check before actual deletion. Transport request optional for $TMP objects.

BehaviorDefinition name (e.g., Z_MY_BEHAVIORDEFINITION).

Transport request number (e.g., E19K905635). Required for transportable objects. Optional for local objects ($TMP).

DeleteBehaviorImplementation

Delete an ABAP behavior implementation from the SAP system. Includes deletion check before actual deletion. Transport request optional for $TMP objects.

BehaviorImplementation name (e.g., Z_MY_BEHAVIORIMPLEMENTATION).

DeleteCdsUnitTest

Delete a CDS unit test class (global class).

Global test class name (e.g., ZCL_CDS_TEST).

DeleteClass

Delete an ABAP class from the SAP system. Includes deletion check before actual deletion. Transport request optional for $TMP objects.

Class name (e.g., ZCL_MY_CLASS).

DeleteDataElement

Delete an ABAP data element from the SAP system. Includes deletion check before actual deletion. Transport request optional for $TMP objects.

Data element name (e.g., Z_MY_DATA_ELEMENT).

DeleteDomain

Delete an ABAP domain from the SAP system. Includes deletion check before actual deletion. Transport request optional for $TMP objects.

Domain name (e.g., Z_MY_DOMAIN).

DeleteFunctionGroup

Delete an ABAP function group from the SAP system. Includes deletion check before actual deletion. Transport request optional for $TMP objects.

FunctionGroup name (e.g., Z_MY_FUNCTIONGROUP).

DeleteFunctionModule

Delete an ABAP function module from the SAP system. Includes deletion check before actual deletion. Transport request optional for $TMP objects.

FunctionGroup name containing the function module (e.g., Z_MY_FUNCTIONGROUP).

FunctionModule name (e.g., Z_MY_FUNCTIONMODULE).

DeleteInterface

Delete an ABAP interface from the SAP system. Includes deletion check before actual deletion. Transport request optional for $TMP objects.

Interface name (e.g., Z_MY_INTERFACE).

DeleteLocalDefinitions

Delete local definitions from an ABAP class by clearing the definitions include. Manages lock, update, unlock, and optional activation.

Activate parent class after deleting. Default: false

Parent class name (e.g., ZCL_MY_CLASS).

Transport request number.

DeleteLocalMacros

Delete local macros from an ABAP class by clearing the macros include. Manages lock, update, unlock, and optional activation. Note: Macros are supported in older ABAP versions but not in newer ones.

Parent class name (e.g., ZCL_MY_CLASS).

Transport request number.

DeleteLocalTestClass

Delete a local test class from an ABAP class by clearing the testclasses include. Manages lock, update, unlock, and optional activation of parent class.

Activate parent class after deleting test class. Default: false

Parent class name (e.g., ZCL_MY_CLASS).

Transport request number (required for transportable objects).

DeleteLocalTypes

Delete local types from an ABAP class by clearing the implementations include. Manages lock, update, unlock, and optional activation.

Parent class name (e.g., ZCL_MY_CLASS).

Transport request number.

DeleteMetadataExtension

Delete an ABAP metadata extension from the SAP system. Includes deletion check before actual deletion. Transport request optional for $TMP objects.

MetadataExtension name (e.g., Z_MY_METADATAEXTENSION).

Transport request number (e.g., E19K905635). Required for transportable objects. Optional for local objects ($TMP).

DeleteServiceBinding

Delete ABAP service binding via ADT Business Services endpoint.

Service binding name to delete.

Optional transport request for deletion transport flow.

DeleteServiceDefinition

Delete an ABAP service definition from the SAP system. Includes deletion check before actual deletion. Transport request optional for $TMP objects.

ServiceDefinition name (e.g., Z_MY_SERVICEDEFINITION).

DeleteStructure

Delete an ABAP structure from the SAP system. Includes deletion check before actual deletion. Transport request optional for $TMP objects.

Structure name (e.g., Z_MY_STRUCTURE).

DeleteTable

Delete an ABAP table from the SAP system. Includes deletion check before actual deletion. Transport request optional for $TMP objects.

Table name (e.g., Z_MY_TABLE).

DeleteUnitTest

Delete an ABAP Unit test run. Note: ADT does not support deleting unit test runs and will return an error.

Run identifier returned by CreateUnitTest/RunUnitTest.

DeleteView

Delete an ABAP view from the SAP system. Includes deletion check before actual deletion. Transport request optional for $TMP objects.

View name (e.g., Z_MY_VIEW).

DescribeByList

[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.

[read-only] Object name (required, must be valid ABAP object name or mask)

[read-only] Optional type (e.g. PROG/P, CLAS/OC, etc.)

GetAbapAST

[read-only] Parse ABAP code and return AST (Abstract Syntax Tree) in JSON format.

ABAP source code to parse

Optional file path to write the result to

GetAbapSemanticAnalysis

[read-only] Perform semantic analysis on ABAP code and return symbols, types, scopes, and dependencies.

ABAP source code to analyze

GetAbapSystemSymbols

[read-only] Resolve ABAP symbols from semantic analysis with SAP system information including types, scopes, descriptions, and packages.

ABAP source code to analyze and resolve symbols for

GetAdtTypes

[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.

Type name to validate (optional)

GetBehaviorDefinition

Retrieve ABAP behavior definition definition. Supports reading active or inactive version.

BehaviorDefinition name (e.g., Z_MY_BEHAVIORDEFINITION).

Version to read: "active" (default) for deployed version, "inactive" for modified but not activated version.

GetBehaviorImplementation

Retrieve ABAP behavior implementation definition. Supports reading active or inactive version.

BehaviorImplementation name (e.g., Z_MY_BEHAVIORIMPLEMENTATION).

GetCdsUnitTest

Retrieve CDS unit test run status and result for a previously started run_id.

Run identifier returned by unit test run.

GetCdsUnitTestResult

Retrieve CDS unit test run result for a run_id.

Result format: abapunit or junit.

Include navigation URIs in result if supported.

GetCdsUnitTestStatus

Retrieve CDS unit test run status for a run_id.

Enable long polling while waiting for status.

GetClass

Retrieve ABAP class source code. Supports reading active or inactive version.

Class name (e.g., ZCL_MY_CLASS).

GetDataElement

Retrieve ABAP data element definition. Supports reading active or inactive version.

Data element name (e.g., Z_MY_DATA_ELEMENT).

GetDomain

Retrieve ABAP domain definition. Supports reading active or inactive version.

Domain name (e.g., Z_MY_DOMAIN).

GetEnhancementImpl

[read-only] Retrieve source code of a specific enhancement implementation by its name and enhancement spot.

[read-only] Name of the enhancement implementation

Name of the enhancement spot

GetEnhancementSpot

[read-only] Retrieve metadata and list of implementations for a specific enhancement spot.

Name of the enhancement spot

GetEnhancements

[read-only] Retrieve a list of enhancements for a given ABAP object.

Name of the ABAP object

[read-only] Type of the ABAP object

GetFunctionGroup

Retrieve ABAP function group definition. Supports reading active or inactive version.

FunctionGroup name (e.g., Z_MY_FUNCTIONGROUP).

Version to read: "active" (default) for deployed version, "inactive" for modified but not activated version.

GetFunctionModule

Retrieve ABAP function module definition. Supports reading active or inactive version.

FunctionGroup name containing the function module (e.g., Z_MY_FUNCTIONGROUP).

FunctionModule name (e.g., Z_MY_FUNCTIONMODULE).

GetInactiveObjects

[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.

GetInclude

[read-only] Retrieve source code of a specific ABAP include file.

Name of the ABAP Include

GetIncludesList

[read-only] Recursively discover and list ALL include files within an ABAP program or include.

[read-only] If true, returns structured JSON with metadata and raw XML.

Name of the ABAP program or include

[read-only] ADT object type (e.g. PROG/P, PROG/I, FUGR, CLAS/OC)

[read-only] Timeout in ms for each ADT request.

GetInterface

Retrieve ABAP interface definition. Supports reading active or inactive version.

Interface name (e.g., Z_MY_INTERFACE).

GetLocalDefinitions

Retrieve local definitions source code from a class (definitions include). Supports reading active or inactive version.

Parent class name (e.g., ZCL_MY_CLASS).

GetLocalMacros

Retrieve local macros source code from a class (macros include). Supports reading active or inactive version. Note: Macros are supported in older ABAP versions but not in newer ones.

Parent class name (e.g., ZCL_MY_CLASS).

GetLocalTestClass

Retrieve local test class source code from a class. Supports reading active or inactive version.

Parent class name (e.g., ZCL_MY_CLASS).

GetLocalTypes

Retrieve local types source code from a class (implementations include). Supports reading active or inactive version.

Parent class name (e.g., ZCL_MY_CLASS).

GetMetadataExtension

Retrieve ABAP metadata extension definition. Supports reading active or inactive version.

MetadataExtension name (e.g., Z_MY_METADATAEXTENSION).

Version to read: "active" (default) for deployed version, "inactive" for modified but not activated version.

GetNodeStructureLow

[low-level] Fetch node structure from ADT repository. Used for object tree navigation and structure discovery. Can use session_id and session_state from GetSession to maintain the same session.

Optional node ID (default: "0000" for root). Use to fetch child nodes.

Parent object name

Parent object type (e.g., "CLAS/OC", "PROG/P", "DEVC/K")

Session ID from GetSession. If not provided, a new session will be created.

Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.

Include short descriptions in response

GetObjectInfo

[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.

[read-only] Whether to add description and package via SearchObject (default true)

[read-only] Maximum tree depth (default depends on type)

[read-only] Parent object name

[read-only] Parent object type (e.g. DEVC/K, CLAS/OC, PROG/P)

GetObjectNodeFromCache

[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.

[read-only] Object name

[read-only] Object type

[read-only] Technical name

GetObjectStructure

[read-only] Retrieve ADT object structure as a compact JSON tree.

ADT object name (e.g. /CBY/ACQ_DDL)

ADT object type (e.g. DDLS/DF)

GetObjectStructureLow

[low-level] Retrieve ADT object structure as compact JSON tree. Returns XML response with object structure tree. Can use session_id and session_state from GetSession to maintain the same session.

Object name (e.g., "ZMY_CLASS", "ZMY_PROGRAM")

Object type (e.g., "CLAS/OC", "PROG/P", "DEVC/K", "DDLS/DF")

GetObjectsByType

[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.

[read-only] Output format: 'raw' or 'parsed'

[read-only] Node ID

[read-only] Parent object name

[read-only] Parent technical name

[read-only] Parent object type

[read-only] Include short descriptions

GetObjectsList

[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.

[read-only] Parent object name

[read-only] Parent technical name

[read-only] Parent object type (e.g. PROG/P, FUGR)

[read-only] Include short descriptions (default: true)

GetPackage

Retrieve ABAP package metadata (description, super-package, etc.). Supports reading active or inactive version.

Package name (e.g., Z_MY_PACKAGE).

Version to read: "active" (default) for deployed version, "inactive" for modified but not activated version.

GetPackageContents

[read-only] Retrieve objects inside an ABAP package as a flat list. Supports recursive traversal of subpackages.

Include object descriptions in response (default: true)

Include contents of subpackages recursively (default: false)

Maximum depth for recursive package traversal (default: 5)

Name of the ABAP package (e.g., "ZMY_PACKAGE")

GetPackageTree

[high-level] Retrieve complete package tree structure including subpackages and objects. Returns hierarchical tree with object names, types, and descriptions.

Include diagnostic metadata in response (counts, types, hierarchy info). Default: false

Include object descriptions in response. Default: true

Include subpackages recursively in the tree. If false, subpackages are shown as first-level objects but not recursively expanded. Default: true

Maximum depth for recursive package traversal. Default: 5

Package name (e.g., "ZMY_PACKAGE")

GetServiceBinding

Retrieve ABAP service binding source/metadata by name via ADT Business Services endpoint.

Preferred response format. "json" requests JSON from endpoint, "xml" parses XML payload, "plain" returns raw text.

Service binding name (for example: ZUI_MY_BINDING). Case-insensitive.

GetServiceDefinition

Retrieve ABAP service definition definition. Supports reading active or inactive version.

ServiceDefinition name (e.g., Z_MY_SERVICEDEFINITION).

GetSession

[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.

Force creation of a new session even if one exists. Default: false

GetSqlQuery

[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.

[read-only] Maximum number of rows to return

SQL query to execute

GetStructure

Retrieve ABAP structure definition. Supports reading active or inactive version.

Structure name (e.g., Z_MY_STRUCTURE).

Version to read: "active" (default) for deployed version, "inactive" for modified but not activated version.

GetTable

Retrieve ABAP table definition. Supports reading active or inactive version.

Table name (e.g., Z_MY_TABLE).

GetTableContents

[read-only] Retrieve contents (data preview) of an ABAP database table or CDS view. Returns rows of data like SE16/SE16N.

Maximum number of rows to retrieve

Name of the ABAP table

GetTransaction

[read-only] Retrieve ABAP transaction (t-code) details — program, screen, authorization object, and transaction type (dialog, report, OO).

Name of the ABAP transaction

GetTransport

[read-only] Retrieve ABAP transport request information including metadata, included objects, and status from SAP system.

Include list of objects in transport (default: true)

Include list of tasks in transport (default: true)

Transport request number (e.g., E19K905635, DEVK905123)

GetTypeInfo

[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.

When true (default), tries DDIC structure lookup only if type lookup returns 404/empty.

Name of the ABAP type

GetUnitTest

Retrieve ABAP Unit test run status and result for a previously started run_id.

Run identifier returned by RunUnitTest.

GetUnitTestResult

Retrieve ABAP Unit test run result for a run_id.

Result format: abapunit or junit.

Run identifier returned by unit test run.

Include navigation URIs in result if supported.

GetUnitTestStatus

Retrieve ABAP Unit test run status for a run_id.

Enable long polling while waiting for status.

GetView

Retrieve ABAP view definition. Supports reading active or inactive version.

Version to read: "active" (default) for deployed version, "inactive" for modified but not activated version.

View name (e.g., Z_MY_VIEW).

GetVirtualFoldersLow

[low-level] Retrieve hierarchical virtual folder contents from ADT information system. Used for browsing ABAP objects by package, group, type, etc.

Order of facets in response (e.g., ["package", "group", "type"]). Default: ["package", "group", "type"]

Ignore short descriptions in response

Object search pattern (e.g., "*", "Z*", "ZCL_*"). Default: "*"

Optional preselection filters (facet-value pairs for filtering)

Facet name (e.g., "package", "group", "type")

Array of facet values to filter by

Include version information in response

GetWhereUsed

[read-only] Search where-used references — find all objects that reference or depend on a given ABAP object. Answers: "where is X used", "who calls X", "what depends on X", "show usages of X". Supports classes, interfaces, tables, data elements, programs, function modules, etc. Returns referencing objects with types and packages.

If true, searches in all available object types (Eclipse 'select all' behavior). Default: false (uses SAP default scope)

Name of the ABAP object

Type of the ABAP object (class, interface, program, table, etc.)

ListServiceBindingTypes

List available service binding types (for example ODataV2/ODataV4) from ADT Business Services endpoint.

ListTransports

[read-only] List transport requests for the current or specified user. Returns modifiable and/or released workbench and customizing requests.

Only return modifiable (not yet released) transports. Default: true.

SAP user name. If not provided, returns transports for the current user.

ReadBehaviorDefinition

[read-only] Read ABAP RAP behavior definition (BDEF) source code and metadata. Answers: "show behavior definition", "display BDEF source", "view RAP behavior X", "get behavior definition code". Returns source code, package, responsible, description.

Behavior definition name (e.g., Z_MY_BDEF).

Version to read: "active" (default) or "inactive".

ReadBehaviorImplementation

[read-only] Read ABAP RAP behavior implementation source code and metadata. Answers: "show behavior implementation", "display behavior pool code", "view RAP implementation X". Returns source code, package, responsible, description.

Behavior implementation name (e.g., ZBP_MY_CLASS).

ReadClass

[read-only] Read ABAP class source code and metadata. Answers: "show class code", "display class source", "view class definition/implementation", "get class X". Returns source code, package, responsible, description.

Class name (e.g., ZCL_MY_CLASS).

ReadDataElement

[read-only] Read ABAP data element definition and metadata. Answers: "show data element X", "display data element properties", "view DTEL definition", "get data element type". Returns definition, domain, package, responsible, description.

Data element name (e.g., Z_MY_DATA_ELEMENT).

ReadDomain

[read-only] Read ABAP domain definition and metadata. Answers: "show domain X", "display domain fixed values", "view domain definition", "get domain properties". Returns definition, fixed values, package, responsible, description.

Domain name (e.g., Z_MY_DOMAIN).

ReadFunctionGroup

[read-only] Read ABAP function group source code and metadata. Answers: "show function group code", "display FUGR source", "view function group X", "get function group includes". Returns source code, package, responsible, description.

Function group name (e.g., Z_MY_FG).

ReadFunctionModule

[read-only] Read ABAP function module source code and metadata. Answers: "show function module code", "display FM source", "view function X", "get function module implementation". Returns source code, package, responsible, description.

Function group name containing the function module (e.g., Z_MY_FG).

Function module name (e.g., Z_MY_FM).

ReadInterface

[read-only] Read ABAP interface source code and metadata. Answers: "show interface code", "display interface definition", "view interface X", "get interface source". Returns source code, package, responsible, description.

Interface name (e.g., ZIF_MY_INTERFACE).

ReadMetadataExtension

[read-only] Read ABAP metadata extension (DDLX) source code and metadata. Answers: "show metadata extension", "display DDLX source", "view UI annotations", "get metadata extension X". Returns source code, package, responsible, description.

Metadata extension name (e.g., Z_MY_DDLX).

ReadPackage

[read-only] Read ABAP package definition and metadata. Answers: "show package X", "display package properties", "view package contents", "get package info". Returns definition, super-package, responsible, description.

Package name (e.g., Z_MY_PACKAGE).

ReadServiceBinding

[read-only] Read ABAP service binding (SRVB) payload and metadata. Answers: "show service binding", "display SRVB config", "view service binding X", "get OData service binding". Returns payload, package, responsible, description.

Service binding name (e.g., ZUI_MY_BINDING).

ReadServiceDefinition

[read-only] Read ABAP service definition (SRVD) source code and metadata. Answers: "show service definition", "display SRVD source", "view service definition X", "get service exposure". Returns source code, package, responsible, description.

Service definition name (e.g., Z_MY_SRVD).

Version to read: "active" (default) or "inactive".

ReadStructure

[read-only] Read ABAP structure definition and metadata. Answers: "show structure fields", "display structure X", "view structure definition", "get structure components". Returns field list, package, responsible, description.

Structure name (e.g., Z_MY_STRUCTURE).

ReadTable

[read-only] Read ABAP table definition and metadata. Answers: "show table fields", "display table structure", "view table X", "get table definition". Returns field list, package, responsible, description.

Table name (e.g., Z_MY_TABLE).

ReadView

[read-only] Read ABAP CDS view source code and metadata. Answers: "show CDS view source", "display view definition", "view CDS X", "get CDS code". Returns source code, package, responsible, description.

View name (e.g., Z_MY_VIEW).

RunUnitTest

Start an ABAP Unit test run for provided class test definitions. Returns run_id for status/result queries.

Optional context string shown in SAP tools.

List of container/test class pairs to execute.

Class that owns the test include (e.g., ZCL_MAIN_CLASS).

Test class name inside the include (e.g., LTCL_MAIN_CLASS).

Optional title for the ABAP Unit run.

RuntimeAnalyzeProfilerTrace

[runtime] Read profiler trace view and return compact analysis summary (totals + top entries).

Number of top rows for summary. Default: 10.

Profiler trace ID or full trace URI.

Include system events.

RuntimeCreateProfilerTraceParameters

[runtime] Create ABAP profiler trace parameters and return profilerId (URI) for profiled execution.

Human-readable trace description.

RuntimeGetDumpById

[runtime] Read a specific ABAP runtime dump. Identify the dump by datetime + user (preferred, e.g. from a CALM event), or pass dump_id directly if already known. Use response_mode to control output detail level.

Dump datetime (ISO or "YYYY-MM-DD HH:MM:SS"). Combined with user, uniquely identifies the dump. Preferred over dump_id.

Full runtime dump ID. Use only when already known; prefer datetime + user otherwise.

Controls what is returned: "payload" — full parsed dump data, "summary" — compact key facts only (title, exception, program, line, user, date…), "both" — summary + full payload.

SAP username whose dump to read. Required when using datetime lookup.

Dump view mode: default payload, summary section, or formatted long text.

RuntimeGetProfilerTraceData

[runtime] Read profiler trace data by trace id/uri: hitlist, statements, or db accesses. Returns parsed JSON payload.

Auto drill-down threshold (for statements view).

Statement node ID (for statements view).

Profiler trace ID or full ADT trace URI.

Trace view to retrieve.

Include statement details (for statements view).

Include system events.

RuntimeListDumps

[runtime] List ABAP runtime dumps with optional user filter and paging. Returns structured list with dump_id, datetime, error type, title, and user.

Start of time range in YYYYMMDDHHMMSS format (system local time). Narrows results to dumps on or after this datetime.

Include total count metadata.

ADT order by expression.

Number of records to skip.

End of time range in YYYYMMDDHHMMSS format (system local time). Narrows results to dumps on or before this datetime.

Maximum number of records to return.

Optional username filter. If omitted, dumps for all users are returned.

RuntimeListFeeds

[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.

Feed to read. "descriptors" lists available feeds, "variants" lists feed variants, others read that specific feed. Default: descriptors.

Start of time range in YYYYMMDDHHMMSS format.

Maximum number of entries to return.

End of time range in YYYYMMDDHHMMSS format.

Filter feed entries by SAP username.

RuntimeListProfilerTraceFiles

[runtime] List ABAP profiler trace files available in ADT runtime. Returns parsed JSON payload.

RuntimeListSystemMessages

[runtime] List SM02 system messages. Returns structured entries with id, title, text, severity, validity period, and author.

Maximum number of messages to return.

Filter by author username.

RuntimeRunClassWithProfiling

[runtime] Execute ABAP class with profiler enabled and return created profilerId + traceId.

ABAP class name to execute.

Profiler trace description.

SearchObject

[read-only] Search ABAP repository by object name or wildcard pattern (e.g. 'ZOK*'). Answers: "find object X", "does X exist", "list objects matching...", "search for program/class/table by name". Supports all repository object types — optionally filter by type (PROG, CLAS, INTF, DEVC, TABL, DDLS, DTEL, FUGR, SRVD, SRVB, BDEF, DDLX, etc.).

[read-only] Maximum number of results to return

[read-only] Object name or mask (e.g. 'MARA*')

[read-only] Optional ABAP object type (e.g. 'TABL', 'CLAS/OC')

UpdateBehaviorDefinition

Update source code of an ABAP Behavior Definition (BDEF). Modifies RAP business object behavior: CRUD operations, validations, determinations, actions, and draft handling.

Activate after update. Default: true

Lock handle from LockObject. If not provided, will attempt to lock internally (not recommended for stateful flows).

Behavior Definition name

New source code

Transport request number (e.g., E19K905635). Required for transportable packages.

UpdateBehaviorImplementation

Update source code of an existing ABAP behavior implementation class. Updates both main source (with FOR BEHAVIOR OF clause) and implementations include. Uses stateful session with proper lock/unlock mechanism.

Activate behavior implementation after update. Default: true.

Behavior Definition name (e.g., ZI_MY_ENTITY). Must match the behavior definition used when creating the class.

Behavior Implementation class name (e.g., ZBP_MY_ENTITY). Must exist in the system.

Implementation code for the implementations include. Contains the actual behavior implementation methods.

Transport request number (e.g., E19K905635). Optional if object is local or already in transport.

UpdateCdsUnitTest

Update a CDS unit test class local test class source code.

Global test class name (e.g., ZCL_CDS_TEST).

Updated local test class ABAP source code.

Transport request number (required for transportable packages).

UpdateClass

Update source code of an existing ABAP class. Locks, checks, updates, unlocks, and optionally activates.

Activate after update. Default: false.

Class name (e.g., ZCL_TEST_CLASS_001).

Complete ABAP class source code.

UpdateDataElement

Update an existing ABAP data element in SAP system.

Workflow:
1. Gets domain info (if type_kind is 'domain') to extract dataType/length/decimals
2. Acquires lock on the data element
3. Updates data element with provided parameters (complete replacement)
4. Unlocks data element
5. Optionally activates data element (default: true)
6. Returns updated data element details

Supported type_kind values:
- domain: Based on ABAP domain (requires type_name = domain name)
- predefinedAbapType: Direct ABAP type (requires data_type, length, decimals)
- refToPredefinedAbapType: Reference to ABAP type (requires data_type, length, decimals)
- refToDictionaryType: Reference to another data element (requires type_name = data element name)
- refToClifType: Reference to class (requires type_name = class name)

Note: All provided parameters completely replace existing values. Field labels are truncated to max lengths (10/20/40/55).

Activate data element after update (default: true)

Data element name to update (e.g., ZZ_TEST_DTEL_01)

Data type (CHAR, NUMC, etc.) - for predefinedAbapType or refToPredefinedAbapType

Decimals - for predefinedAbapType or refToPredefinedAbapType

New data element description

Heading field label (max 55 chars)

Long field label (max 40 chars)

Medium field label (max 20 chars)

Short field label (max 10 chars)

Length - for predefinedAbapType or refToPredefinedAbapType

Package name (e.g., ZOK_LOCAL, $TMP for local objects)

Search help name

Search help parameter

Set/Get parameter ID

Transport request number (e.g., E19K905635). Required for transportable packages.

Type kind: domain, predefinedAbapType, refToPredefinedAbapType, refToDictionaryType, refToClifType

Type name: domain name, data element name, or class name (depending on type_kind)

UpdateDomain

Update an existing ABAP domain in SAP system.

Workflow:
1. Acquires lock on the domain
2. Updates domain with provided parameters (complete replacement)
3. Performs syntax check
4. Unlocks domain
5. Optionally activates domain (default: true)
6. Returns updated domain details

Note: All provided parameters completely replace existing values. Use GetDomain first to see current values if needed.

Activate domain after update (default: true)

Conversion exit routine name (without CONVERSION_EXIT_ prefix)

Data type: CHAR, NUMC, DATS, TIMS, DEC, INT1, INT2, INT4, INT8, CURR, QUAN, etc.

Decimal places (for DEC, CURR, QUAN types)

New domain description (optional)

Domain name to update (e.g., ZZ_TEST_0001)

Array of fixed values for domain value range

Fixed value (e.g., '001', 'A')

Description text for the fixed value

Field length (max depends on datatype)

Allow lowercase input

Field has sign (+/-)

Value table name for foreign key relationship

UpdateFunctionGroup

Update metadata (description) of an existing ABAP function group. Function groups are containers for function modules and don't have source code to update directly. Uses stateful session with proper lock/unlock mechanism.

New description for the function group.

Function group name (e.g., ZTEST_FG_001). Must exist in the system.

Transport request number (e.g., E19K905635). Optional if object is local or already in transport.

UpdateFunctionModule

Update source code of an existing ABAP function module. Locks the function module, uploads new source code, and unlocks. Optionally activates after update. Use this to modify existing function modules without re-creating metadata.

Activate function module after source update. Default: false. Set to true to activate immediately.

Function group name containing the function module (e.g., ZOK_FG_MCP01).

Function module name (e.g., Z_TEST_FM_MCP01). Function module must already exist.

Complete ABAP function module source code. Must include FUNCTION statement with parameters and ENDFUNCTION. Example:

FUNCTION Z_TEST_FM
  IMPORTING
    VALUE(iv_input) TYPE string
  EXPORTING
    VALUE(ev_output) TYPE string.

  ev_output = iv_input.
ENDFUNCTION.

Transport request number (e.g., E19K905635). Required for transportable function modules.

UpdateInterface

Update source code of an existing ABAP interface. Uses stateful session with proper lock/unlock mechanism. Lock handle and transport number are passed in URL parameters.

Activate interface after update. Default: true.

Interface name (e.g., ZIF_MY_INTERFACE). Must exist in the system.

Complete ABAP interface source code with INTERFACE...ENDINTERFACE section.

UpdateLocalDefinitions

Update local definitions in an ABAP class (definitions include). Manages lock, check, update, unlock, and optional activation.

Activate parent class after updating. Default: false

Parent class name (e.g., ZCL_MY_CLASS).

Updated source code for local definitions.

Transport request number.

UpdateLocalMacros

Update local macros in an ABAP class (macros include). Manages lock, check, update, unlock, and optional activation. Note: Macros are supported in older ABAP versions but not in newer ones.

Parent class name (e.g., ZCL_MY_CLASS).

Updated source code for local macros.

Transport request number.

UpdateLocalTestClass

Update a local test class in an ABAP class. Manages lock, check, update, unlock, and optional activation of parent class.

Activate parent class after updating test class. Default: false

Parent class name (e.g., ZCL_MY_CLASS).

Updated source code for the local test class.

Transport request number (required for transportable objects).

UpdateLocalTypes

Update local types in an ABAP class (implementations include). Manages lock, check, update, unlock, and optional activation.

Parent class name (e.g., ZCL_MY_CLASS).

Updated source code for local types.

Transport request number.

UpdateMetadataExtension

Update source code of an ABAP Metadata Extension (DDLX). Modifies Fiori UI annotations, field labels, search help, and list/object page layout for CDS views.

Activate after update. Default: true

Lock handle from LockObject. If not provided, will attempt to lock internally.

Metadata Extension name

New source code

Transport request number (required for transportable packages).

UpdateServiceBinding

Update publication state for ABAP service binding via AdtServiceBinding workflow.

Target publication state.

Service binding name to update.

Published service name.

OData service type for publish/unpublish action routing.

Published service version. Optional.

UpdateServiceDefinition

Update source code of an existing ABAP service definition. Uses stateful session with proper lock/unlock mechanism.

Activate service definition after update. Default: true.

Service definition name (e.g., ZSD_MY_SERVICE). Must exist in the system.

Complete service definition source code.

Transport request number (e.g., E19K905635). Optional if object is local or already in transport.

UpdateStructure

Update DDL source code of an existing ABAP structure. Locks the structure, uploads new DDL source, and unlocks. Optionally activates after update. Use this to modify existing structures without re-creating metadata.

Activate structure after source update. Default: true.

Complete DDL source code for structure. Example: '@EndUserText.label : \'My Structure\' @AbapCatalog.tableCategory : #TRANSPARENT define structure zz_s_test_001 { client : abap.clnt not null; id : abap.char(10); name : abap.char(255); }'

Structure name (e.g., ZZ_S_TEST_001). Structure must already exist.

UpdateTable

Update DDL source code of an existing ABAP table. Locks the table, uploads new DDL source, and unlocks. Optionally activates after update. Use this to modify existing tables without re-creating metadata.

Activate table after source update. Default: true.

Complete DDL source code for table. Example: '@EndUserText.label : \'My Table\' @AbapCatalog.tableCategory : #TRANSPARENT define table ztst_table { key client : abap.clnt not null; key id : abap.char(10); name : abap.char(255); }'

Table name (e.g., ZZ_TEST_TABLE_001). Table must already exist.

UpdateUnitTest

Update an ABAP Unit test run. Note: ADT does not support updating unit test runs and will return an error.

Run identifier returned by CreateUnitTest/RunUnitTest.

UpdateView

Update DDL source code of an existing CDS View or Classic View. Locks the view, checks new code, uploads new DDL source, unlocks, and optionally activates.

Activate after update. Default: false.

Complete DDL source code.

Transport request number (e.g., E19K905635). Required for transportable packages.

View name (e.g., ZOK_R_TEST_0002).

ValidateServiceBinding

Validate service binding parameters (name, service definition, package, version) via ADT validation endpoint.

Optional description used during validation.

ABAP package for the binding.

Service binding name to validate.

Service binding version (for example: 1.0).

Service definition linked to binding.


Read credits, recent usage, free-run status, and defaults. Does not spend.

code message status retryable next_action

Webhound Account

Add research budget and optional guidance/context to a session.

Add Webhound Budget

Save concrete source-backed notes or hypotheses found by the calling agent while Webhound keeps running. No spend. Does not interrupt the Planner/Executor/Verifier cycle and does not change session status. Do not use for user intent changes.

Set true only when this is explicitly a hypothesis without source URLs.

Source URLs backing the note. Required unless hypothesis=true.

Concise sourced note or hypothesis for Webhound to consider later.

Add Webhound Sidecar Notes

Explain whether a session is healthy, done, usable, and what to do next. For a healthy running session, the correct next action is to keep waiting; budget use is the point of the run. Do not stop or force finalization because the run is slow.

Diagnose Webhound Session

Export a completed report or dataset as Markdown, HTML, TXT, JSON traces, CSV, JSONL, or PDF. Does not spend credits. Wait for done=true before exporting unless the user explicitly asks for a partial artifact.

Set true only if the user explicitly asks for an interim/partial export before done=true.

auto md markdown html txt text json json_traces csv jsonl pdf

Binary exports default to a download URL because base64 is not useful agent context. Set true only when raw binary bytes are required in the MCP response.

Export Webhound Session

Read normalized claim traces and provenance for a session.

Get Webhound Claims

Read the saved MCP defaults for budget, product, and free-run use. The MCP always uses Hound.

Get Webhound MCP Defaults

Read the full evidence payload for a completed Webhound session: final output, working docs, claim traces, sources, and export links. Use this before serious follow-up answers so Webhound value is not reduced to only the polished output document.

Set true only if the user explicitly asks for an interim evidence snapshot before done=true.

Get Webhound Evidence Pack

Read final report/working document or dataset rows. By default this is for terminal sessions only; do not read or summarize partial working notes while a healthy run is still running.

Set true only if the user explicitly asks for an interim/partial update before done=true. Partial output is not final and is not a reason to stop or finalize the run.

Get Webhound Output

Read the complete canonical session in one uncapped response: prompts, messages, phases, tasks, agents, final and working documents, dataset rows, claims, sources, notes, diagnostics, usage history, and artifact links. Nothing is paginated, truncated, or omitted.

Get Webhound Session

Make a report or dataset accessible to anyone with the link and return the share URL. This is share-only: reports use /document/:id, datasets use /dataset/:id, and it does not publish to Explore or create a /p/:slug publication.

Get Webhound Shareable Link

Read source inventory and citation counts for a session.

Get Webhound Sources

No-spend health check: auth, API status, credits, free-run pass, defaults, and MCP version.

Webhound Health

No-spend topic-aware guide for explaining Hound, budgets, completion, setup, reports, datasets, sources, billing, troubleshooting, or general Webhound behavior.

overview hound when_to_use budget completion reports datasets sources_and_claims files exports billing free_run troubleshooting onboarding mcp_setup

Webhound Help

List recent Webhound sessions.

all active researching running paused awaiting_input completed failed cancelled stopped

List Webhound Sessions

Read shared sidecar notes for a session. No spend. Use this to see what the calling agent has already shared with Webhound before adding, correcting, or dismissing notes.

List Webhound Sidecar Notes

No-spend, client-aware guided onboarding. Local agents receive the full setup-first versus jump-in flow; hosted clients receive a research-first flow with no filesystem setup unless the user explicitly requests approval-gated workspace-rule guidance. Budget maps to about 15 minutes per $1: $5 is about 75 minutes and $20 is about 300 minutes (5 hours). The $2/$5/$10/$20 tiers are starting points, not caps.

Identify the calling agent when known. Omitted or generic callers receive the research-first, filesystem-safe flow.

hosted manus codex claude_code cursor opencode claude_desktop vscode antigravity windsurf cline local generic

Set true only when the user explicitly asks for workspace-rule guidance as a separate action.

Webhound Onboarding

Resume a paused/completed/awaiting-input session with optional additional budget and guidance.

Resume Webhound Session

Semantic search across prior Webhound sessions.

Search Webhound Sessions

Send user-provided guidance to a session. Use reason="awaiting_input" to answer a checkpoint and resume. Use reason="user_guidance" only for a real user objective/scope/constraint/deliverable change. Use webhound_add_sidecar_notes for source suggestions.

user_guidance interrupts/replans for a real user change. awaiting_input replies to a checkpoint and resumes. Do not use for elapsed time, impatience, partial notes, or ordinary source notes.

Steer Webhound Session

Lower a running or paused report budget only after the user explicitly asks to reduce the remaining research scope or finish with the research already gathered. This changes the report stopping boundary; Webhound then performs normal final assembly. Never use this because partial notes look sufficient, the run is taking time, or the agent wants an earlier result.

New total report budget, lower than the current budget. To finish with current research, use budget_control.minimum_target_budget from webhound_watch or webhound_get_session.

Must be true only when the user explicitly asked to lower this report budget or finish at a lower research scope.

Lower Webhound Report Budget

Update only the provided default budget/product/free-run fields for future MCP runs; omitted fields keep their saved values. The MCP always uses Hound. Do not use this for private workspace-derived rules; save those locally in the agent workspace.

Set Webhound MCP Defaults

Start a private long-running dataset with Hound, Webhound's DeepSeek V4 Pro + GPT-5.4 research harness. Budget controls extraction depth; watch until done=true. Do not force finalization before done=true.

string number integer boolean object array null

Optional explicit schema. Native example: {"entity_name":"Company","attributes":[{"name":"company_name","type":"string","is_primary":true,"description":"Official company name"},{"name":"website","type":"string","standard_format":"url"},{"name":"employee_count","type":"number"}]} JSON Schema example: {"type":"object","title":"Company","required":["company_name"],"properties":{"company_name":{"type":"string","description":"Official company name","x-webhound-primary":true},"website":{"type":"string","format":"uri"},"employee_count":{"type":"integer"}}}

Start Webhound Dataset

Start a private long-running report with Hound, Webhound's DeepSeek V4 Pro + GPT-5.4 research harness. Budget controls research depth; watch until done=true. Do not force finalization before done=true.

Start Webhound Report

Pause/stop a running Webhound report or dataset without deleting it. Use only when the user explicitly asks to stop, pause, or cancel. Do not use for healthy long-running sessions, normal budget use, warning-level tool errors, or because partial notes look sufficient.

Must be true only when the user explicitly asked to stop/pause/cancel this Webhound run.

Stop Webhound Session

No-spend guidance for removing Webhound MCP config and Webhound-specific local rules from an agent workspace. Does not revoke keys automatically.

Uninstall Webhound MCP

Edit, restore, or dismiss one shared sidecar note. No spend. Does not interrupt the Planner/Executor/Verifier cycle and does not change session status.

Set to dismissed to remove it from future planner intake; set to pending to restore it.

Update Webhound Sidecar Note

Upload a CSV, XLSX, PDF, DOCX, TXT, Markdown, or VTT ChatGPT attachment, local file, text, or base64 content for use in a report or dataset. Convert legacy XLS/DOC files to XLSX/DOCX first.

Upload Webhound File

Bounded wait wrapper around webhound_watch. Max 110 seconds, then returns still_running if not terminal. still_running is normal for budgeted research; call wait/watch again unless status is awaiting_input or a blocking alert is present. Do not finalize or stop a healthy running session.

Wait For Webhound Session

Authoritative session watcher. done=true means the run is terminal. output_ready=true without done=true can still be intermediate; keep waiting unless the user explicitly asks for a partial update.

Watch Webhound Session


About FAF

Explain what the FAF format is — project DNA for AI — with its IANA registration, version, and connected platforms. Returns format metadata and the available MCP bridges. Use this when someone asks what FAF is or how it connects to other AI tools.

Auto-detect Context

Scan your manifests (package.json, Cargo.toml, pyproject.toml, go.mod…) and fill the project.faf stack slots from real dependencies — no hardcoded defaults. Returns what was detected and the updated score. Use this for the technical context; use faf_go for the human 6Ws it can't detect,

Force overwrite existing files

Project path. Sets session context for subsequent calls.

AI-Grounding Benchmark

Prove the .faf earns its place — measure how much the context is worth, on THIS repo, falsifiably. Questions derive from the project.faf's own populated slots (the .faf is the answer key), so grading is mechanical — no judge, no rubric. action=questions returns the answer-key-safe question set; action=grade takes your answers WITHOUT the .faf (cold) and WITH it (faf), grades both, and returns the cold→with-faf lift with a ✪ receipt. The delta is the product; the cold number belongs to the absence of context, never to FAF.

questions = get the answer-key-safe question set to answer; grade = submit cold + with-faf answers to score the delta. Default: questions.

action=grade: answers produced WITHOUT the .faf (general repo knowledge only). Map of question number → answer string.

action=grade (optional): tokens spent answering cold.

action=grade: answers produced WITH the project.faf in context. Map of question number → answer string.

action=grade (optional): tokens spent answering with the .faf.

action=grade (optional): the model that produced the answers.

Project path (optional — current directory if omitted).

Question set (action=questions) or the cold→with-faf grading + ✪ receipt (action=grade).

action=grade — score WITHOUT context (absence baseline).

Slots missed (paths only — no answer key).

with-faf minus cold — the product.

action=grade — score WITH the .faf.

in-session — answers are self-reported by the agent under test.

Hash of the question set — rides the receipt; same .faf reproduces it.

action=questions only — NEVER includes the answer key.

The .faf slot this question probes.

✪ receipt — sha256 over the canonical projection; third-party verifiable.

Number of questions in the set.

View Context

Set or show the active project path that subsequent faf_ calls resolve against. Returns the current context path. Call this once at the start of a session so the other tools target the right project.

Set active project path. If omitted, shows current context.

The active project context and whether a project.faf lives there.

Absolute path of the active project

True if this call set a new context, false if it only reported

The .faf filename, if found

Whether a project.faf (or .faf) was found there

Diagnose Issues

Diagnose a project.faf: report empty or weak slots, common issues, and how to fix each. Returns a prioritized checklist. Use this when faf_score is below target and you need to know why.

Health check: an overall verdict plus per-check diagnostics with fixes.

Number of checks run

Per-check results

Suggested fix, if any

ok | warning | error

Count of error-level findings

Overall verdict: ok | warning | error

Count of warning-level findings

Etch Memory

Remember a decision, gotcha, or win across sessions by writing it to the project soul (.fafm). Returns the stored memory's id. Use this to persist something an AI should recall later; use faf_recall to read them back.

Stable id — re-etching the same id updates in place (dedup)

Recall ranks by priority then recency

Tags (e.g. decision, gotcha, win) for filtering + recall coupling

The memory to remember — capture the why (decision/gotcha/win)

Memory category

The etched fact + soul state.

Path to soul.fafm

Total memories in the soul

Guided Setup

The friendly front door — "let's go, tell me about your idea." Asks the human the 6Ws (goal, why, who, what, where, when) that can't be auto-detected, then applies them to project.faf. If no project.faf exists yet, faf_go bootstraps it first (creates it, sources the stack) so you go from nothing to the 6Ws in one step. Returns the Table-of-8 to confirm/answer, or applies the answers you pass back. Use faf_auto for the technical stack on its own.

Answers to apply. Keys are field paths (e.g., "project.goal", "human_context.why"), values are the answers. If provided, applies answers and returns new score.

Initialize .faf

Create a new project.faf with a name, goal, and language. Returns the file path and starting score. Won't overwrite an existing file — use faf_auto to fill the stack from your manifests, or faf_go for the human 6Ws.

Overwrite existing project.faf if it exists

Project path or name. Smart resolution: "my-app" finds ~/Projects/my-app OR ~/Code/my-app. Full paths like ~/Projects/app or /Users/me/code/app work too. Omit to use current directory.

Recall Memory

Recall memories from the project soul (.fafm), ranked by priority then recency, filtered by query/tags/type. Returns the matching entries. Use this to surface past decisions; use faf_etch to add new ones.

Max memories to return

Priority floor (default ephemeral)

Case-insensitive substring match on memory text (optional)

Filter by tag intersection

Filter by memory type

Ranked memories from the soul.

Total memories in the soul

Number returned

AI-Readiness Score

Score a project.faf and return its 0–100% AI-readability, tier, and per-slot breakdown, via the deterministic Mk4 engine. Use this for a quick status check; use faf_doctor when you need to diagnose and fix what's missing.

Include detailed breakdown and improvement suggestions

Structured AI-readiness score, single-sourced from faf-cli.

Slots active for this app_type

Active slots still empty

Whether a readable, valid project.faf was scored

Slots marked slotignored (inactive for this app_type)

True if the score is attested from a source repo (app_type: about)

Next tier above the current score, or null at top tier

Determinism parity receipt — an engine-agnostic hash any conformant scorer reproduces for this exact file. Third-party verifiable: sha256(projection) === parityHash.

Hash algorithm (sha256)

sha256(projection) — identical across any conformant engine

Which wrapper emitted this receipt (metadata, not hashed)

The exact canonical string that was hashed (for verification)

The single deterministic source the score comes from

SHA-256 of the raw .faf bytes

Parity spec id, e.g. faf-parity/v1

Path that was scored

Active slots that are filled

AI-readiness score, 0-100

Tier name for this score (e.g. Bronze, Trophy)

Total slots

Sync .faf to CLAUDE.md (+ any AI format)

Sync project.faf into CLAUDE.md as a faf-managed block, and optionally into AGENTS.md (agents), .cursorrules (cursor), GEMINI.md (gemini), and .github/copilot-instructions.md (copilot) — or all of them (all). Updates each block in place — it never overwrites your file. Use this after editing project.faf so every AI tool sees the latest context.

Also sync to AGENTS.md (OpenAI/Codex format)

Sync to ALL formats: CLAUDE.md + AGENTS.md + .cursorrules + GEMINI.md + .github/copilot-instructions.md

Also sync to .github/copilot-instructions.md (GitHub Copilot)

Also sync to .cursorrules (Cursor IDE format)

Also sync to GEMINI.md (Google Gemini format)

Trust Attestation

Attest a project.faf's integrity: its validity, score, and a deterministic parity hash any conformant engine reproduces. Returns the ✪ receipt. Use this to prove a score is genuine and untampered.

Trust attestation: validity, score, and a third-party-verifiable determinism parity receipt.

Whether a project.faf was found

Determinism parity receipt (same shape as faf_score.parity).

Path that was attested

Why validation failed, when valid is false

The ✪ trust receipt — render-identical, self-verifying score+parity artifact.

Quiet-ladder glyph for this score (✪ at Trophy)

Optional test attestation

AI-readiness score, 0-100

SHA-256 of the raw .faf bytes

Tier name for this score

Whether the project.faf is readable and valid