Skip to main content
Glama

UpdateDdl

Updates the DDL source code of an existing CDS or classic DDL view by locking, writing, unlocking, and optionally activating it outside batch mode.

Instructions

Updates the DDL source code of the existing CDS view or classic DDL view named by ddl_name to ddl_source. Locks, updates, unlocks, and optionally activates. 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": {
      "ddl_name": "<ddl_name>",
      "ddl_source": "<ddl_source>"
    },
    "name": "UpdateDdl"
  }
}

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
activateNoActivate after update. Default: false.
ddl_nameYesDDL source name.
ddl_sourceYesComplete DDL source code.
transport_requestNoTransport request number, not a task. Required for transportable packages.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv16.0.0
    • changedInput schema / properties / ddl_name / description
      Previous value: -"DDL source name (e.g., ZOK_R_TEST_0002)."New value: +"DDL source name."
    • 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 / transport_request / description
      Previous value: -"Transport request number (e.g., E19K905635). Required for transportable packages."New value: +"Transport request number, not a task. Required for transportable packages."
  2. Addedv8.0.0

TDQS

A3.8/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 add real behavioral detail: the lock/update/unlock sequence, that activation is optional, and that it runs outside batch mode. It omits error/failure behavior and the transport-request prerequisite (only in schema), which keeps 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?

Three tight sentences with zero filler: purpose first, then the lock/activation behavior, then the batch-mode constraint. Everything is front-loaded and each clause earns its 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 5-parameter mutation tool with no annotations and no output schema, the description covers purpose, mutation mechanics, activation, and execution mode. The main gap is that it never states what is returned, though the detail parameter in the schema implies a result object exists.

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 defines all five parameters, including detail and transport_request. The description only restates the ddl_name/ddl_source purpose and the optional activation, adding nothing about syntax, transport behavior, or the detail enum.

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?

States a specific verb and resource ('Updates the DDL source code of the existing CDS view or classic DDL view') and binds it to the ddl_name/ddl_source parameters. The word 'existing' implicitly distinguishes it from CreateDdl/DeleteDdl, but no sibling is named, so full sibling differentiation is left to inference.

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 only implied: 'optionally activates' and 'Runs outside batch mode' describe operating context but not when to choose UpdateDdl over ActivateDdl or CheckDdl. There is no explicit when-to-use or when-not-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