github_classroom_list_classrooms

Instructions

Implementation Reference

• src/tools/classroom.ts:39-48 (handler)

  Tool handler for github_classroom_list_classrooms - makes a GET request to /classrooms with optional pagination parameters

    name: "github_classroom_list_classrooms",
    description: "List classrooms",
    inputSchema: z.object({
      page: z.number().optional().describe("The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""),
      per_page: z.number().optional().describe("The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"")
    }),
    handler: async (args: Record<string, any>) => {
      return githubRequest("GET", `/classrooms`, undefined, { page: args.page, per_page: args.per_page });
    },
  },

• src/tools/classroom.ts:41-44 (schema)

  Input schema defining optional page and per_page parameters for the list classrooms tool

  inputSchema: z.object({
    page: z.number().optional().describe("The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""),
    per_page: z.number().optional().describe("The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"")
  }),

• src/tools/classroom.ts:5-71 (registration)

  The classroomTools array contains all classroom-related tool definitions including github_classroom_list_classrooms

  export const classroomTools = [
    {
      name: "github_classroom_get_an_assignment",
      description: "Get an assignment",
      inputSchema: z.object({
        assignment_id: z.string().describe("assignment_id")
      }),
      handler: async (args: Record<string, any>) => {
        return githubRequest("GET", `/assignments/${args.assignment_id}`, undefined, undefined);
      },
    },
    {
      name: "github_classroom_list_accepted_assignments_for_an_assignment",
      description: "List accepted assignments for an assignment",
      inputSchema: z.object({
        assignment_id: z.string().describe("assignment_id"),
        page: z.number().optional().describe("The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""),
        per_page: z.number().optional().describe("The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"")
      }),
      handler: async (args: Record<string, any>) => {
        return githubRequest("GET", `/assignments/${args.assignment_id}/accepted_assignments`, undefined, { page: args.page, per_page: args.per_page });
      },
    },
    {
      name: "github_classroom_get_assignment_grades",
      description: "Get assignment grades",
      inputSchema: z.object({
        assignment_id: z.string().describe("assignment_id")
      }),
      handler: async (args: Record<string, any>) => {
        return githubRequest("GET", `/assignments/${args.assignment_id}/grades`, undefined, undefined);
      },
    },
    {
      name: "github_classroom_list_classrooms",
      description: "List classrooms",
      inputSchema: z.object({
        page: z.number().optional().describe("The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""),
        per_page: z.number().optional().describe("The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"")
      }),
      handler: async (args: Record<string, any>) => {
        return githubRequest("GET", `/classrooms`, undefined, { page: args.page, per_page: args.per_page });
      },
    },
    {
      name: "github_classroom_get_a_classroom",
      description: "Get a classroom",
      inputSchema: z.object({
        classroom_id: z.string().describe("classroom_id")
      }),
      handler: async (args: Record<string, any>) => {
        return githubRequest("GET", `/classrooms/${args.classroom_id}`, undefined, undefined);
      },
    },
    {
      name: "github_classroom_list_assignments_for_a_classroom",
      description: "List assignments for a classroom",
      inputSchema: z.object({
        classroom_id: z.string().describe("classroom_id"),
        page: z.number().optional().describe("The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""),
        per_page: z.number().optional().describe("The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"")
      }),
      handler: async (args: Record<string, any>) => {
        return githubRequest("GET", `/classrooms/${args.classroom_id}/assignments`, undefined, { page: args.page, per_page: args.per_page });
      },
    },
  ];

• src/index.ts:110-130 (registration)

  Tools are registered with the MCP server by iterating over all tool modules and calling server.tool() with name, description, schema, and handler

  for (const tool of allTools) {
    server.tool(
      tool.name,
      tool.description,
      tool.inputSchema.shape as any,
      async (args: any) => {
        try {
          const result = await tool.handler(args as any);
          return {
            content: [{ type: "text" as const, text: JSON.stringify(result, null, 2) }],
          };
        } catch (err) {
          const message = err instanceof Error ? err.message : String(err);
          return {
            content: [{ type: "text" as const, text: `Error: ${message}` }],
            isError: true,
          };
        }
      }
    );
  }

• src/client.ts:9-59 (helper)

  Helper function that makes authenticated HTTP requests to the GitHub REST API, used by the tool handler to call GET /classrooms

  export async function githubRequest<T>(
    method: string,
    path: string,
    body?: Record<string, unknown>,
    params?: Record<string, string | number | boolean | string[] | undefined>
  ): Promise<T> {
    const url = new URL(`${BASE_URL}${path}`);
  
    if (params) {
      for (const [key, value] of Object.entries(params)) {
        if (value === undefined || value === null || value === "") continue;
        if (Array.isArray(value)) {
          url.searchParams.set(key, value.join(","));
        } else {
          url.searchParams.set(key, String(value));
        }
      }
    }
  
    const headers: Record<string, string> = {
      Authorization: `Bearer ${getToken()}`,
      Accept: "application/vnd.github+json",
      "X-GitHub-Api-Version": "2022-11-28",
      "User-Agent": "github-mcp/1.0.0",
    };
  
    if (body) {
      headers["Content-Type"] = "application/json";
    }
  
    const res = await fetch(url.toString(), {
      method,
      headers,
      body: body ? JSON.stringify(body) : undefined,
    });
  
    if (!res.ok) {
      const text = await res.text().catch(() => "");
      let detail = text;
      try {
        const json = JSON.parse(text);
        detail = json.message || text;
        if (json.errors) detail += ` -- ${JSON.stringify(json.errors)}`;
      } catch {}
      throw new Error(`GitHub API error ${res.status}: ${detail}`);
    }
  
    if (res.status === 204) return {} as T;
  
    return res.json() as Promise<T>;
  }