Skip to main content
Glama
us-all

openmetadata-mcp-server

by us-all

delete-domain

Delete a domain by its UUID. Supports hard delete for permanent removal and recursive delete for child domains.

Instructions

Delete a domain by UUID

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesDomain UUID to delete
hardDeleteNoHard delete (permanent) vs soft delete
recursiveNoRecursively delete children

Implementation Reference

  • The deleteDomain handler function that executes the tool logic - validates write permissions and sends a DELETE request to /domains/:id with hardDelete and recursive query params.
    export async function deleteDomain(params: z.infer<typeof deleteDomainSchema>) {
      assertWriteAllowed();
      return omClient.delete(`/domains/${params.id}`, {
        hardDelete: params.hardDelete,
        recursive: params.recursive,
      });
    }
  • The deleteDomainSchema Zod schema defining input parameters: id (string, required), hardDelete (boolean, optional, default false), recursive (boolean, optional, default false).
    export const deleteDomainSchema = z.object({
      id: z.string().describe("Domain UUID to delete"),
      hardDelete: z.boolean().optional().default(false).describe("Hard delete (permanent) vs soft delete"),
      recursive: z.boolean().optional().default(false).describe("Recursively delete children"),
    });
  • src/index.ts:341-341 (registration)
    Registration of the delete-domain tool with MCP server, wired to deleteDomainSchema and deleteDomain handler.
    tool("delete-domain", "Delete a domain by UUID", deleteDomainSchema.shape, wrapToolHandler(deleteDomain));
  • Imports used by deleteDomain: zod for schema validation, omClient for HTTP calls, and assertWriteAllowed for permission checking.
    import { z } from "zod/v4";
    import { omClient } from "../client.js";
    import { assertWriteAllowed } from "./utils.js";
  • src/index.ts:92-99 (registration)
    Import statement that brings deleteDomainSchema and deleteDomain from src/tools/domains.ts into the registration file.
    import {
      listDomainsSchema, listDomains, getDomainSchema, getDomain,
      getDomainByNameSchema, getDomainByName, createDomainSchema, createDomain,
      updateDomainSchema, updateDomain, deleteDomainSchema, deleteDomain,
      listDataProductsSchema, listDataProducts, getDataProductSchema, getDataProduct,
      getDataProductByNameSchema, getDataProductByName, createDataProductSchema, createDataProduct,
      updateDataProductSchema, updateDataProduct, deleteDataProductSchema, deleteDataProduct,
    } from "./tools/domains.js";
Behavior2/5

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

With no annotations, the description must disclose behavioral traits, but it only states 'Delete a domain by UUID'. It omits important details like irreversibility, permission requirements, or side effects of parameters like hardDelete and recursive. The schema provides parameter descriptions, but the tool-level description lacks behavioral context.

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 is extremely concise (6 words), which is appropriate for a simple delete operation. However, a slightly more informative structure (e.g., mentioning optional parameters) would improve without harming conciseness.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the absence of an output schema and annotations, and the presence of three parameters, the description is too sparse. It does not explain return behavior, success/failure indicators, or any preconditions. The tool feels incomplete for an agent to safely invoke.

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 baseline is 3. The description adds no additional meaning beyond the schema, such as explaining when to use hardDelete or recursive. It merely repeats the parameter names implicitly.

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?

Description clearly states the action (Delete) and the resource (domain by UUID), distinguishing it from sibling delete tools that act on other entity types. The identifier method is specified, leaving no ambiguity about what the tool does.

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

Usage Guidelines2/5

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

No guidance is provided on when to use this tool versus alternatives, such as soft vs hard deletion, or when recursive deletion is appropriate. Sibling tools like update-domain exist, but no explicit when-not-to-use or alternative recommendations are given.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/us-all/openmetadata-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server