update-pipeline
Modify a pipeline in OpenMetadata by applying JSON Patch operations to update fields such as description or other attributes.
Instructions
Update a pipeline using JSON Patch operations
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Pipeline UUID to update | |
| operations | Yes | JSON Patch operations array (e.g. [{op:'add', path:'/description', value:'...'}]) |
Implementation Reference
- src/tools/pipelines.ts:77-80 (handler)The handler function for the update-pipeline tool. It asserts write permissions are enabled, then sends a PATCH request to `/pipelines/{id}` with JSON Patch operations.
export async function updatePipeline(params: z.infer<typeof updatePipelineSchema>) { assertWriteAllowed(); return omClient.patch(`/pipelines/${params.id}`, params.operations); } - src/tools/pipelines.ts:72-75 (schema)Zod schema defining the input for update-pipeline: requires a pipeline UUID (id) and an array of JSON Patch operations.
export const updatePipelineSchema = z.object({ id: z.string().describe("Pipeline UUID to update"), operations: z.array(z.record(z.string(), z.any())).describe("JSON Patch operations array (e.g. [{op:'add', path:'/description', value:'...'}])"), }); - src/index.ts:278-278 (registration)Registration of the update-pipeline tool with the MCP server: name, description, schema shape, and wrapped handler.
tool("update-pipeline", "Update a pipeline using JSON Patch operations", updatePipelineSchema.shape, wrapToolHandler(updatePipeline)); - src/tools/utils.ts:12-16 (helper)Helper function called by the handler to check if write operations are allowed before making the API call.
export function assertWriteAllowed(): void { if (!config.allowWrite) { throw new WriteBlockedError(); } } - src/tools/utils.ts:18-20 (helper)The wrapToolHandler utility that wraps the handler function to provide error handling and redaction.
export const wrapToolHandler = createWrapToolHandler({ redactionPatterns: [/OPENMETADATA_TOKEN/i], errorExtractors: [