Skip to main content
Glama

github_code_scanning_update_alert

Update a GitHub code scanning alert by sending a request body with new details.

Instructions

Update a code scanning alert

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
ownerYesowner
repoYesrepo
alert_numberYesalert_number
bodyNoRequest body (JSON object)

Implementation Reference

  • The handler function that executes the 'github_code_scanning_update_alert' tool logic. It sends a PATCH request to the GitHub API to update a code scanning alert.
    handler: async (args: Record<string, any>) => {
      return githubRequest("PATCH", `/repos/${args.owner}/${args.repo}/code-scanning/alerts/${args.alert_number}`, args.body, undefined);
    },
  • Input schema for the tool using Zod validation. Expects 'owner', 'repo', 'alert_number' (all strings), and an optional 'body' (JSON object).
    inputSchema: z.object({
      owner: z.string().describe("owner"),
      repo: z.string().describe("repo"),
      alert_number: z.string().describe("alert_number"),
      body: z.record(z.string(), z.unknown()).optional().describe("Request body (JSON object)")
    }),
  • Tool name and description registration. The tool is defined as part of the exported 'codeScanningTools' array.
    name: "github_code_scanning_update_alert",
    description: "Update a code scanning alert",
  • src/index.ts:64-64 (registration)
    The 'codeScanningTools' array is registered as a tool module in the MCP server under the 'code-scanning' category.
    { category: "code-scanning", tools: codeScanningTools },
  • The githubRequest helper function that makes authenticated HTTP requests to the GitHub API. Used by the handler to perform the PATCH 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>;
    }
Behavior2/5

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

With no annotations, the description carries full burden. It only says 'update' without explaining what the update entails (e.g., partial vs full, required fields, side effects, permissions). This is insufficient for an agent to understand the tool's behavior.

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?

The description is a single sentence, which is concise and front-loaded. However, it is too minimal and omits essential context, making it less useful than it could be.

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?

Given the lack of annotations, output schema, and rich parameter descriptions, the tool's description is incomplete. An agent cannot determine the expected input format for 'body' or the response format, which are critical for correct invocation.

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

Parameters2/5

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

Schema descriptions are trivial (e.g., 'owner', 'repo', 'alert_number'), and the 'body' parameter is described only as 'Request body (JSON object)' without detailing its structure. The tool description adds no additional meaning beyond the schema, so the agent lacks guidance on how to construct the body.

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

Purpose4/5

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

The description 'Update a code scanning alert' clearly states the verb and resource, making it easy to understand the tool's purpose. However, it does not explicitly differentiate from siblings like read-only or delete operations, which slightly reduces clarity.

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 is provided on when to use this tool versus alternatives (e.g., get_alert or commit_autofix). The agent is left to infer usage context without any explicit direction.

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