github_code_scanning_get_sarif

Instructions

Implementation Reference

• src/tools/code-scanning.ts:290-292 (handler)

  The handler function for github_code_scanning_get_sarif. Makes a GET request to the GitHub API endpoint /repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id} to retrieve information about a SARIF upload.

  handler: async (args: Record<string, any>) => {
    return githubRequest("GET", `/repos/${args.owner}/${args.repo}/code-scanning/sarifs/${args.sarif_id}`, undefined, undefined);
  },

• src/tools/code-scanning.ts:285-289 (schema)

  Zod input schema defining the required parameters: owner, repo, and sarif_id (all strings).

  inputSchema: z.object({
    owner: z.string().describe("owner"),
    repo: z.string().describe("repo"),
    sarif_id: z.string().describe("sarif_id")
  }),

• src/tools/code-scanning.ts:282-293 (registration)

  The tool definition object registered in the codeScanningTools array, containing name, description, inputSchema, and handler.

  {
    name: "github_code_scanning_get_sarif",
    description: "Get information about a SARIF upload",
    inputSchema: z.object({
      owner: z.string().describe("owner"),
      repo: z.string().describe("repo"),
      sarif_id: z.string().describe("sarif_id")
    }),
    handler: async (args: Record<string, any>) => {
      return githubRequest("GET", `/repos/${args.owner}/${args.repo}/code-scanning/sarifs/${args.sarif_id}`, undefined, undefined);
    },
  },

• src/index.ts:64-64 (registration)

  Registration of the code-scanning module (which contains github_code_scanning_get_sarif) in the MCP server's allToolModules array.

  { category: "code-scanning", tools: codeScanningTools },

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

  The githubRequest helper function that performs authenticated HTTP requests to the GitHub API. Used by the handler to make the actual GET request.

  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>;
  }