get-test-case-by-name
Retrieve a test case by its fully qualified name. Optionally specify fields and inclusion status to get detailed metadata.
Instructions
Get test case by fully qualified name
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| fqn | Yes | Fully qualified name of the test case | |
| fields | No | Comma-separated fields to include | |
| include | No |
Implementation Reference
- src/tools/data-quality.ts:87-90 (handler)The handler function that executes the 'get-test-case-by-name' tool. It takes a 'fqn' (fully qualified name) and optional 'fields'/'include' params, then makes a GET request to /dataQuality/testCases/name/{fqn}.
export async function getTestCaseByName(params: z.infer<typeof getTestCaseByNameSchema>) { const { fqn, ...query } = params; return omClient.get(`/dataQuality/testCases/name/${encodeURIComponent(fqn)}`, query); } - src/tools/data-quality.ts:81-85 (schema)The Zod schema for 'get-test-case-by-name'. Defines the input parameters: 'fqn' (required string), 'fields' (optional string), and 'include' (optional enum).
export const getTestCaseByNameSchema = z.object({ fqn: z.string().describe("Fully qualified name of the test case"), fields: z.string().optional().describe("Comma-separated fields to include"), include: z.enum(["non-deleted", "deleted", "all"]).optional(), }); - src/index.ts:386-386 (registration)Tool registration using the MCP server's tool() function with schema and handler.
tool("get-test-case-by-name", "Get test case by fully qualified name", getTestCaseByNameSchema.shape, wrapToolHandler(getTestCaseByName)); - src/index.ts:107-112 (registration)Import statement for the getTestCaseByName handler and schema from the data-quality module.
import { listTestSuitesSchema, listTestSuites, getTestSuiteSchema, getTestSuite, getTestSuiteByNameSchema, getTestSuiteByName, listTestCasesSchema, listTestCases, getTestCaseSchema, getTestCase, getTestCaseByNameSchema, getTestCaseByName, listTestCaseResultsSchema, listTestCaseResults, } from "./tools/data-quality.js";