get-data-product-by-name
Retrieve details of a data product using its fully qualified name. Specify fields and include status for customized results.
Instructions
Get data product by fully qualified name
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| fqn | Yes | Fully qualified name of the data product | |
| fields | No | Comma-separated fields to include | |
| include | No |
Implementation Reference
- src/tools/domains.ts:123-127 (schema)Zod schema defining the input for get-data-product-by-name: requires 'fqn' (fully qualified name), optional 'fields' and 'include'.
export const getDataProductByNameSchema = z.object({ fqn: z.string().describe("Fully qualified name of the data product"), fields: z.string().optional().describe("Comma-separated fields to include"), include: z.enum(["non-deleted", "deleted", "all"]).optional(), }); - src/tools/domains.ts:129-132 (handler)Handler function that calls the API endpoint /dataProducts/name/{fqn} to get a data product by its fully qualified name.
export async function getDataProductByName(params: z.infer<typeof getDataProductByNameSchema>) { const { fqn, ...query } = params; return omClient.get(`/dataProducts/name/${encodeURIComponent(fqn)}`, query); } - src/index.ts:347-347 (registration)Registration of the tool with name 'get-data-product-by-name', description, schema shape, and wrapped handler.
tool("get-data-product-by-name", "Get data product by fully qualified name", getDataProductByNameSchema.shape, wrapToolHandler(getDataProductByName));