patch_label
Modify Gmail label properties like name, visibility, or color using partial updates to customize email organization.
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:490-496 (handler)Handler function for 'patch_label' tool: destructures params to get id and labelData, calls Gmail API labels.patch via handleTool wrapper, formats response.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:481-489 (schema)Input schema for 'patch_label' tool using Zod: defines id (required), and optional fields for name, visibilities, and color object.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:478-497 (registration)Registration of 'patch_label' tool on McpServer: includes name, description, input schema, and inline 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) }) } )