get-glossary-by-name
Retrieve a glossary's full details, including terms and metadata, by providing its unique qualified name.
Instructions
Get glossary details by name
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| fqn | Yes | Glossary name | |
| 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:40-43 (handler)The actual handler function that executes the get-glossary-by-name tool logic. It takes params with 'fqn' (fully qualified name), makes a GET request to /glossaries/name/{fqn} via omClient.
export async function getGlossaryByName(params: z.infer<typeof getGlossaryByNameSchema>) { const { fqn, ...query } = params; return omClient.get(`/glossaries/name/${encodeURIComponent(fqn)}`, query); } - src/tools/glossary.ts:34-38 (schema)Zod schema for getGlossaryByName input validation. Defines 'fqn' (string), optional 'fields', and optional 'extractFields'.
export const getGlossaryByNameSchema = z.object({ fqn: z.string().describe("Glossary name"), fields: z.string().optional(), extractFields: ef, }); - src/index.ts:248-248 (registration)Registration of the 'get-glossary-by-name' tool using the MCP tool() function, with description and wrapped handler.
tool("get-glossary-by-name", "Get glossary details by name", getGlossaryByNameSchema.shape, wrapToolHandler(getGlossaryByName)); - src/index.ts:48-52 (helper)Import of getGlossaryByNameSchema and getGlossaryByName from src/tools/glossary.ts into the main index file.
import { listGlossariesSchema, listGlossaries, getGlossarySchema, getGlossary, getGlossaryByNameSchema, getGlossaryByName, createGlossarySchema, createGlossary, updateGlossarySchema, updateGlossary, deleteGlossarySchema, deleteGlossary, listGlossaryTermsSchema, listGlossaryTerms, getGlossaryTermSchema, getGlossaryTerm,