modify_message
Add or remove labels on Gmail messages to organize and categorize emails using label IDs for efficient email management.
Instructions
Modify the labels on a message
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The ID of the message to modify | |
| addLabelIds | No | A list of label IDs to add to the message | |
| removeLabelIds | No | A list of label IDs to remove from the message |
Implementation Reference
- src/index.ts:632-637 (handler)Handler function for the 'modify_message' tool. It uses the shared 'handleTool' utility to authenticate and call the Gmail API's users.messages.modify method to add or remove labels from a specific message.async (params) => { return handleTool(config, async (gmail: gmail_v1.Gmail) => { const { data } = await gmail.users.messages.modify({ userId: 'me', id: params.id, requestBody: { addLabelIds: params.addLabelIds, removeLabelIds: params.removeLabelIds } }) return formatResponse(data) }) }
- src/index.ts:628-631 (schema)Zod schema defining the input parameters for the 'modify_message' tool: message ID (required), optional lists of label IDs to add or remove.id: z.string().describe("The ID of the message to modify"), addLabelIds: z.array(z.string()).optional().describe("A list of label IDs to add to the message"), removeLabelIds: z.array(z.string()).optional().describe("A list of label IDs to remove from the message") },
- src/index.ts:625-638 (registration)Registration of the 'modify_message' tool on the MCP server, including name, description, input schema, and handler function.server.tool("modify_message", "Modify the labels on a message", { id: z.string().describe("The ID of the message to modify"), addLabelIds: z.array(z.string()).optional().describe("A list of label IDs to add to the message"), removeLabelIds: z.array(z.string()).optional().describe("A list of label IDs to remove from the message") }, async (params) => { return handleTool(config, async (gmail: gmail_v1.Gmail) => { const { data } = await gmail.users.messages.modify({ userId: 'me', id: params.id, requestBody: { addLabelIds: params.addLabelIds, removeLabelIds: params.removeLabelIds } }) return formatResponse(data) }) } )
- src/index.ts:50-80 (helper)Shared 'handleTool' helper function used by 'modify_message' and other tools for OAuth2 authentication, Gmail client creation, API call execution, and 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) { // 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 'formatResponse' helper that formats the API response into MCP content structure.const formatResponse = (response: any) => ({ content: [{ type: "text", text: JSON.stringify(response) }] })