Skip to main content
Glama

UpdateMessageClass

Updates the header description of an ABAP message class so you can revise its documentation outside batch mode.

Instructions

Updates the header of the ABAP message class named by message_class_name: its description. Runs outside batch mode.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "message_class_name": "<message_class_name>",
      "description": "<description>"
    },
    "name": "UpdateMessageClass"
  }
}

Input Schema

NameRequiredDescriptionDefault
detailNoHow much of the answer to return: "terse" (default, the fields you need to act), "full" (the whole parse), "raw" (the document as ADT sent it).terse
descriptionYesNew short description for the message class.
transport_requestNo(optional) Transport request number, not a task. Required for transportable objects.
message_class_nameYesMessage class name.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv16.0.0
    • addedInput schema / properties / detail
      Added value: +{
      +  "default": "terse",
      +  "description": "How much of the answer to return: \"terse\" (default, the fields you need to act), \"full\" (the whole parse), \"raw\" (the document as ADT sent it).",
      +  "enum": [
      +    "terse",
      +    "full",
      +    "raw"
      +  ],
      +  "type": "string"
      +}
    • changedInput schema / properties / message_class_name / description
      Previous value: -"Message class name (e.g., ZMY_MSGS)."New value: +"Message class name."
    • changedInput schema / properties / transport_request / description
      Previous value: -"(optional) Transport request number. Required for transportable objects."New value: +"(optional) Transport request number, not a task. Required for transportable objects."
  2. Addedv8.6.1

TDQS

B3.3/5.0
Behavior2/5

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

No annotations are provided, so the description carries the full behavioral burden. It discloses the execution context and that only the description field is updated, but it omits permissions, transport requirements, activation effects, side effects, and response behavior for this mutation.

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

Conciseness5/5

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

The description is only two sentences and is front-loaded with the operation and target. Both sentences add useful information without repetition or filler.

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

Completeness3/5

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

The description covers the core update and a runtime constraint, and the schema fully documents the parameters. However, with no annotations and no output schema, it still leaves gaps around transport requirements, side effects, and what the caller should expect after the update.

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 documented. The description reinforces the meaning of message_class_name and description but adds nothing about detail or transport_request, so the baseline 3 is appropriate.

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

Purpose4/5

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

The description names a specific verb and target: it updates the header description of an ABAP message class identified by message_class_name. This distinguishes it from message-level siblings such as UpdateMessageClassMessage, though it does not explicitly name them.

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

Usage Guidelines3/5

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

It includes one useful usage constraint, 'Runs outside batch mode,' which tells the agent when the tool is valid. However, it gives no explicit when-to-use guidance versus GetMessageClass, CreateMessageClass, DeleteMessageClass, or UpdateMessageClassMessage.

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