get-test-suite-by-name
Retrieve a test suite by its fully qualified name from OpenMetadata. Optionally specify included fields and deletion status for refined results.
Instructions
Get test suite by fully qualified name
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| fqn | Yes | Fully qualified name of the test suite | |
| fields | No | Comma-separated fields to include | |
| include | No |
Implementation Reference
- src/tools/data-quality.ts:42-45 (handler)The handler function that executes the get-test-suite-by-name tool. It extracts the 'fqn' parameter and makes a GET request to /dataQuality/testSuites/name/{fqn} using the OpenMetadata API client.
export async function getTestSuiteByName(params: z.infer<typeof getTestSuiteByNameSchema>) { const { fqn, ...query } = params; return omClient.get(`/dataQuality/testSuites/name/${encodeURIComponent(fqn)}`, query); } - src/tools/data-quality.ts:36-40 (schema)Zod schema for get-test-suite-by-name tool, defining input parameters: fqn (required string), fields (optional string), include (optional enum 'non-deleted', 'deleted', 'all').
export const getTestSuiteByNameSchema = z.object({ fqn: z.string().describe("Fully qualified name of the test suite"), fields: z.string().optional().describe("Comma-separated fields to include"), include: z.enum(["non-deleted", "deleted", "all"]).optional(), }); - src/index.ts:383-383 (registration)Registration of the tool 'get-test-suite-by-name' with its schema and handler via the tool() function.
tool("get-test-suite-by-name", "Get test suite by fully qualified name", getTestSuiteByNameSchema.shape, wrapToolHandler(getTestSuiteByName)); - src/index.ts:107-112 (registration)Import of getTestSuiteByNameSchema and getTestSuiteByName from the data-quality tools module.
import { listTestSuitesSchema, listTestSuites, getTestSuiteSchema, getTestSuite, getTestSuiteByNameSchema, getTestSuiteByName, listTestCasesSchema, listTestCases, getTestCaseSchema, getTestCase, getTestCaseByNameSchema, getTestCaseByName, listTestCaseResultsSchema, listTestCaseResults, } from "./tools/data-quality.js";