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
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Glossary term UUID | |
| fields | No | ||
| extractFields | No | Comma-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
- src/tools/glossary.ts:107-110 (handler)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); } - src/tools/glossary.ts:101-105 (schema)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));