Skip to main content
Glama

github_campaigns_update_campaign

Update a GitHub campaign's properties by specifying the organization and campaign number, optionally sending a JSON body with new values.

Instructions

Update a campaign

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
orgYesorg
campaign_numberYescampaign_number
bodyNoRequest body (JSON object)

Implementation Reference

  • The handler function for github_campaigns_update_campaign. It calls githubRequest with PATCH method to /orgs/{org}/campaigns/{campaign_number}, passing the request body.
    handler: async (args: Record<string, any>) => {
      return githubRequest("PATCH", `/orgs/${args.org}/campaigns/${args.campaign_number}`, args.body, undefined);
    },
  • Input schema for github_campaigns_update_campaign: defines org (string), campaign_number (string), and optional body (record of string to unknown).
    inputSchema: z.object({
      org: z.string().describe("org"),
      campaign_number: z.string().describe("campaign_number"),
      body: z.record(z.string(), z.unknown()).optional().describe("Request body (JSON object)")
    }),
  • Registration of the 'github_campaigns_update_campaign' tool as part of the campaignsTools array, with name, description, inputSchema, and handler.
    {
      name: "github_campaigns_update_campaign",
      description: "Update a campaign",
      inputSchema: z.object({
        org: z.string().describe("org"),
        campaign_number: z.string().describe("campaign_number"),
        body: z.record(z.string(), z.unknown()).optional().describe("Request body (JSON object)")
      }),
      handler: async (args: Record<string, any>) => {
        return githubRequest("PATCH", `/orgs/${args.org}/campaigns/${args.campaign_number}`, args.body, undefined);
      },
    },
  • src/index.ts:110-130 (registration)
    The MCP server registration loop that registers all tools (including github_campaigns_update_campaign) via server.tool().
    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 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>;
    }
Behavior1/5

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

No annotations and the description provides no behavioral details (e.g., permissions, idempotency, error cases, return value). The agent cannot infer any behavioral traits beyond the basic 'update' operation.

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 but omits essential details about parameters and behavior. It is not sufficiently informative for an agent.

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?

Despite having three parameters and no output schema, the description fails to explain what the body should contain, the expected outcome, or any constraints. This leaves significant gaps for correct tool usage.

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 minimal ('org', 'campaign_number', 'Request body (JSON object)') and the tool description adds no additional meaning. The body object's structure is not explained, which is critical for correct invocation.

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 campaign' clearly states the verb (update) and resource (campaign), distinguishing it from sibling tools like create, delete, get, and list. However, it does not specify what aspects can be updated.

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, prerequisites, or exclusions. The description lacks context on when to update vs create/delete.

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