Skip to main content
Glama

get_draft

Retrieve a specific email draft from Gmail by its ID, with options to include or exclude HTML content for efficient data handling.

Instructions

Get a specific draft by ID

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesThe ID of the draft 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

  • Handler function for the 'get_draft' tool. Fetches the specified draft using the Gmail API, processes its message payload (decoding body and filtering headers), and returns a formatted JSON response.
    async (params) => {
      return handleTool(config, async (gmail: gmail_v1.Gmail) => {
        const { data } = await gmail.users.drafts.get({ userId: 'me', id: params.id, format: 'full' })
    
        if (data.message?.payload) {
          data.message.payload = processMessagePart(
            data.message.payload,
            params.includeBodyHtml
          )
        }
    
        return formatResponse(data)
      })
    }
  • Zod input schema for the 'get_draft' tool defining parameters: id (required string) and includeBodyHtml (optional boolean).
    {
      id: z.string().describe("The ID of the draft 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:297-317 (registration)
    Registration of the 'get_draft' tool on the MCP server using server.tool(), including description, input schema, and inline handler function.
    server.tool("get_draft",
      "Get a specific draft by ID",
      {
        id: z.string().describe("The ID of the draft 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.drafts.get({ userId: 'me', id: params.id, format: 'full' })
    
          if (data.message?.payload) {
            data.message.payload = processMessagePart(
              data.message.payload,
              params.includeBodyHtml
            )
          }
    
          return formatResponse(data)
        })
      }
    )
  • Shared helper function used by 'get_draft' (and other tools) to handle OAuth2 authentication, client creation, credential validation, and API call 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}`
      }
    }
  • Recursive helper function to process message parts: decodes base64 bodies (except HTML unless specified), processes nested parts, and filters headers to include only specified ones.
    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?

With no annotations provided, the description carries full burden for behavioral disclosure. 'Get' implies a read operation, but there's no information about authentication requirements, rate limits, error conditions, or what happens if the draft doesn't exist. The description doesn't mention that includeBodyHtml is excluded by default for performance reasons (though the schema does).

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 extremely concise - a single sentence that states the core purpose without any wasted words. It's front-loaded with the essential information and contains no unnecessary elaboration.

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?

For a read operation with no annotations and no output schema, the description is inadequate. It doesn't explain what a 'draft' represents in this context, what fields are returned, error handling, or how this differs from retrieving a regular message. The agent would need to guess about the return format and behavior.

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 already fully documents both parameters. The description doesn't add any parameter information beyond what's in the schema - it mentions 'by ID' which corresponds to the 'id' parameter, but provides no additional context about parameter usage or relationships.

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 draft by ID'), making the purpose immediately understandable. However, it doesn't differentiate this tool from similar sibling tools like 'get_message' or 'get_thread' which also retrieve specific resources by ID, so it doesn't achieve full sibling differentiation.

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. There are multiple similar retrieval tools in the sibling list (get_message, get_thread, get_attachment, etc.), but no indication of when this specific draft retrieval is appropriate versus other get operations or versus list_drafts for browsing.

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