Skip to main content
Glama

github_classroom_get_a_classroom

Retrieve details of a specific GitHub Classroom using its classroom ID.

Instructions

Get a classroom

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
classroom_idYesclassroom_id

Implementation Reference

  • Handler function for github_classroom_get_a_classroom. It makes a GET request to /classrooms/{classroom_id} to fetch a classroom by its ID.
    handler: async (args: Record<string, any>) => {
      return githubRequest("GET", `/classrooms/${args.classroom_id}`, undefined, undefined);
    },
  • Input schema for github_classroom_get_a_classroom. Expects a single required parameter: classroom_id (string).
    inputSchema: z.object({
      classroom_id: z.string().describe("classroom_id")
    }),
  • Registration of github_classroom_get_a_classroom as a tool definition in the classroomTools array.
    {
      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);
      },
    },
  • src/index.ts:110-130 (registration)
    All tools (including github_classroom_get_a_classroom) are registered with the MCP server via server.tool() in a loop. The tool's name, description, inputSchema, and handler are wired together here.
    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,
            };
          }
        }
      );
    }
  • The githubRequest helper function used by the handler to make authenticated HTTP requests to the GitHub REST API.
    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>;
    }
Behavior1/5

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

With no annotations, description carries full burden. It does not disclose read-only nature, auth requirements, or any side effects. Just 'Get' implies safety but no explicit confirmation.

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

Conciseness3/5

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

Extremely short (two words), but appropriate for a simple retrieval. Lacks detail but not verbose. Could be more informative without losing conciseness.

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

Completeness2/5

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

No output schema, so description should explain what is returned. It does not. Also missing behavioral context like rate limits or data scope. Incomplete for agent decision-making.

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

Parameters3/5

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

Schema coverage is 100% with parameter description 'classroom_id'. Tool description adds no parameter info beyond schema, baseline 3.

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

Purpose3/5

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

Description states 'Get a classroom', which is a clear verb+resource pair, but lacks differentiation from sibling tools like 'list_classrooms' or 'get_an_assignment'.

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

Usage Guidelines2/5

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

No guidance on when to use this tool vs alternatives (e.g., listing classrooms when id is unknown). No prerequisites or context provided.

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

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