list-workflows
Retrieve and display GitHub Enterprise repository workflows to monitor automation processes, manage CI/CD pipelines, and track execution status.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| owner | Yes | Repository owner | |
| repo | Yes | Repository name | |
| page | No | Page number | |
| perPage | No | Items per page |
Implementation Reference
- server/index.ts:1177-1235 (handler)Main handler function for the 'list-workflows' MCP tool. It validates owner and repo parameters, calls ActionsAPI.listWorkflows to fetch workflows, formats the results using formatWorkflow helper, and returns a formatted text response or error message.async ({ 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:1171-1176 (schema)Input schema using Zod for validating parameters: owner (string), repo (string), page (optional number), perPage (optional number).{ 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") },
- server/index.ts:1169-1236 (registration)Registration of the 'list-workflows' tool on the MCP server using server.tool(name, schema, handler).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") }, async ({ 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:115-129 (helper)formatWorkflow helper function that formats individual workflow objects for user-friendly output, selecting key fields like id, name, path, state, dates, urls.*/ function 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/actions.ts:23-37 (helper)ActionsAPI.listWorkflows method, the core API call to GitHub's /repos/{owner}/{repo}/actions/workflows endpoint to retrieve the list of workflows./** * List workflows in a repository * @param owner Repository owner * @param repo Repository name * @param page Page number * @param perPage Items per page */ async 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 } }); }