get-glossary-term-by-name
Retrieve a glossary term by its fully qualified name. Optionally specify fields to extract for a reduced response.
Instructions
Get glossary term by fully qualified name
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| fqn | Yes | Term FQN (e.g. 'glossary.term') | |
| 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:118-121 (handler)The actual handler function that executes the tool logic. It takes 'fqn' (fully qualified name like 'glossary.term') and optional 'fields'/'extractFields' query params, then calls omClient.get() to fetch the glossary term by name from the API endpoint /glossaryTerms/name/{fqn}.
export async function getGlossaryTermByName(params: z.infer<typeof getGlossaryTermByNameSchema>) { const { fqn, ...query } = params; return omClient.get(`/glossaryTerms/name/${encodeURIComponent(fqn)}`, query); } - src/tools/glossary.ts:112-116 (schema)Zod schema for input validation. Accepts 'fqn' (required string), optional 'fields' string, and optional 'extractFields' string.
export const getGlossaryTermByNameSchema = z.object({ fqn: z.string().describe("Term FQN (e.g. 'glossary.term')"), fields: z.string().optional(), extractFields: ef, }); - src/index.ts:257-257 (registration)Tool registration using the MCP server's tool() function, binding the schema and handler together under the name 'get-glossary-term-by-name'.
tool("get-glossary-term-by-name", "Get glossary term by fully qualified name", getGlossaryTermByNameSchema.shape, wrapToolHandler(getGlossaryTermByName)); - src/index.ts:48-55 (helper)Import statement bringing getGlossaryTermByNameSchema and getGlossaryTermByName into index.ts from src/tools/glossary.ts.
import { listGlossariesSchema, listGlossaries, getGlossarySchema, getGlossary, getGlossaryByNameSchema, getGlossaryByName, createGlossarySchema, createGlossary, updateGlossarySchema, updateGlossary, deleteGlossarySchema, deleteGlossary, listGlossaryTermsSchema, listGlossaryTerms, getGlossaryTermSchema, getGlossaryTerm, getGlossaryTermByNameSchema, getGlossaryTermByName, createGlossaryTermSchema, createGlossaryTerm, updateGlossaryTermSchema, updateGlossaryTerm, deleteGlossaryTermSchema, deleteGlossaryTerm, } from "./tools/glossary.js";