Skip to main content
Glama

github_apps_update_webhook_config_for_app

Update the webhook configuration for a GitHub App to modify its event subscriptions and URL settings.

Instructions

Update a webhook configuration for an app

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
bodyNoRequest body (JSON object)

Implementation Reference

  • The handler function for github_apps_update_webhook_config_for_app. It makes a PATCH request to '/app/hook/config' with the request body passed as args.body.
    handler: async (args: Record<string, any>) => {
      return githubRequest("PATCH", `/app/hook/config`, args.body, undefined);
    },
  • Input schema for github_apps_update_webhook_config_for_app, defining an optional 'body' field as a record of string keys to unknown values (JSON object).
    inputSchema: z.object({
      body: z.record(z.string(), z.unknown()).optional().describe("Request body (JSON object)")
    }),
  • Tool registration object for github_apps_update_webhook_config_for_app, with name and description defined as part of the appsTools array.
      name: "github_apps_update_webhook_config_for_app",
      description: "Update a webhook configuration for an app",
      inputSchema: z.object({
        body: z.record(z.string(), z.unknown()).optional().describe("Request body (JSON object)")
      }),
      handler: async (args: Record<string, any>) => {
        return githubRequest("PATCH", `/app/hook/config`, args.body, undefined);
      },
    },
  • src/index.ts:110-129 (registration)
    MCP server registration loop in src/index.ts that registers all tools (including this one) using server.tool(), wiring up name, description, input 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,
            };
          }
        }
      );
  • The githubRequest helper function used by the handler to make authenticated HTTP requests to the GitHub 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>;
    }
Behavior2/5

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

No annotations are provided, so the description must fully disclose behavioral traits. It only states 'Update', implying mutation, but does not explain what aspects of the webhook configuration are updated, whether the operation is destructive, any authentication requirements, or rate limits. The parameter 'body' is vague without further details.

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

Conciseness4/5

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

The description is a single sentence with no fluff. It is concise, but could be slightly more informative without being verbose. No structural issues.

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 and output schema, the description is too sparse. It does not explain the scope (the authenticated app), the required body structure, return values, or how it differs from similar tools (e.g., update_webhook_config_for_org). The agent is left with significant ambiguity.

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% (the only parameter 'body' has a description: 'Request body (JSON object)'). However, the description adds no additional meaning beyond the schema. The body's expected properties are not explained, so the agent lacks context on how to structure the request.

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

Purpose5/5

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

The name and description 'Update a webhook configuration for an app' clearly state the verb (Update) and resource (webhook configuration). It distinguishes itself from sibling tools like get_webhook_config_for_app, update_webhook_config_for_org, and update_webhook_config_for_repo by specifying 'for app'.

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 versus alternatives. It does not mention prerequisites, context, or situations where this tool is preferred over get_webhook_config_for_app or the org/repo variants.

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