Skip to main content
Glama

GetMessageClass

Reads an ABAP message class by name in one request, returning its metadata document with description, package, master language, and messages for ABAP ADT workflows.

Instructions

[read-only] Reads the ABAP message class (MSAG/T100) named by message_class_name in one request: its ADT metadata document (XML: name, description, package, master language, messages). Returns it under metadata, with part: "metadata". Recordable: in batch mode a call is recorded under the next number and answers with empty content; its answer is read by number after the batch ends.

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>"
    },
    "name": "GetMessageClass"
  }
}

Input Schema

NameRequiredDescriptionDefault
message_class_nameYesMessage class name.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv16.0.0
    • changedInput schema / properties / message_class_name / description
      Previous value: -"Message class name (e.g., ZMY_MSGS)."New value: +"Message class name."
  2. Addedv8.6.1

TDQS

A3.9/5.0
Behavior4/5

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

With no annotations, the description carries the burden and does well: it discloses read-only nature, the return location (`metadata`) and `part: "metadata"`, and the non-obvious batch/recordable behavior (recorded by number, empty content returned, answer read after batch). Missing only error/permission behavior to reach a 5.

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?

Front-loads purpose then the return shape then the batch caveat, with no wasted filler. Dense but each clause earns its place, though the batch sentence is somewhat terse and could be clearer.

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

Completeness4/5

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

No output schema exists, so the description appropriately explains what is returned (ADT metadata XML containing name, description, package, master language, messages) and the batch-mode contract. Complete enough for a single-parameter read tool; only edge cases like permission requirements are absent.

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 coverage is 100% and the single parameter is documented as 'Message class name.' The description reinforces that message_class_name names the MSAG/T100 class but adds no format, syntax, or lookup detail beyond the schema. Baseline 3 applies.

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?

States a specific verb (Reads) and resource (ABAP message class / MSAG/T100) with exact scope, and the singular-object focus distinguishes it from GetMessageClassMessage, CreateMessageClass, and the other sibling verbs. An agent can identify it without opening the schema.

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?

The read intent is implied by '[read-only] Reads' and the surrounding create/update/delete siblings, but the description never explicitly says when to use this versus GetMessageClassMessage or how to reach individual message entries. Usage is inferable rather than stated.

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