Skip to main content
Glama
us-all

openmetadata-mcp-server

by us-all

update-domain

Update a metadata domain by applying JSON Patch operations to modify fields like description.

Instructions

Update a domain using JSON Patch operations

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesDomain UUID to update
operationsYesJSON Patch operations array (e.g. [{op:'add', path:'/description', value:'...'}])

Implementation Reference

  • The main handler function for the update-domain tool. It calls assertWriteAllowed() and then sends a PATCH request to /domains/{id} with JSON Patch operations.
    export async function updateDomain(params: z.infer<typeof updateDomainSchema>) {
      assertWriteAllowed();
      return omClient.patch(`/domains/${params.id}`, params.operations);
    }
  • Zod schema defining the input shape for update-domain: requires a domain UUID 'id' and an array of JSON Patch 'operations'.
    export const updateDomainSchema = z.object({
      id: z.string().describe("Domain UUID to update"),
      operations: z.array(z.record(z.string(), z.any())).describe("JSON Patch operations array (e.g. [{op:'add', path:'/description', value:'...'}])"),
    });
  • src/index.ts:340-340 (registration)
    Registration of the update-domain tool on the MCP server, wiring the schema and handler.
    tool("update-domain", "Update a domain using JSON Patch operations", updateDomainSchema.shape, wrapToolHandler(updateDomain));
  • src/index.ts:95-95 (registration)
    Import of the updateDomainSchema and updateDomain from src/tools/domains.ts.
    updateDomainSchema, updateDomain, deleteDomainSchema, deleteDomain,
Behavior2/5

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

With no annotations, the description carries full burden. It only states the basic operation but does not disclose behavioral traits such as whether it is destructive, required permissions, conflict handling, or side effects.

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 concise sentence with no unnecessary words. It front-loads the core action.

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 lack of output schema and annotations, the description is incomplete. It fails to explain the effects of updating a domain, what fields are affected, or any operational nuances.

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 coverage is 100% (both parameters documented), so the description adds no additional meaning beyond what the schema already provides. Baseline of 3 is appropriate.

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 clearly states the action ('Update'), the resource ('domain'), and the method ('JSON Patch operations'). It effectively distinguishes from siblings (e.g., create-domain, delete-domain) and other update-* tools.

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 like other update tools or create/delete. It does not specify prerequisites, context, or exclusions.

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