update_label

Instructions

Implementation Reference

• src/index.ts:480-499 (registration)

  Registration of the update_label tool, including input schema (Zod validation) and inline handler function that performs a full update on a Gmail label using the Gmail API's users.labels.update method.

  server.tool("update_label",
    "Update an existing label",
    {
      id: z.string().describe("The ID of the label to update"),
      name: z.string().optional().describe("The display name of the label"),
      messageListVisibility: z.enum(['show', 'hide']).optional().describe("The visibility of messages with this label in the message list"),
      labelListVisibility: z.enum(['labelShow', 'labelShowIfUnread', 'labelHide']).optional().describe("The visibility of the label in the label list"),
      color: z.object({
        textColor: z.string().describe("The text color of the label as hex string"),
        backgroundColor: z.string().describe("The background color of the label as hex string")
      }).optional().describe("The color settings for the label")
    },
    async (params) => {
      const { id, ...labelData } = params
      return handleTool(config, async (gmail: gmail_v1.Gmail) => {
        const { data } = await gmail.users.labels.update({ userId: 'me', id, requestBody: labelData })
        return formatResponse(data)
      })
    }
  )

• src/index.ts:492-498 (handler)

  The handler function for the update_label tool. It extracts the label ID and update data from params, uses the shared handleTool helper to authenticate and call the Gmail API to update the label, then formats the response.

  async (params) => {
    const { id, ...labelData } = params
    return handleTool(config, async (gmail: gmail_v1.Gmail) => {
      const { data } = await gmail.users.labels.update({ userId: 'me', id, requestBody: labelData })
      return formatResponse(data)
    })
  }

• src/index.ts:483-491 (schema)

  Input schema for the update_label tool, defined using Zod, specifying required label ID and optional fields for name, visibilities, and color.

    id: z.string().describe("The ID of the label to update"),
    name: z.string().optional().describe("The display name of the label"),
    messageListVisibility: z.enum(['show', 'hide']).optional().describe("The visibility of messages with this label in the message list"),
    labelListVisibility: z.enum(['labelShow', 'labelShowIfUnread', 'labelHide']).optional().describe("The visibility of the label in the label list"),
    color: z.object({
      textColor: z.string().describe("The text color of the label as hex string"),
      backgroundColor: z.string().describe("The background color of the label as hex string")
    }).optional().describe("The color settings for the label")
  },

• src/index.ts:49-65 (helper)

  Shared helper function handleTool used by update_label (and other tools) to handle OAuth2 authentication, credential validation, Gmail client creation, and API call execution with error handling.

  const handleTool = async (queryConfig: Record<string, any> | undefined, apiCall: (gmail: gmail_v1.Gmail) => Promise<any>) => {
    try {
      const oauth2Client = queryConfig ? createOAuth2Client(queryConfig) : defaultOAuth2Client
      if (!oauth2Client) throw new Error('OAuth2 client could not be created, please check your credentials')
  
      const credentialsAreValid = await validateCredentials(oauth2Client)
      if (!credentialsAreValid) throw new Error('OAuth2 credentials are invalid, please re-authenticate')
  
      const gmailClient = queryConfig ? google.gmail({ version: 'v1', auth: oauth2Client }) : defaultGmailClient
      if (!gmailClient) throw new Error('Gmail client could not be created, please check your credentials')
  
      const result = await apiCall(gmailClient)
      return result
    } catch (error: any) {
      return `Tool execution failed: ${error.message}`
    }
  }