Skip to main content
Glama

github_apps_get_webhook_config_for_app

Retrieve the webhook configuration for a GitHub App to inspect current settings. Ideal for auditing or debugging webhook payloads.

Instructions

Get a webhook configuration for an app

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • The handler function that executes the tool logic. It makes a GET request to `/app/hook/config` to retrieve the webhook configuration for the GitHub App.
    handler: async (args: Record<string, any>) => {
      return githubRequest("GET", `/app/hook/config`, undefined, undefined);
    },
  • The input schema for the tool. It takes no parameters (`z.object({})`).
    inputSchema: z.object({}),
  • src/tools/apps.ts:5-31 (registration)
    The tool definition is part of the `appsTools` array exported from `src/tools/apps.ts`. The tool object has name, description, inputSchema, and handler fields.
    export const appsTools = [
      {
        name: "github_apps_get_authenticated",
        description: "Get the authenticated app",
        inputSchema: z.object({}),
        handler: async (args: Record<string, any>) => {
          return githubRequest("GET", `/app`, undefined, undefined);
        },
      },
      {
        name: "github_apps_create_from_manifest",
        description: "Create a GitHub App from a manifest",
        inputSchema: z.object({
          code: z.string().describe("code")
        }),
        handler: async (args: Record<string, any>) => {
          return githubRequest("POST", `/app-manifests/${args.code}/conversions`, undefined, undefined);
        },
      },
      {
        name: "github_apps_get_webhook_config_for_app",
        description: "Get a webhook configuration for an app",
        inputSchema: z.object({}),
        handler: async (args: Record<string, any>) => {
          return githubRequest("GET", `/app/hook/config`, undefined, undefined);
        },
      },
  • src/index.ts:110-130 (registration)
    Tools are registered via `server.tool()` in a loop over all tool modules. Each tool's name, description, inputSchema, and handler are passed to the MCP server.
    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 that makes authenticated HTTP requests to the GitHub API. It's used by the tool handler to execute the 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>;
    }
Behavior2/5

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

No annotations provided, and the description only states the action without disclosing behavioral details such as authentication requirements, rate limits, or what the configuration contains. Minimal transparency.

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

Conciseness5/5

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

Single sentence, perfectly concise, no extraneous information. Every word is necessary.

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?

With no parameters, no output schema, and no annotations, the description is too minimal. It does not explain what constitutes a webhook configuration or the return structure, leaving the agent uninformed.

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

Parameters4/5

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

Input schema has no parameters (0 params), so baseline is 4. Description adds nothing beyond the schema, but schema coverage is 100% and no param info is needed.

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?

Description clearly states it retrieves a webhook configuration for an app. Differentiates from siblings targeting different scopes like org or repo, but could be more specific about it being for the authenticated 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 like updating the config or listing deliveries. Agent has no context for decision-making.

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