get_message

Instructions

Implementation Reference

• src/index.ts:567-577 (handler)

  Handler for 'get_message' tool: retrieves a specific Gmail message by ID using the Gmail API with full format, processes the payload to decode bodies and filter headers, and returns formatted response.

  async (params) => {
    return handleTool(config, async (gmail: gmail_v1.Gmail) => {
      const { data } = await gmail.users.messages.get({ userId: 'me', id: params.id, format: 'full' })
  
      if (data.payload) {
        data.payload = processMessagePart(data.payload, params.includeBodyHtml)
      }
  
      return formatResponse(data)
    })
  }

• src/index.ts:563-566 (schema)

  Input schema for 'get_message' tool: requires message ID, optional flag to include HTML bodies.

  {
    id: z.string().describe("The ID of the message to retrieve"),
    includeBodyHtml: z.boolean().optional().describe("Whether to include the parsed HTML in the return for each body, excluded by default because they can be excessively large")
  },

• src/index.ts:561-578 (registration)

  Registration of the 'get_message' MCP tool on the server, including name, description, schema, and handler.

  server.tool("get_message",
    "Get a specific message by ID with format options",
    {
      id: z.string().describe("The ID of the message to retrieve"),
      includeBodyHtml: z.boolean().optional().describe("Whether to include the parsed HTML in the return for each body, excluded by default because they can be excessively large")
    },
    async (params) => {
      return handleTool(config, async (gmail: gmail_v1.Gmail) => {
        const { data } = await gmail.users.messages.get({ userId: 'me', id: params.id, format: 'full' })
  
        if (data.payload) {
          data.payload = processMessagePart(data.payload, params.includeBodyHtml)
        }
  
        return formatResponse(data)
      })
    }
  )

• src/index.ts:80-94 (helper)

  Helper function processMessagePart used in get_message handler to recursively decode message bodies (unless HTML excluded) and filter headers to a predefined list.

  const processMessagePart = (messagePart: MessagePart, includeBodyHtml = false): MessagePart => {
    if ((messagePart.mimeType !== 'text/html' || includeBodyHtml) && messagePart.body) {
      messagePart.body = decodedBody(messagePart.body)
    }
  
    if (messagePart.parts) {
      messagePart.parts = messagePart.parts.map(part => processMessagePart(part, includeBodyHtml))
    }
  
    if (messagePart.headers) {
      messagePart.headers = messagePart.headers.filter(header => RESPONSE_HEADERS_LIST.includes(header.name || ''))
    }
  
    return messagePart
  }

• src/index.ts:50-66 (helper)

  Shared helper handleTool wraps API calls with OAuth2 authentication, credential validation, and Gmail client creation for all tools including get_message.

  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}`
    }
  }