Skip to main content
Glama

CheckMetadataExtension

Runs a syntax check on a named CDS metadata extension (DDLX), returning errors, warnings, and messages; optionally checks the active or inactive version.

Instructions

[read-only] Runs a syntax check on the CDS metadata extension (DDLX) named by name. Returns syntax errors, warnings, and messages. 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": {
      "name": "<name>"
    },
    "name": "CheckMetadataExtension"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYesMetadata extension name.
versionNoWhich version to check: 'active' (default) or 'inactive', the unsaved one right after a write. This endpoint does not fall back to whichever exists.active

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv16.0.0
    • changedInput schema / properties / name / description
      Previous value: -"Metadata extension name (e.g., ZC_MY_DDLX)."New value: +"Metadata extension name."
    • addedInput schema / properties / version
      Added value: +{
      +  "default": "active",
      +  "description": "Which version to check: 'active' (default) or 'inactive', the unsaved one right after a write. This endpoint does not fall back to whichever exists.",
      +  "enum": [
      +    "active",
      +    "inactive"
      +  ],
      +  "type": "string"
      +}
  2. Addedv6.5.1

TDQS

A4/5.0
Behavior4/5

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

With no annotations, the description carries the disclosure burden and does state the tool is read-only, what it returns (errors, warnings, messages), and explains the non-obvious batch recording behavior including empty content and later retrieval by number. It omits permission requirements and any side effects around active vs. inactive versions, but covers the major behavioral traits.

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?

Two sentences, front-loaded with the read-only marker, purpose, and return values, followed by the batch caveat. Every clause carries information an agent needs, with no repetition of the schema or title.

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 two-parameter tool with no output schema, the description supplies the return contents (errors, warnings, messages), the read-only nature, and the batch interaction model, while the schema handles version semantics. It is nearly complete, though it could note prerequisites or what happens when the named DDLX does not exist.

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 the version parameter’s active/inactive semantics – including the lack of fallback – are fully documented in the schema. The description only restates that the tool operates on the metadata extension 'named by name,' adding no parameter meaning beyond the schema, so the baseline of 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?

The description names a specific verb (runs a syntax check) and a precise resource (the CDS metadata extension / DDLX named by name). It also states the returned artifacts (syntax errors, warnings, messages), which distinguishes it from generic Check* siblings such as CheckDdl, CheckTable, and CheckClass.

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 'Runs a syntax check' – an agent can infer this is for validating a DDLX before activation – but the description never says when to use it rather than CheckDdl or ActivateMetadataExtension, and it gives no prerequisites. The batch-mode note describes behavior, not when to choose this tool over alternatives.

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