get_filter
Retrieve specific Gmail filter settings by ID to review automated email organization rules and message handling configurations.
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:1025-1030 (handler)Handler function for the 'get_filter' tool. It uses handleTool to authenticate and calls the Gmail API to get a specific filter by ID, then formats the 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:1022-1024 (schema)Input schema for the 'get_filter' tool, requiring a filter ID string.{ id: z.string().describe("The ID of the filter to be fetched") },
- src/index.ts:1020-1031 (registration)Registration of the 'get_filter' tool on the MCP server, including description, schema, 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:49-65 (helper)Shared helper function handleTool used by get_filter (and other tools) for OAuth authentication and Gmail API execution.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) { return `Tool execution failed: ${error.message}` } }
- src/index.ts:47-48 (helper)Shared helper formatResponse used by get_filter to format the API response as MCP content.const formatResponse = (response: any) => ({ content: [{ type: "text", text: JSON.stringify(response) }] })