get_forwarding_address
Retrieve a specific Gmail forwarding address configuration to view or manage email forwarding settings.
Instructions
Gets the specified forwarding address
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| forwardingEmail | Yes | The forwarding address to be retrieved |
Implementation Reference
- src/index.ts:1094-1100 (handler)The handler function for the 'get_forwarding_address' tool. It invokes handleTool to authenticate, create Gmail client, and fetch the specific forwarding address via Gmail API.async (params) => { return handleTool(config, async (gmail: gmail_v1.Gmail) => { const { data } = await gmail.users.settings.forwardingAddresses.get({ userId: 'me', forwardingEmail: params.forwardingEmail }) return formatResponse(data) }) } )
- src/index.ts:1091-1093 (schema)Input schema for 'get_forwarding_address' tool, validating the forwardingEmail parameter.{ forwardingEmail: z.string().describe("The forwarding address to be retrieved") },
- src/index.ts:1089-1100 (registration)Registration of the 'get_forwarding_address' tool on the MCP server, including name, description, schema, and handler.server.tool("get_forwarding_address", "Gets the specified forwarding address", { forwardingEmail: z.string().describe("The forwarding address to be retrieved") }, async (params) => { return handleTool(config, async (gmail: gmail_v1.Gmail) => { const { data } = await gmail.users.settings.forwardingAddresses.get({ userId: 'me', forwardingEmail: params.forwardingEmail }) return formatResponse(data) }) } )
- src/index.ts:50-66 (helper)Shared helper function 'handleTool' used by all Gmail tools, including 'get_forwarding_address', to handle OAuth2 authentication and 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:48-48 (helper)Helper function 'formatResponse' used to standardize tool responses as MCP content blocks.const formatResponse = (response: any) => ({ content: [{ type: "text", text: JSON.stringify(response) }] })