Skip to main content
Glama
us-all

openmetadata-mcp-server

by us-all

get-glossary-term

Retrieve glossary term details by UUID, with optional field selection and extract paths to minimize response data.

Instructions

Get glossary term details by UUID

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesGlossary term UUID
fieldsNo
extractFieldsNoComma-separated dotted paths to project from response (e.g. 'id,name,owner.name,columns.*.name'). Use `*` as wildcard for arrays/objects. Wrap field names with dots in backticks. Reduces response tokens dramatically on large entities.

Implementation Reference

  • The async handler that executes the 'get-glossary-term' tool logic. It extracts the 'id' from params and makes a GET request to /glossaryTerms/{id} with optional query parameters.
    export async function getGlossaryTerm(params: z.infer<typeof getGlossaryTermSchema>) {
      const { id, ...query } = params;
      return omClient.get(`/glossaryTerms/${id}`, query);
    }
  • Zod schema defining input validation for 'get-glossary-term' tool: requires 'id' (string UUID), optional 'fields' and 'extractFields'.
    export const getGlossaryTermSchema = z.object({
      id: z.string().describe("Glossary term UUID"),
      fields: z.string().optional(),
      extractFields: ef,
    });
  • src/index.ts:256-256 (registration)
    Registration of the 'get-glossary-term' tool in the MCP tool registry, binding its name, description, schema, and wrapped handler.
    tool("get-glossary-term", "Get glossary term details by UUID", getGlossaryTermSchema.shape, wrapToolHandler(getGlossaryTerm));
Behavior2/5

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

No annotations provided, so description carries full burden. Only states it retrieves details, omitting any behavioral traits like error handling, authorization, or response format. Minimal disclosure.

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?

Single sentence, no wasted words. Front-loaded with key action and resource.

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?

For a simple getter with 3 params and no output schema, description gives basic purpose but fails to mention optional parameters that customize output (fields, extractFields). Schema fills some gaps, but description could be more complete.

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 covers 67% of parameters with descriptions. The description adds no extra meaning beyond 'by UUID', which is redundant with schema's 'Glossary term UUID'. No value added for 'fields' or 'extractFields'.

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?

Clearly states verb 'Get' and resource 'glossary term details by UUID'. Distinguishes from sibling 'get-glossary-term-by-name' by specifying identifier type.

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

Usage Guidelines4/5

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

Implies usage when UUID is known, and alternative 'get-glossary-term-by-name' exists for name-based lookup. Lacks explicit when-not-to-use but context is clear.

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