get_filter
Retrieve a specific Gmail filter configuration by its ID to view or manage email organization rules.
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:1039-1050 (registration)Registration of the 'get_filter' MCP tool, including description, input schema, and inline handler function.
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:1041-1043 (schema)Input schema for the get_filter tool: requires a string 'id' parameter for the filter ID.
{ id: z.string().describe("The ID of the filter to be fetched") }, - src/index.ts:1044-1049 (handler)Handler function for get_filter: authenticates via handleTool, calls Gmail API to get filter by ID, formats and returns 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:50-66 (helper)Shared helper function handleTool used by get_filter (and all tools) to manage OAuth2 authentication, create Gmail client, execute the API call, and handle 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) { return `Tool execution failed: ${error.message}` } } - src/index.ts:48-49 (helper)Helper function formatResponse used to format the API response into MCP content format.
const formatResponse = (response: any) => ({ content: [{ type: "text", text: JSON.stringify(response) }] })