Skip to main content
Glama
us-all

openmetadata-mcp-server

by us-all

update-glossary

Update a glossary by applying JSON Patch operations to modify its contents.

Instructions

Update a glossary using JSON Patch operations

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesGlossary UUID
operationsYesJSON Patch operations

Implementation Reference

  • The actual handler function that executes the update-glossary tool logic. It validates writes are allowed, then sends a PATCH request to /glossaries/{id} with JSON Patch operations.
    export async function updateGlossary(params: z.infer<typeof updateGlossarySchema>) {
      assertWriteAllowed();
      return omClient.patch(`/glossaries/${params.id}`, params.operations);
    }
  • Zod schema defining the input parameters for update-glossary: id (Glossary UUID) and operations (array of JSON Patch operations).
    export const updateGlossarySchema = z.object({
      id: z.string().describe("Glossary UUID"),
      operations: z.array(z.record(z.string(), z.any())).describe("JSON Patch operations"),
    });
  • src/index.ts:250-250 (registration)
    Registration of the 'update-glossary' tool with the MCP server, wiring the schema and handler together.
    tool("update-glossary", "Update a glossary using JSON Patch operations", updateGlossarySchema.shape, wrapToolHandler(updateGlossary));
  • Import of updateGlossarySchema and updateGlossary from the glossary tools module.
    } from "./tools/glossary.js";
    import {
Behavior2/5

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

With no annotations, the description must supply behavioral context. It indicates mutation ('update') but does not disclose idempotency, error handling, side effects, or authorization requirements. The mention of JSON Patch implies fine-grained updates but lacks detail.

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 sentence with no extraneous words. Every word contributes to conveying the tool's function.

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

Completeness3/5

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

Given no output schema or annotations, the description provides minimal context. It covers the core intent but lacks details on return values, error states, or the format of operations (e.g., RFC 6902). Adequate for a simple update but not comprehensive.

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 baseline is 3. The description does not add substantive meaning beyond the schema; it merely reiterates 'JSON Patch operations' already present in the schema description for the operations parameter.

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 explicitly states the action ('Update') and resource ('glossary'), and specifies the method ('JSON Patch operations'), distinguishing it from sibling update tools like update-glossary-term. It is specific and clear.

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?

There is no guidance on when to use this tool versus other update tools (e.g., update-glossary-term) or creation tools. No prerequisites or context for use are provided.

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