get_auto_forwarding
Retrieve and view Gmail auto-forwarding settings to manage email redirection rules and configurations.
Instructions
Gets auto-forwarding settings
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Implementation Reference
- src/index.ts:798-807 (registration)Registration of the 'get_auto_forwarding' MCP tool. Includes empty input schema (no parameters required) and inline handler function that uses the generic handleTool to authenticate and call the Gmail API's users.settings.getAutoForwarding method, then formats the response.
server.tool("get_auto_forwarding", "Gets auto-forwarding settings", {}, async () => { return handleTool(config, async (gmail: gmail_v1.Gmail) => { const { data } = await gmail.users.settings.getAutoForwarding({ userId: 'me' }) return formatResponse(data) }) } ) - src/index.ts:801-806 (handler)The handler function for the 'get_auto_forwarding' tool, which executes the tool logic by calling Gmail's getAutoForwarding API endpoint after authentication via handleTool.
async () => { return handleTool(config, async (gmail: gmail_v1.Gmail) => { const { data } = await gmail.users.settings.getAutoForwarding({ userId: 'me' }) return formatResponse(data) }) } - src/index.ts:49-65 (helper)Generic helper function used by all Gmail tools, including 'get_auto_forwarding', to handle OAuth2 authentication, credential validation, Gmail client creation, and API call 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-47 (helper)Helper function to format API responses into MCP-compatible content structure, used by the 'get_auto_forwarding' handler.
const formatResponse = (response: any) => ({ content: [{ type: "text", text: JSON.stringify(response) }] })