Skip to main content
Glama

get_thread

Retrieve a specific Gmail email thread by its ID to view conversation history and message details, with optional HTML body content for comprehensive analysis.

Instructions

Get a specific thread by ID

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesThe ID of the thread to retrieve
includeBodyHtmlNoWhether to include the parsed HTML in the return for each body, excluded by default because they can be excessively large

Implementation Reference

  • Executes the get_thread tool: fetches the thread by ID using Gmail API with format 'full', processes each message payload (decodes bodies, filters headers), and returns formatted response.
    async (params) => {
      return handleTool(config, async (gmail: gmail_v1.Gmail) => {
        const { data } = await gmail.users.threads.get({ userId: 'me', id: params.id, format: 'full' })
    
        if (data.messages) {
          data.messages = data.messages.map(message => {
            if (message.payload) {
              message.payload = processMessagePart(message.payload, params.includeBodyHtml)
            }
            return message
          })
        }
    
        return formatResponse(data)
      })
    }
  • Input schema definition for the get_thread tool using Zod: requires 'id' string, optional 'includeBodyHtml' boolean.
    {
      id: z.string().describe("The ID of the thread 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:715-737 (registration)
    Registers the 'get_thread' tool on the MCP server, providing name, description, input schema, and inline handler function.
    server.tool("get_thread",
      "Get a specific thread by ID",
      {
        id: z.string().describe("The ID of the thread 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.threads.get({ userId: 'me', id: params.id, format: 'full' })
    
          if (data.messages) {
            data.messages = data.messages.map(message => {
              if (message.payload) {
                message.payload = processMessagePart(message.payload, params.includeBodyHtml)
              }
              return message
            })
          }
    
          return formatResponse(data)
        })
      }
    )
  • Shared helper function used by get_thread (and other tools) to handle OAuth2 authentication, credential validation, Gmail client creation, API call execution, 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) {
        return `Tool execution failed: ${error.message}`
      }
    }
  • Helper to process message parts: decodes base64 bodies (unless HTML and not includeBodyHtml), recurses into parts, filters headers to specific list, used in get_thread payload processing.
    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
    }
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries full burden for behavioral disclosure. It states it retrieves a thread but doesn't mention what data is returned (e.g., metadata, messages), error handling (e.g., for invalid IDs), or performance considerations (e.g., size of responses). This leaves significant gaps for a read operation.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, efficient sentence that front-loads the core purpose without any wasted words. It's appropriately sized for a simple retrieval tool, making it easy to parse quickly.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given no annotations and no output schema, the description is incomplete for a retrieval tool. It doesn't explain what data is returned (e.g., thread structure, included messages), error cases, or how 'includeBodyHtml' affects the response size. For a tool with 2 parameters and complex sibling tools, this leaves too much unspecified.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the schema fully documents both parameters ('id' and 'includeBodyHtml'). The description adds no additional meaning beyond implying the 'id' parameter is required, which is already clear from the schema. Baseline 3 is appropriate when the schema does the heavy lifting.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the action ('Get') and resource ('a specific thread by ID'), making the purpose immediately understandable. However, it doesn't differentiate from sibling tools like 'get_message' or 'list_threads' beyond the specific resource type, which prevents a perfect score.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no guidance on when to use this tool versus alternatives like 'get_message' (for individual messages) or 'list_threads' (for multiple threads). It lacks any context about prerequisites, such as needing a thread ID from another operation, or exclusions.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/nk900600/gmail-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server