Skip to main content
Glama
Hollway

mcp-abap-abap-adt-api

by Hollway
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

setTextElements

Replace all text elements for an ABAP object—symbols, selections, or headings—in one write. Read the current set first, then submit the full replacement and activate if needed.

Instructions

Write the text elements of a program, class or function group. The write replaces the whole set for that category, so pass every element you want to keep - read them first with getTextElements. The lock is taken on the text elements resource - not on the object - and released again, unless you pass a handle or this server already holds one; outside $TMP a transport request is needed. Pass activate to finish the job, or run activateSafe afterwards: a text write leaves both the object and its text pool inactive.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
urlNoEscape hatch: the text elements base URL.
activateNoActivate the object after the write (default false). Only possible when this tool took the lock itself - activation is refused while a session holds one.
categoryNoWhich set to write: "symbols" (default), "selections" or "headings".
elementsYesThe complete set for this category: [{id, text, maxLength, ddicReference}]. For selection texts the id is the field name, e.g. P_WERKS; for text symbols the three-character number, e.g. 001.
objectUrlNoObject URL, used for the activation; derived from objectName and objectType when omitted. The lock is not taken on this - it goes on the text elements resource.
transportNoTransport request number - the request itself, not a developer task.
lockHandleNoLock handle. Omit it: the one this server holds for the object is used, and with none held the lock is taken and released here.
objectNameNoObject name, e.g. ZR_APP_FOO.
objectTypeNoADT type of the object: PROG/P, CLAS/OC, FUGR/F. Defaults to PROG/P.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.1

TDQS

A4.6/5.0
Behavior5/5

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

The annotations only provide readOnly=false and destructiveHint=false, but the description adds crucial behavior: the write replaces the whole set, the lock is taken on the text elements resource (not the object), lock release semantics, the transport requirement, and the fact that the object and text pool remain inactive after a text write. This far exceeds the annotation baseline.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is dense but each sentence contributes a needed constraint or consequence. It is front-loaded with the action and then covers caveats logically. It is somewhat long, but the complexity of the tool justifies the length.

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

Completeness5/5

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

For a tool with 9 parameters and no output schema, the description covers the essential prerequisites, lock mechanics, transport, activation options, and post-write inactivity. An agent has enough context to invoke the tool correctly and anticipate its side effects.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so all parameters are already well-documented. The description reinforces the elements semantics ('pass every element you want to keep') and lock behavior, but this largely duplicates the schema's existing 'complete set' and lockHandle descriptions. Baseline 3 is appropriate when the schema is exhaustive.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description uses the specific verb 'Write' with the resource 'text elements of a program, class or function group', immediately distinguishing it from the sibling getTextElements ('read them first with getTextElements'). The scope is precise and unambiguous.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly instructs to read first with getTextElements, names activateSafe as an alternative for activation, and states the transport precondition ('outside $TMP a transport request is needed'). This clearly indicates when to use the tool and what prerequisites to satisfy.

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

Deploy Server

Other Tools