update_gateway

Instructions

Implementation Reference

• src/tools/gateways/updateGateway.ts:33-41 (handler)

  Handler function that parses args, extracts gatewayId/displayName/setting, and calls gatewayService.updateGateway.

  async function handler(client: Client, args: Record<string, unknown> | undefined) {
    const parsed = schema.safeParse(args);
    if (!parsed.success) {
      return errorResult(parsed.error.errors.map((e) => e.message).join("; "));
    }
    const { gatewayId, displayName, setting } = parsed.data;
    const body = { displayName, setting };
    return handleToolCall(() => gatewayService.updateGateway(client, gatewayId, body));
  }

• src/tools/gateways/updateGateway.ts:7-13 (schema)

  Zod schema for update_gateway input validation: gatewayId (required), displayName (optional), setting (optional record).

  const settingSchema = z.record(z.union([z.string(), z.number(), z.boolean()])).optional();
  
  const schema = z.object({
    gatewayId: z.string().min(1, "gatewayId is required"),
    displayName: z.string().optional(),
    setting: settingSchema,
  });

• src/tools/gateways/updateGateway.ts:15-31 (schema)

  Tool definition/input schema for update_gateway with name, description, and JSON Schema input properties.

  const definition = {
    name: "update_gateway",
    description:
      "Update a company gateway. PUT /gateways/{gatewayId}. Optional: displayName, setting (credentials key-value object).",
    inputSchema: {
      type: "object" as const,
      properties: {
        gatewayId: { type: "string", description: "Gateway ID (required)" },
        displayName: { type: "string", description: "Display name" },
        setting: {
          type: "object",
          description: "Credentials object (key-value). Keys depend on gateway type.",
        },
      },
      required: ["gatewayId"],
    },
  };

• src/tools/gateways/index.ts:14-29 (registration)

  Import and export of updateGatewayTool; included in registerGatewayTools array at line 25.

  import { updateGatewayTool } from "./updateGateway.js";
  
  /** All gateway tools. */
  export function registerGatewayTools(): Tool[] {
    return [
      listGlobalGatewaysTool,
      listGatewaysTool,
      getGatewayTool,
      getClientTokenTool,
      createSetupIntentTool,
      createGatewayTool,
      updateGatewayTool,
      deleteGatewayTool,
      testGatewayTool,
    ];
  }

• src/services/gatewayServices.ts:65-75 (helper)

  updateGateway service function that sends PUT /gateways/{gatewayId} with filtered body payload.

  /** PUT /gateways/{gatewayId} */
  export async function updateGateway(
    client: Client,
    gatewayId: string,
    body: UpdateGatewayBody
  ): Promise<unknown> {
    const payload = Object.fromEntries(
      Object.entries(body).filter(([, v]) => v !== undefined)
    ) as UpdateGatewayBody;
    return client.put<unknown>(`/gateways/${gatewayId}`, Object.keys(payload).length ? payload : {});
  }