Skip to main content
Glama

watch_mailbox

Set up a Cloud Pub/Sub topic to receive notifications when your mailbox changes, with optional label filters to monitor specific labels.

Instructions

Watch for changes to the user's mailbox

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
topicNameYesThe name of the Cloud Pub/Sub topic to publish notifications to
labelIdsNoLabel IDs to restrict notifications to
labelFilterActionNoWhether to include or exclude the specified labels

Implementation Reference

  • src/index.ts:1314-1327 (registration)
    Registration of the 'watch_mailbox' tool via server.tool() with its schema definition
    server.tool("watch_mailbox",
      "Watch for changes to the user's mailbox",
      {
        topicName: z.string().describe("The name of the Cloud Pub/Sub topic to publish notifications to"),
        labelIds: z.array(z.string()).optional().describe("Label IDs to restrict notifications to"),
        labelFilterAction: z.enum(['include', 'exclude']).optional().describe("Whether to include or exclude the specified labels")
      },
      async (params) => {
        return handleTool(config, async (gmail: gmail_v1.Gmail) => {
          const { data } = await gmail.users.watch({ userId: 'me', requestBody: params })
          return formatResponse(data)
        })
      }
    )
  • Handler function executed when 'watch_mailbox' is called; calls gmail.users.watch() with topicName, labelIds, and labelFilterAction parameters
      async (params) => {
        return handleTool(config, async (gmail: gmail_v1.Gmail) => {
          const { data } = await gmail.users.watch({ userId: 'me', requestBody: params })
          return formatResponse(data)
        })
      }
    )
  • Input schema for 'watch_mailbox': topicName (required string), labelIds (optional array of strings), labelFilterAction (optional enum 'include'/'exclude')
    {
      topicName: z.string().describe("The name of the Cloud Pub/Sub topic to publish notifications to"),
      labelIds: z.array(z.string()).optional().describe("Label IDs to restrict notifications to"),
      labelFilterAction: z.enum(['include', 'exclude']).optional().describe("Whether to include or exclude the specified labels")
    },
Behavior2/5

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

With no annotations, the description carries full burden. It only states 'Watch for changes' without disclosing side effects (e.g., creating a subscription), permissions required, rate limits, or how to stop the watch. The behavioral impact is vague.

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, short sentence with no wasted words. However, it is so concise that it omits important context, making it slightly less effective than a well-balanced description.

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 tool has 3 parameters (including an enum) and no output schema, the description is insufficient. It does not explain the watch mechanism, return behavior, or relationship to sibling 'stop_mail_watch'. More detail is needed for effective 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?

The input schema has 100% coverage with clear descriptions for each parameter. The description adds no additional meaning beyond the schema, meeting the baseline of 3.

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 'Watch for changes to the user's mailbox' clearly identifies the verb (Watch) and resource (mailbox), distinguishing it from most sibling tools. However, it does not explicitly indicate that this tool starts a watch, which could be inferred from the sibling 'stop_mail_watch'.

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 guidance is provided on when to use this tool versus alternatives like 'stop_mail_watch' or other mailbox-related tools. The description lacks context about prerequisites, setup, or lifecycle.

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