patch_label
Modify specific properties of an existing Gmail label, including its name, visibility settings, and color customization.
Instructions
Patch an existing label (partial update)
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The ID of the label to patch | |
| name | No | The display name of the label | |
| messageListVisibility | No | The visibility of messages with this label in the message list | |
| labelListVisibility | No | The visibility of the label in the label list | |
| color | No | The color settings for the label |
Implementation Reference
- src/index.ts:459-478 (registration)Registration of the 'patch_label' tool using server.tool(), including description, input schema, and handler function.server.tool("patch_label", "Patch an existing label (partial update)", { id: z.string().describe("The ID of the label to patch"), 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.patch({ userId: 'me', id, requestBody: labelData }) return formatResponse(data) }) } )
- src/index.ts:471-477 (handler)The handler function executes the patch_label tool by calling Gmail API's labels.patch method via the shared handleTool utility.async (params) => { const { id, ...labelData } = params return handleTool(config, async (gmail: gmail_v1.Gmail) => { const { data } = await gmail.users.labels.patch({ userId: 'me', id, requestBody: labelData }) return formatResponse(data) }) }
- src/index.ts:462-470 (schema)Zod schema defining the input parameters for the patch_label tool, including id (required) and optional fields for name, visibilities, and color.id: z.string().describe("The ID of the label to patch"), 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 patch_label (and other tools) to handle OAuth2 authentication, client creation, and API call execution.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}` } }