list-workflows
Retrieve and manage GitHub Enterprise repository workflows by specifying the owner, repository, page number, and items per page to streamline workflow management and monitoring.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| owner | Yes | Repository owner | |
| page | No | Page number | |
| perPage | No | Items per page | |
| repo | Yes | Repository name |
Implementation Reference
- server/index.ts:1177-1235 (handler)MCP tool handler for 'list-workflows': validates parameters, calls ActionsAPI.listWorkflows, formats results with formatWorkflow, returns formatted list or errorasync ({ owner, repo, page, perPage }) => { 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." } ] }; } const response = await context.actions.listWorkflows(owner, repo, page, perPage); if (!response.workflows || response.workflows.length === 0) { return { content: [ { type: "text", text: `No workflows found in repository '${owner}/${repo}'.` } ] }; } const formattedWorkflows = response.workflows.map(formatWorkflow); return { content: [ { type: "text", text: `Workflows in repository '${owner}/${repo}' (${response.total_count}):\n\n${JSON.stringify(formattedWorkflows, null, 2)}` } ] }; } catch (error: any) { return { content: [ { type: "text", text: `Error listing workflows: ${error.message}` } ] }; } }
- server/index.ts:1169-1176 (registration)Registration of the 'list-workflows' MCP tool with Zod input schema (owner, repo, optional page/perPage)server.tool( "list-workflows", { owner: z.string().min(1).describe("Repository owner"), repo: z.string().min(1).describe("Repository name"), page: z.number().int().positive().optional().describe("Page number"), perPage: z.number().int().positive().optional().describe("Items per page") },
- api/actions/actions.ts:30-37 (helper)Core implementation: ActionsAPI.listWorkflows method that fetches workflows from GitHub API using GitHubClientasync listWorkflows(owner: string, repo: string, page = 1, perPage = 30): Promise<GitHubWorkflowListResponse> { return this.client.get<GitHubWorkflowListResponse>(`repos/${owner}/${repo}/actions/workflows`, { params: { page, per_page: perPage } }); }
- server/index.ts:116-127 (helper)formatWorkflow helper: formats individual workflow objects for user-friendly outputfunction formatWorkflow(workflow: any) { return { id: workflow.id, name: workflow.name, path: workflow.path, state: workflow.state, created_at: workflow.created_at, updated_at: workflow.updated_at, url: workflow.html_url, badge_url: workflow.badge_url }; }
- api/actions/types.ts:18-22 (schema)TypeScript interface for the workflow list response from GitHub APIexport interface GitHubWorkflowListResponse { total_count: number; workflows: GitHubWorkflow[]; }