list-pipelines
Retrieve a paginated list of pipelines, filterable by service and configurable fields, to access pipeline metadata.
Instructions
List pipelines 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,tasks') | |
| 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/pipelines.ts:20-22 (handler)Handler function that executes the list-pipelines tool. Makes a GET request to /pipelines with the provided parameters (fields, limit, before, after, service, include, extractFields).
export async function listPipelines(params: z.infer<typeof listPipelinesSchema>) { return omClient.get("/pipelines", params); } - src/tools/pipelines.ts:10-18 (schema)Zod schema definition for list-pipelines input parameters: fields, limit (default 10), before/after cursors, service filter, include (default 'non-deleted'), and extractFields.
export const listPipelinesSchema = z.object({ fields: z.string().optional().describe("Comma-separated fields to include (e.g. 'owners,tags,followers,tasks')"), 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: ef, }); - src/index.ts:274-274 (registration)Registration of the 'list-pipelines' tool with the MCP server using the schema shape and wrapped handler.
tool("list-pipelines", "List pipelines with pagination and service filtering", listPipelinesSchema.shape, wrapToolHandler(listPipelines)); - src/tools/utils.ts:18-22 (helper)The wrapToolHandler helper that wraps the handler with error handling and redaction logic (used by the registration).
export const wrapToolHandler = createWrapToolHandler({ redactionPatterns: [/OPENMETADATA_TOKEN/i], errorExtractors: [ { match: (error) => error instanceof WriteBlockedError,