list-dashboard-services
Retrieve dashboard services from OpenMetadata with optional filtering by fields, limit, pagination, and deletion status.
Instructions
List dashboard services
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Comma-separated fields to include | |
| limit | No | ||
| before | No | ||
| after | No | ||
| include | No | non-deleted |
Implementation Reference
- src/tools/services.ts:83-85 (handler)The handler function that executes the 'list-dashboard-services' tool logic. It makes a GET request to '/services/dashboardServices' with query params (fields, limit, before, after, include).
export async function listDashboardServices(params: z.infer<typeof listDashboardServicesSchema>) { return omClient.get("/services/dashboardServices", params); } - src/tools/services.ts:5-11 (schema)The schema (listParams) reused as listDashboardServicesSchema. Defines input validation: optional fields, limit with default 10, pagination cursors, and include filter.
const listParams = z.object({ fields: z.string().optional().describe("Comma-separated fields to include"), limit: z.coerce.number().optional().default(10), before: z.string().optional(), after: z.string().optional(), include: z.enum(["non-deleted", "deleted", "all"]).optional().default("non-deleted"), }); - src/index.ts:220-220 (registration)Registration of the tool with name 'list-dashboard-services', description 'List dashboard services', using the schema shape and wrapped handler.
tool("list-dashboard-services", "List dashboard services", listDashboardServicesSchema.shape, wrapToolHandler(listDashboardServices));