get_imap
Retrieve IMAP configuration settings for Gmail accounts to enable email client setup and server access.
Instructions
Gets IMAP settings
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Implementation Reference
- src/index.ts:828-836 (registration)Registers the 'get_imap' MCP tool. Includes schema (empty input parameters) and the handler function that retrieves IMAP settings using the Gmail API via handleTool and formatResponse.server.tool("get_imap", "Gets IMAP settings", {}, async () => { return handleTool(config, async (gmail: gmail_v1.Gmail) => { const { data } = await gmail.users.settings.getImap({ userId: 'me' }) return formatResponse(data) }) }
- src/index.ts:832-836 (handler)Handler function for 'get_imap' tool: authenticates via handleTool, calls Gmail API to get IMAP settings, formats response.return handleTool(config, async (gmail: gmail_v1.Gmail) => { const { data } = await gmail.users.settings.getImap({ userId: 'me' }) return formatResponse(data) }) }
- src/index.ts:50-66 (helper)Shared helper function handleTool used by get_imap (and other tools) for OAuth2 authentication, Gmail client creation, and executing the API call with 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) { return `Tool execution failed: ${error.message}` } }
- src/index.ts:48-48 (helper)Helper function formatResponse used to format API responses as MCP content blocks with JSON stringified data.const formatResponse = (response: any) => ({ content: [{ type: "text", text: JSON.stringify(response) }] })