Skip to main content
Glama

list_issues

Retrieve and filter GitHub repository issues by status, labels, sorting, and time parameters to manage project tracking and bug reporting.

Instructions

List issues in a GitHub repository with filtering options

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
ownerYes
repoYes
directionNo
labelsNo
pageNo
per_pageNo
sinceNo
sortNo
stateNo

Implementation Reference

  • The core handler function that implements the logic to list issues from a GitHub repository using the GitHub API.
    export async function listIssues(
      github_pat: string,
      owner: string,
      repo: string,
      options: Omit<z.infer<typeof ListIssuesOptionsSchema>, "owner" | "repo">
    ) {
      const urlParams: Record<string, string | undefined> = {
        direction: options.direction,
        labels: options.labels?.join(","),
        page: options.page?.toString(),
        per_page: options.per_page?.toString(),
        since: options.since,
        sort: options.sort,
        state: options.state
      };
    
      return githubRequest(
        github_pat,
        buildUrl(`https://api.github.com/repos/${owner}/${repo}/issues`, urlParams)
      );
    }
  • Zod schema defining the input parameters for the list_issues tool, used in tool registration.
    export const ListIssuesOptionsSchema = z.object({
      owner: z.string(),
      repo: z.string(),
      direction: z.enum(["asc", "desc"]).optional(),
      labels: z.array(z.string()).optional(),
      page: z.number().optional(),
      per_page: z.number().optional(),
      since: z.string().optional(),
      sort: z.enum(["created", "updated", "comments"]).optional(),
      state: z.enum(["open", "closed", "all"]).optional(),
    });
  • src/index.ts:128-132 (registration)
    Registration of the list_issues tool in the ListTools response, including name, description, and input schema reference.
    {
      name: "list_issues",
      description: "List issues in a GitHub repository with filtering options",
      inputSchema: zodToJsonSchema(issues.ListIssuesOptionsSchema)
    },
  • Dispatcher case in the CallToolRequest handler that parses arguments using the extended schema and invokes the listIssues function.
    case "list_issues": {
      const args = issues._ListIssuesOptionsSchema.parse(params.arguments);
      const { github_pat, owner, repo, ...options } = args;
      const result = await issues.listIssues(github_pat, owner, repo, options);
      return {
        content: [{ type: "text", text: JSON.stringify(result, null, 2) }],
      };
    }
  • Extended Zod schema used for argument parsing in the tool dispatcher, adding the github_pat field.
    export const _ListIssuesOptionsSchema = ListIssuesOptionsSchema.extend({
      github_pat: z.string().describe("GitHub Personal Access Token"),
    });

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

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