stop_mail_watch

Instructions

Implementation Reference

• src/index.ts:1329-1338 (registration)

  Registration of the 'stop_mail_watch' tool. Includes tool name, description, empty input schema (no parameters required), and inline handler function that executes the Gmail API call to stop mailbox watching via the shared 'handleTool' utility.

  server.tool("stop_mail_watch",
    "Stop receiving push notifications for the given user mailbox",
    {},
    async () => {
      return handleTool(config, async (gmail: gmail_v1.Gmail) => {
        const { data } = await gmail.users.stop({ userId: 'me' })
        return formatResponse(data)
      })
    }
  )

• src/index.ts:1332-1337 (handler)

  The handler function for 'stop_mail_watch' tool. It invokes the shared 'handleTool' with the Gmail API callback to call 'gmail.users.stop({ userId: "me" })', which stops push notifications for the user's mailbox.

  async () => {
    return handleTool(config, async (gmail: gmail_v1.Gmail) => {
      const { data } = await gmail.users.stop({ userId: 'me' })
      return formatResponse(data)
    })
  }

• src/index.ts:50-80 (helper)

  Shared helper function 'handleTool' used by all Gmail tools, including 'stop_mail_watch'. Manages OAuth2 authentication, credential validation, Gmail client creation, API execution, and specialized error handling for authentication issues.

  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-48 (helper)

  Utility function 'formatResponse' used to standardize tool responses as MCP content blocks with JSON-stringified data.

  const formatResponse = (response: any) => ({ content: [{ type: "text", text: JSON.stringify(response) }] })

• src/index.ts:1331-1331 (schema)

  Empty input schema for 'stop_mail_watch' tool, indicating no parameters are required.

  {},