batch_modify_messages
Modify labels on multiple Gmail messages simultaneously by adding or removing label IDs from selected emails to organize your inbox efficiently.
Instructions
Modify the labels on multiple messages
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ids | Yes | The IDs of the messages to modify | |
| addLabelIds | No | A list of label IDs to add to the messages | |
| removeLabelIds | No | A list of label IDs to remove from the messages |
Implementation Reference
- src/index.ts:554-559 (handler)The handler function executes the Gmail API call to batch modify labels on multiple messages using the provided message IDs, addLabelIds, and removeLabelIds. It wraps the call in handleTool for authentication and error handling.async (params) => { return handleTool(config, async (gmail: gmail_v1.Gmail) => { const { data } = await gmail.users.messages.batchModify({ userId: 'me', requestBody: { ids: params.ids, addLabelIds: params.addLabelIds, removeLabelIds: params.removeLabelIds } }) return formatResponse(data) }) }
- src/index.ts:549-553 (schema)Zod schema defining the input parameters: required 'ids' array of message IDs, optional 'addLabelIds' and 'removeLabelIds' arrays of label IDs.{ ids: z.array(z.string()).describe("The IDs of the messages to modify"), addLabelIds: z.array(z.string()).optional().describe("A list of label IDs to add to the messages"), removeLabelIds: z.array(z.string()).optional().describe("A list of label IDs to remove from the messages") },
- src/index.ts:547-560 (registration)MCP server tool registration for 'batch_modify_messages', including description, input schema, and handler function.server.tool("batch_modify_messages", "Modify the labels on multiple messages", { ids: z.array(z.string()).describe("The IDs of the messages to modify"), addLabelIds: z.array(z.string()).optional().describe("A list of label IDs to add to the messages"), removeLabelIds: z.array(z.string()).optional().describe("A list of label IDs to remove from the messages") }, async (params) => { return handleTool(config, async (gmail: gmail_v1.Gmail) => { const { data } = await gmail.users.messages.batchModify({ userId: 'me', requestBody: { ids: params.ids, addLabelIds: params.addLabelIds, removeLabelIds: params.removeLabelIds } }) return formatResponse(data) }) } )
- src/index.ts:50-80 (helper)Shared helper function that handles OAuth2 authentication, Gmail client creation, API call execution, and error handling (especially auth errors) for all Gmail tools.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) { // Check for specific authentication errors if ( error.message?.includes("invalid_grant") || error.message?.includes("refresh_token") || error.message?.includes("invalid_client") || error.message?.includes("unauthorized_client") || error.code === 401 || error.code === 403 ) { return formatResponse({ error: `Authentication failed: ${error.message}. Please re-authenticate by running: npx @shinzolabs/gmail-mcp auth`, }); } return formatResponse({ error: `Tool execution failed: ${error.message}` }); } }
- src/index.ts:48-49 (helper)Shared helper to format tool responses as MCP content blocks with JSON stringified data.const formatResponse = (response: any) => ({ content: [{ type: "text", text: JSON.stringify(response) }] })