Skip to main content
Glama

untrash_message

Restore accidentally deleted Gmail messages from trash by providing the message ID to recover emails and maintain inbox organization.

Instructions

Remove a message from the trash

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesThe ID of the message to remove from trash

Implementation Reference

  • The handler function for the 'untrash_message' tool. It invokes the shared 'handleTool' helper to authenticate, call the Gmail API's users.messages.untrash method with the provided message ID, and format the response.
      async (params) => {
        return handleTool(config, async (gmail: gmail_v1.Gmail) => {
          const { data } = await gmail.users.messages.untrash({ userId: 'me', id: params.id })
          return formatResponse(data)
        })
      }
    )
  • The Zod input schema for the 'untrash_message' tool, requiring a single 'id' parameter which is the Gmail message ID.
    {
      id: z.string().describe("The ID of the message to remove from trash")
    },
  • src/index.ts:689-700 (registration)
    The MCP server.tool registration for the 'untrash_message' tool, specifying the name, description, input schema, and handler function.
    server.tool("untrash_message",
      "Remove a message from the trash",
      {
        id: z.string().describe("The ID of the message to remove from trash")
      },
      async (params) => {
        return handleTool(config, async (gmail: gmail_v1.Gmail) => {
          const { data } = await gmail.users.messages.untrash({ userId: 'me', id: params.id })
          return formatResponse(data)
        })
      }
    )
  • Shared helper function 'handleTool' used by untrash_message (and other tools) to handle OAuth2 authentication, credential validation, Gmail client creation, API call execution, and standardized 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) {
        // Check for specific authentication errors
        if (
          error.message?.includes("invalid_grant") ||
          error.message?.includes("refresh_token") ||
          error.message?.includes("invalid_client") ||
          error.message?.includes("unauthorized_client") ||
          error.code === 401 ||
          error.code === 403
        ) {
          return formatResponse({
            error: `Authentication failed: ${error.message}. Please re-authenticate by running: npx @shinzolabs/gmail-mcp auth`,
          });
        }
    
        return formatResponse({ error: `Tool execution failed: ${error.message}` });
      }
    }

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.3/5.0
Behavior2/5

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

With no annotations provided, the description must fully convey behavioral traits. It only states the core action without disclosing side effects (e.g., restored location, label restoration) or any prerequisites.

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, clear sentence with no unnecessary words. It communicates the tool's purpose efficiently.

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

Completeness3/5

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

Given the low complexity (single parameter) and absence of an output schema, the description is minimally complete. However, it lacks context about the result of the operation (e.g., message restored to original folder) and how it interacts with sibling tools.

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 coverage is 100% and the parameter 'id' is adequately described in the schema. The description does not add additional meaning beyond what the schema provides, but the baseline score of 3 is appropriate.

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

Purpose5/5

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

The description clearly states the action ('remove') and the resource ('a message from the trash'), distinguishing it from sibling tools like 'trash_message' (move to trash) and 'delete_message' (permanent deletion).

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?

No explicit guidance on when to use this tool versus alternatives such as trash_message or delete_message. The description does not provide context for its appropriate use case.

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