get-glossary
Retrieve glossary details by providing its UUID. Access terms, definitions, and related metadata.
Instructions
Get glossary details by UUID
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Glossary 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:29-32 (handler)The handler function for the get-glossary tool. It extracts the 'id' from params, constructs a GET request to /glossaries/{id}, and passes remaining fields as query parameters.
export async function getGlossary(params: z.infer<typeof getGlossarySchema>) { const { id, ...query } = params; return omClient.get(`/glossaries/${id}`, query); } - src/tools/glossary.ts:23-27 (schema)The Zod schema for the get-glossary tool, defining input parameters: id (string, required), fields (string, optional), and extractFields (string, optional).
export const getGlossarySchema = z.object({ id: z.string().describe("Glossary UUID"), fields: z.string().optional(), extractFields: ef, }); - src/index.ts:247-247 (registration)Registration of the get-glossary tool with its name, description, schema shape, and wrapped handler function.
tool("get-glossary", "Get glossary details by UUID", getGlossarySchema.shape, wrapToolHandler(getGlossary)); - src/tools/glossary.ts:3-3 (helper)The omClient is used by the handler to make the HTTP GET request to the API.
import { assertWriteAllowed } from "./utils.js";