Skip to main content
Glama
ddukbg

GitHub Enterprise MCP Server

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
NameRequiredDescriptionDefault
ownerYesRepository owner
repoYesRepository name
pageNoPage number
perPageNoItems per page

Implementation Reference

  • 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}`
            }
          ]
        };
      }
    }
  • 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")
    },
  • 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}`
              }
            ]
          };
        }
      }
    );
  • 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
      };
    }
    
    /**
  • 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
        }
      });
    }
Behavior1/5

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

Tool has no description.

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

Conciseness1/5

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

Tool has no description.

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

Completeness1/5

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

Tool has no description.

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

Parameters1/5

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

Tool has no description.

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

Purpose1/5

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

Tool has no description.

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

Usage Guidelines1/5

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

Tool has no description.

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/ddukbg/github-enterprise-mcp'

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