Skip to main content
Glama

update_vacation

Configure your Gmail vacation responder by enabling auto-reply, setting subject and body, restricting to contacts or domain, and scheduling start and end times.

Instructions

Update vacation responder settings

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
enableAutoReplyYesWhether the vacation responder is enabled
responseSubjectNoOptional subject line for the vacation responder auto-reply
responseBodyPlainTextYesResponse body in plain text format
restrictToContactsNoWhether responses are only sent to contacts
restrictToDomainNoWhether responses are only sent to users in the same domain
startTimeNoStart time for sending auto-replies (epoch ms)
endTimeNoEnd time for sending auto-replies (epoch ms)

Implementation Reference

  • src/index.ts:943-960 (registration)
    Tool registration for 'update_vacation' using server.tool(), defining the tool name, description, input schema parameters, and an async handler callback.
    server.tool("update_vacation",
      "Update vacation responder settings",
      {
        enableAutoReply: z.boolean().describe("Whether the vacation responder is enabled"),
        responseSubject: z.string().optional().describe("Optional subject line for the vacation responder auto-reply"),
        responseBodyPlainText: z.string().describe("Response body in plain text format"),
        restrictToContacts: z.boolean().optional().describe("Whether responses are only sent to contacts"),
        restrictToDomain: z.boolean().optional().describe("Whether responses are only sent to users in the same domain"),
        startTime: z.string().optional().describe("Start time for sending auto-replies (epoch ms)"),
        endTime: z.string().optional().describe("End time for sending auto-replies (epoch ms)")
      },
      async (params) => {
        return handleTool(config, async (gmail: gmail_v1.Gmail) => {
          const { data } = await gmail.users.settings.updateVacation({ userId: 'me', requestBody: params })
          return formatResponse(data)
        })
      }
    )
  • Input schema for update_vacation tool: enableAutoReply (required boolean), responseSubject (optional string), responseBodyPlainText (required string), restrictToContacts (optional boolean), restrictToDomain (optional boolean), startTime (optional string), endTime (optional string)
    {
      enableAutoReply: z.boolean().describe("Whether the vacation responder is enabled"),
      responseSubject: z.string().optional().describe("Optional subject line for the vacation responder auto-reply"),
      responseBodyPlainText: z.string().describe("Response body in plain text format"),
      restrictToContacts: z.boolean().optional().describe("Whether responses are only sent to contacts"),
      restrictToDomain: z.boolean().optional().describe("Whether responses are only sent to users in the same domain"),
      startTime: z.string().optional().describe("Start time for sending auto-replies (epoch ms)"),
      endTime: z.string().optional().describe("End time for sending auto-replies (epoch ms)")
    },
  • Handler function for update_vacation. Calls gmail.users.settings.updateVacation() with the provided parameters and returns the response.
      async (params) => {
        return handleTool(config, async (gmail: gmail_v1.Gmail) => {
          const { data } = await gmail.users.settings.updateVacation({ userId: 'me', requestBody: params })
          return formatResponse(data)
        })
      }
    )
  • The handleTool helper function that wraps all tool handlers, providing OAuth2 validation 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) {
        // 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}` });
      }
    }
Behavior2/5

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

No annotations are provided, so the description must disclose behavioral traits. It only says 'Update', implying mutation, but does not explain whether the update merges or overrides, if authentication is required, or what side effects occur. This lack of detail impairs safe invocation.

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

Conciseness4/5

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

The description is a single, direct sentence that is efficient and easy to parse. It is appropriately front-loaded, but for a tool with 7 parameters, a bit more context could be added without sacrificing conciseness.

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 the lack of annotations and output schema, and the moderate complexity of 7 parameters, the description is insufficient. It omits information on return values, idempotency, and how omitted optional parameters are handled, leaving gaps for reliable use.

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?

Since schema description coverage is 100%, the baseline is 3. The tool description adds no extra meaning beyond the existing parameter descriptions, so it neither harms nor improves semantic clarity.

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 'Update vacation responder settings' clearly states the verb and resource, making the tool's purpose immediately understandable. It distinguishes from sibling tools like get_vacation (read) and other update tools (e.g., update_auto_forwarding) by specifying 'vacation responder', but does not explicitly differentiate among them.

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. It does not mention prerequisites, when it is appropriate, or warn against misuse, leaving the agent without decision support.

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/shinzo-labs/gmail-mcp'

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