get_auto_forwarding
Retrieve auto-forwarding configuration from Gmail to view or manage email forwarding rules for your account.
Instructions
Gets auto-forwarding settings
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Implementation Reference
- src/index.ts:831-840 (handler)Handler function for the 'get_auto_forwarding' tool. It calls the Gmail API to retrieve auto-forwarding settings using the shared handleTool wrapper, which manages authentication and error handling.
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:831-840 (registration)Registration of the 'get_auto_forwarding' tool on the MCP server using server.tool().
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:833-833 (schema)Input schema for 'get_auto_forwarding' tool: no parameters required.
{}, - src/index.ts:50-80 (helper)Shared helper function handleTool used by get_auto_forwarding and many other tools for authentication, client creation, and error handling.
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)Helper function to format tool responses as MCP content.
const formatResponse = (response: any) => ({ content: [{ type: "text", text: JSON.stringify(response) }] })