Skip to main content
Glama

GetDdl

Reads a CDS or classic DDL view's source code or ADT metadata by name, including active or inactive versions, so you can inspect view definitions, package, owner, and description.

Instructions

[read-only] Reads the CDS view (or classic DDL view) named by ddl_name in one request: its DDL source (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": {
      "ddl_name": "<ddl_name>"
    },
    "name": "GetDdl"
  }
}

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
ddl_nameYesDDL source 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 / ddl_name / description
      Previous value: -"DDL source name (e.g., Z_MY_VIEW)."New value: +"DDL source name."
  3. Addedv8.0.0

TDQS

A3.8/5.0
Behavior4/5

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

No annotations are provided, so the description carries the full burden. It explicitly labels the operation as read-only, says the requested part is returned, and explains the non-obvious batch-mode behavior where a recorded call returns empty content and is later read by number. It does not cover permissions, missing-object errors, or exact return format, keeping it from 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.

Conciseness5/5

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

The description is a single front-loaded paragraph with no wasted sentences. The read-only marker, part distinction, and batch behavior all earn their place.

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 low-complexity read tool with no output schema, the description covers the essential purpose, parameter choices, return value, and batch semantics. It is not fully complete because it omits failure behavior and does not specify the exact shape of the returned source or metadata.

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 the schema already documents ddl_name, part, and version thoroughly. The description restates the meaning of part and version and adds context such as metadata fields, but adds little beyond what the structured schema already provides; 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 uses a specific verb ('Reads') and resource ('CDS view (or classic DDL view)') and distinguishes the two readable parts, source and metadata. It does not explicitly contrast itself with sibling tools such as GetDdlVersionSource, GetDdlVersionDiff, or CheckDdl, so it falls short of a 5.

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 explains how to choose between part='source' and part='metadata' and between active and inactive versions, which gives implied usage guidance. However, it never states when to use this tool instead of GetDdlVersions, GetDdlVersionSource, GetDdlVersionDiff, or CheckDdl, so alternative routing is missing.

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