Skip to main content
Glama

update_workflow

Modify existing workflows by updating specific fields. Changes to live workflows create drafts for review before activation.

Instructions

Update an existing workflow. Provide only the fields you want to change.

IMPORTANT: If the workflow is live, config edits (steps, context, name, etc.) are automatically routed to a draft snapshot instead of modifying the live pipeline. The response will include editingDraft: true. Use get_draft to view the draft, promote_draft to make it live, or discard_draft to throw away the changes. Non-live workflows are updated directly with an automatic pre-edit snapshot for rollback.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
workflowIdYesThe workflow ID to update
updatesYesPartial pipeline updates (name, steps, context, etc.)
localeNoLocale (default: en)

Implementation Reference

  • The update_workflow tool handler implementation in src/tools/workflows.ts which calls client.updateWorkflow.
        server.tool(
            'update_workflow',
            `Update an existing workflow. Provide only the fields you want to change.
    
    IMPORTANT: If the workflow is live, config edits (steps, context, name, etc.) are automatically
    routed to a draft snapshot instead of modifying the live pipeline. The response will include
    editingDraft: true. Use get_draft to view the draft, promote_draft to make it live, or
    discard_draft to throw away the changes. Non-live workflows are updated directly with an
    automatic pre-edit snapshot for rollback.`,
            {
                workflowId: z.string().describe('The workflow ID to update'),
                updates: z.record(z.string(), z.any()).describe('Partial pipeline updates (name, steps, context, etc.)'),
                locale: z.string().optional().describe('Locale (default: en)'),
            },
            async ({ workflowId, updates, locale }, extra) => {
                const client = clientFactory(extra);
                const result = await client.updateWorkflow(workflowId, updates, locale);
                return {
                    content: [{
                        type: 'text' as const,
                        text: JSON.stringify(result, null, 2),
                    }],
                };
            }
        );
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full burden and excels. It discloses critical behavioral traits: the draft mechanism for live workflows (including the editingDraft response), automatic snapshot creation for rollback, and the distinction between live and non-live workflow updates. This goes beyond basic schema information to explain system behavior.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is front-loaded with the core purpose, followed by important behavioral details in a logical flow. Every sentence earns its place by explaining key usage scenarios and system behavior without redundancy. It's appropriately sized for a complex tool with multiple behavioral nuances.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the complexity (mutation tool with draft mechanisms) and no annotations/output schema, the description does an excellent job covering behavioral aspects. It explains the update process, draft handling, and related tools. A minor gap is the lack of explicit mention of error conditions or response format details, but it's largely complete for agent use.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the baseline is 3. The description adds value by clarifying that updates should be partial ('Provide only the fields you want to change') and listing example fields (name, steps, context, etc.), which enhances understanding beyond the schema's 'Partial pipeline updates' description. However, it doesn't detail the locale parameter.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the specific action ('Update an existing workflow') and resource ('workflow'), distinguishing it from siblings like create_workflow, delete_workflow, and update_step. It provides precise scope by specifying 'Provide only the fields you want to change' and mentions config elements like steps, context, and name.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description explicitly states when to use this tool vs alternatives: it explains that for live workflows, edits go to a draft, and directs users to get_draft, promote_draft, or discard_draft for further actions. It also distinguishes from non-live workflows, which are updated directly, and mentions related tools like get_draft.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/Agentled/mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server