trigger-workflow
Manually trigger GitHub Actions workflows in GitHub Enterprise repositories by specifying repository details, workflow identifier, and branch reference.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| owner | Yes | Repository owner | |
| repo | Yes | Repository name | |
| workflow_id | Yes | Workflow ID or file name | |
| ref | Yes | Git reference (branch, tag, SHA) | |
| inputs | No | Workflow inputs |
Implementation Reference
- server/index.ts:1320-1398 (registration)Full MCP tool registration for 'trigger-workflow', including Zod input schema, handler function with validation and dispatch logicserver.tool( "trigger-workflow", { owner: z.string().min(1).describe("Repository owner"), repo: z.string().min(1).describe("Repository name"), workflow_id: z.union([z.string(), z.number()]).describe("Workflow ID or file name"), ref: z.string().min(1).describe("Git reference (branch, tag, SHA)"), inputs: z.record(z.string()).optional().describe("Workflow inputs") }, async ({ owner, repo, workflow_id, ref, inputs }) => { try { // Parameter validation if (!owner || typeof owner !== 'string' || owner.trim() === '') { return { content: [ { type: "text", text: "Repository owner is required." } ] }; } if (!repo || typeof repo !== 'string' || repo.trim() === '') { return { content: [ { type: "text", text: "Repository name is required." } ] }; } if (!workflow_id) { return { content: [ { type: "text", text: "Workflow ID or filename is required." } ] }; } if (!ref || typeof ref !== 'string' || ref.trim() === '') { return { content: [ { type: "text", text: "Git reference (branch, tag, or SHA) is required." } ] }; } await context.actions.dispatchWorkflow(owner, repo, workflow_id, { ref, inputs }); return { content: [ { type: "text", text: `Successfully triggered workflow '${workflow_id}' in repository '${owner}/${repo}' on ref '${ref}'.` } ] }; } catch (error: any) { return { content: [ { type: "text", text: `Error triggering workflow: ${error.message}` } ] }; } } );
- api/actions/actions.ts:118-126 (handler)Core handler function dispatchWorkflow in ActionsAPI that performs the actual GitHub API POST to trigger workflow_dispatch* Trigger a workflow run (workflow_dispatch event) * @param owner Repository owner * @param repo Repository name * @param workflowId Workflow ID or file name * @param options Options for workflow dispatch */ async dispatchWorkflow(owner: string, repo: string, workflowId: number | string, options: WorkflowDispatchOptions): Promise<void> { await this.client.post(`repos/${owner}/${repo}/actions/workflows/${workflowId}/dispatches`, options); }
- api/actions/types.ts:104-106 (schema)TypeScript interface defining the options structure for workflow dispatch, matching the tool's inputs (ref and optional inputs)export interface WorkflowDispatchOptions { ref: string; // The git reference for the workflow (branch, tag, HEAD) inputs?: Record<string, string>; // Input parameters defined in the workflow file