get_filter
Retrieve a specific Gmail filter by its ID to view its configuration and understand how it organizes incoming messages.
Instructions
Gets a filter
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The ID of the filter to be fetched |
Implementation Reference
- src/index.ts:1053-1064 (registration)Registration of the 'get_filter' MCP tool, including schema (id: string) and inline handler that fetches the specified filter using Gmail API via handleTool.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:1058-1063 (handler)Inline handler function for 'get_filter' tool: validates auth, calls Gmail API to get filter by ID, formats response.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)Zod input schema for 'get_filter' tool: requires 'id' as string (filter ID).{ id: z.string().describe("The ID of the filter to be fetched") },
- src/index.ts:50-80 (helper)Shared 'handleTool' helper used by 'get_filter' (and all tools): manages OAuth2 auth, Gmail client, API call execution, error handling incl. auth-specific errors.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)Shared 'formatResponse' helper used by 'get_filter' to wrap API response in MCP content format.const formatResponse = (response: any) => ({ content: [{ type: "text", text: JSON.stringify(response) }] })