Skip to main content
Glama

GetStructuresList

Recursively lists the structures embedded in one or more ABAP structures as a tree, including append extensions by default, so you can inspect ABAP structure composition.

Instructions

[read-only] Recursively list the structures embedded in an ABAP structure (.INCLUDE / append), as a tree. Takes structure_name (one structure: its tree) or structure_names (several structures: one entry per structure, in the order given, each its tree answer or { structure_name, error }). Works on BASIS 7.50 and later, where the DDIC structure/table endpoints it reads exist; legacy systems (BASIS < 7.50) refuse it (issue #207). Runs on an ABAP session of its own. Optional timeout (seconds): when it passes, the read is cancelled, its ABAP session logged off, and the system stays as it was. Set it below your MCP client's request limit — the TypeScript SDK's client cancels at 60 s; a client's cancel ends only the client's wait, and SAP runs the read on. Runs outside batch mode.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "GetStructuresList"
  }
}

Input Schema

NameRequiredDescriptionDefault
timeoutNoSeconds to wait for the answer: a whole number, at least 1, no default — without it the call waits until SAP answers. When it passes, the read is cancelled (its ABAP session is logged off) and the call answers that nothing was changed. Set it below your MCP client's request limit — the TypeScript SDK's client cancels at 60 s; a cancel does nothing to SAP.
versionNoVersion to read: "active" (default) or "inactive".active
structure_nameNoStructure name (or give structure_names).
structure_namesNoSeveral structure names, read together (give this or structure_name).
include_extensionsNo[read-only] Also find extension (append) structures via where-used (objects that `extend type <this> with …`). Default true. Set false to skip the (slower) where-used lookups and return includes only.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed7 schema fields changedv20.1.0
    • changedInput schema / properties / structure_name / description
      Previous value: -"Structure name."New value: +"Structure name (or give structure_names)."
    • addedInput schema / properties / structure_names
      Added value: +{
      +  "description": "Several structure names, read together (give this or structure_name).",
      +  "items": {
      +    "type": "string"
      +  },
      +  "type": "array"
      +}
    • changedInput schema / properties / timeout / description
      Previous value: -"[read-only] Timeout in ms for each ADT request."New value: +"Seconds to wait for the answer: a whole number, at least 1, no default — without it the call waits until SAP answers. When it passes, the read is cancelled (its ABAP session is logged off) and the call answers that nothing was changed. Set it below your MCP client's request limit — the TypeScript SDK's client cancels at 60 s; a cancel does nothing to SAP."
    • addedInput schema / properties / timeout / maximum
      Added value: +2147483
    • addedInput schema / properties / timeout / minimum
      Added value: +1
    • changedInput schema / properties / timeout / type
      Previous value: -"number"New value: +"integer"
    • removedInput schema / required
      Removed value: -[
      -  "structure_name"
      -]
  2. Changed1 schema field changedv16.0.0
    • changedInput schema / properties / structure_name / description
      Previous value: -"Structure name (e.g., Z_MY_STRUCTURE)."New value: +"Structure name."
  3. Addedv7.1.0

TDQS

A4.2/5.0
Behavior5/5

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

With no annotations provided, the description carries the full behavioral burden and does so well: it labels the operation read-only, describes running on its own ABAP session, explains timeout cancellation and session logoff, states that the system remains unchanged, notes BASIS version limitations, and mentions that include_extensions triggers slower where-used lookups.

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 front-loads the core purpose and then adds necessary operational context. It is somewhat long and repeats timeout details already present in the schema, but the density is justified for a tool with session, timeout, version, and multi-read behavior.

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?

For a tool with no output schema and no annotations, it covers the important operational and return-shape context: single vs multiple structures, ordered per-structure entries, and error entries. The exact node format of the returned tree is not described, which is the main remaining gap.

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

Parameters4/5

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

Schema coverage is 100%, so the schema already documents the parameters. The description still adds meaning by explaining the one-vs-many choice between structure_name and structure_names, the ordering and per-structure error shape for multi-reads, and the performance implication of include_extensions=false.

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 states a specific verb and resource: recursively list structures embedded in an ABAP structure as a tree, with .INCLUDE/append context. It is clear enough to distinguish from a plain GetStructure, but it does not explicitly name or contrast with siblings such as GetIncludesList or GetStructure.

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

Usage Guidelines4/5

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

It gives useful usage context: use structure_name for one tree, structure_names for several, and skip include_extensions when where-used lookups are too slow. It also states the BASIS 7.50+ requirement and legacy refusal. It does not explicitly compare against alternative structure-reading tools, so it stops short of full when-to-use guidance.

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