Skip to main content
Glama
us-all

openmetadata-mcp-server

by us-all

update-glossary-term

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

Instructions

Update a glossary term using JSON Patch operations

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesGlossary term UUID
operationsYesJSON Patch operations

Implementation Reference

  • The actual handler function that executes the update-glossary-term tool logic. It asserts write permissions and makes a PATCH request to the glossary term API endpoint using JSON Patch operations.
    export async function updateGlossaryTerm(params: z.infer<typeof updateGlossaryTermSchema>) {
      assertWriteAllowed();
      return omClient.patch(`/glossaryTerms/${params.id}`, params.operations);
    }
  • The schema definition for the update-glossary-term tool, specifying the required 'id' (UUID) and 'operations' (JSON Patch operations) parameters.
    export const updateGlossaryTermSchema = z.object({
      id: z.string().describe("Glossary term UUID"),
      operations: z.array(z.record(z.string(), z.any())).describe("JSON Patch operations"),
    });
  • src/index.ts:259-259 (registration)
    The tool registration line where 'update-glossary-term' is registered with its schema and handler via the tool() function.
    tool("update-glossary-term", "Update a glossary term using JSON Patch operations", updateGlossaryTermSchema.shape, wrapToolHandler(updateGlossaryTerm));
  • src/index.ts:54-54 (registration)
    The import statement that brings the updateGlossaryTermSchema and updateGlossaryTerm handler into the registration file.
    updateGlossaryTermSchema, updateGlossaryTerm, deleteGlossaryTermSchema, deleteGlossaryTerm,
Behavior2/5

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

With no annotations, the description should disclose behavioral traits. It only states 'update' (implying mutation) but does not mention atomicity, error handling, authorization needs, or what happens on missing term. The mention of JSON Patch provides minimal behavioral hint.

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 a single, efficient sentence with no redundant words. It could be improved by including a brief example or reference, but as a concise statement it earns a high score.

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 complexity of JSON Patch updates and the lack of an output schema or annotations, the description is insufficient. It does not explain patch construction, allowed fields, error responses, or behavioral details, leaving major gaps for an AI agent.

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?

The schema has 100% description coverage for both parameters. The description adds only the word 'using JSON Patch operations', which slightly reinforces the operations parameter's purpose. Baseline 3 is appropriate as the added value is marginal.

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 ('glossary term'), and the method ('using JSON Patch operations'). It uniquely identifies this tool among siblings, distinguishing it from create-glossary-term and delete-glossary-term.

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 (e.g., when to update vs. delete and recreate). There are no prerequisites, context, or exclusions mentioned for the update operation.

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