Skip to main content
Glama

GetMetadataExtension

Reads a CDS metadata extension by name, returning either its source code (active or inactive) or its ADT metadata document with package, responsible, and description in one request.

Instructions

[read-only] Reads the CDS metadata extension named by metadata_extension_name in one request: its source code (part "source", the default; active or inactive version) or its ADT metadata document (part "metadata": package, responsible, description). Returns the part read. 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": {
      "metadata_extension_name": "<metadata_extension_name>"
    },
    "name": "GetMetadataExtension"
  }
}

Input Schema

NameRequiredDescriptionDefault
partNoThe document to read: "source" (default) the source code, "metadata" the ADT metadata document (package, responsible, description, ...).source
versionNoVersion of the source: "active" (default) for the deployed version, "inactive" for the modified version awaiting activation.active
metadata_extension_nameYesMetadataExtension name.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv20.1.0
    • addedInput schema / properties / part
      Added value: +{
      +  "default": "source",
      +  "description": "The document to read: \"source\" (default) the source code, \"metadata\" the ADT metadata document (package, responsible, description, ...).",
      +  "enum": [
      +    "source",
      +    "metadata"
      +  ],
      +  "type": "string"
      +}
    • changedInput schema / properties / version / description
      Previous value: -"Version to read: \"active\" (default) for deployed version, \"inactive\" for modified but not activated version."New value: +"Version of the source: \"active\" (default) for the deployed version, \"inactive\" for the modified version awaiting activation."
  2. Changed1 schema field changedv16.0.0
    • changedInput schema / properties / metadata_extension_name / description
      Previous value: -"MetadataExtension name (e.g., Z_MY_METADATAEXTENSION)."New value: +"MetadataExtension name."
  3. First observed

TDQS

A3.8/5.0
Behavior4/5

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

With no annotations provided, the description carries the full burden and does well: it declares read-only, explains that only the requested part is returned, and discloses the non-obvious batch behavior (recorded under the next number, returns empty content, answer retrieved by number after batch end). It does not say what happens on a missing name or an inactive object that has no modified version, so it stops short of full disclosure.

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?

A single dense sentence, front-loaded with the verb and resource, then the part enumeration, then a separate clause for batch behavior. Nothing is wasted and the ordering matches how an agent decides to call it.

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 three-parameter read tool with no output schema, the description covers the return shape adequately ("returns the part read"; metadata part contents enumerated) plus batch semantics. It is slightly thin on failure modes and on whether inactive source is empty when nothing is pending, but nothing an agent needs to make the call is missing.

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% and both enums are documented in-schema, so the description only reinforces the defaults (part="source", version="active") rather than adding new semantics. Baseline 3 applies since the schema does the heavy lifting.

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 (reads a CDS metadata extension by name) and enumerates what can be read: source code or the ADT metadata document, active or inactive. It does not explicitly contrast itself with the version-oriented siblings (GetMetadataExtensionVersionSource, GetMetadataExtensionVersions), but the active/inactive framing implicitly separates it from the version-history family.

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?

Usage is implied by the part/version defaults and by the batch-mode note, which tells an agent this call can be scheduled inside a batch and answered later. There is no explicit statement of when to prefer this tool over GetMetadataExtensionVersionSource or CheckMetadataExtension, so the agent must infer the boundary.

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