get_filter

Instructions

Implementation Reference

• src/index.ts:1058-1063 (handler)

  The handler function for the get_filter tool. It calls the Gmail API's filters.get endpoint with the provided filter ID and returns the result.

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

• src/index.ts:1055-1057 (schema)

  Input schema for get_filter: requires a single string parameter 'id' describing 'The ID of the filter to be fetched'.

  {
    id: z.string().describe("The ID of the filter to be fetched")
  },

• src/index.ts:1053-1064 (registration)

  Registration of the 'get_filter' tool via server.tool(), with description 'Gets a filter', schema definition, and handler.

  server.tool("get_filter",
    "Gets a filter",
    {
      id: z.string().describe("The ID of the filter to be fetched")
    },
    async (params) => {
      return handleTool(config, async (gmail: gmail_v1.Gmail) => {
        const { data } = await gmail.users.settings.filters.get({ userId: 'me', id: params.id })
        return formatResponse(data)
      })
    }
  )

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

  The handleTool helper function used by get_filter (and all tools) to authenticate, create the Gmail client, execute the API call, and format the response.

  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}` });
    }
  }