list-dashboards
Lists dashboards with pagination and service filtering. Supports fields selection and cursor-based navigation.
Instructions
List dashboards with pagination and service filtering
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Comma-separated fields to include (e.g. 'owners,tags,followers,charts') | |
| limit | No | Number of results per page | |
| before | No | Cursor for backward pagination | |
| after | No | Cursor for forward pagination | |
| service | No | Filter by service FQN | |
| include | No | Include deleted entities | non-deleted |
| 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/dashboards.ts:20-21 (handler)The actual handler function for list-dashboards — makes a GET request to /dashboards with the provided params (pagination, service filter, etc.).
export async function listDashboards(params: z.infer<typeof listDashboardsSchema>) { return omClient.get("/dashboards", params); - src/tools/dashboards.ts:10-18 (schema)Zod schema defining input parameters for list-dashboards: fields, limit (default 10), pagination cursors (before/after), service filter, include mode, and extractFields.
export const listDashboardsSchema = z.object({ fields: z.string().optional().describe("Comma-separated fields to include (e.g. 'owners,tags,followers,charts')"), limit: z.coerce.number().optional().default(10).describe("Number of results per page"), before: z.string().optional().describe("Cursor for backward pagination"), after: z.string().optional().describe("Cursor for forward pagination"), service: z.string().optional().describe("Filter by service FQN"), include: z.enum(["non-deleted", "deleted", "all"]).optional().default("non-deleted").describe("Include deleted entities"), extractFields: z.string().optional().describe(extractFieldsDescription), }); - src/index.ts:265-265 (registration)Registration of the list-dashboards tool in the MCP server under the 'discovery' category, with its schema and handler.
tool("list-dashboards", "List dashboards with pagination and service filtering", listDashboardsSchema.shape, wrapToolHandler(listDashboards));