Skip to main content
Glama

create_forwarding_address

Set up email forwarding in Gmail by specifying a destination address to automatically redirect incoming messages.

Instructions

Creates a forwarding address

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
forwardingEmailYesAn email address to which messages can be forwarded

Implementation Reference

  • src/index.ts:1063-1074 (registration)
    Registration of the 'create_forwarding_address' MCP tool. Includes input schema (forwardingEmail), description, and handler that calls Gmail API's users.settings.forwardingAddresses.create via the shared handleTool helper.
    server.tool("create_forwarding_address",
      "Creates a forwarding address",
      {
        forwardingEmail: z.string().describe("An email address to which messages can be forwarded")
      },
      async (params) => {
        return handleTool(config, async (gmail: gmail_v1.Gmail) => {
          const { data } = await gmail.users.settings.forwardingAddresses.create({ userId: 'me', requestBody: params })
          return formatResponse(data)
        })
      }
    )
  • Handler function for 'create_forwarding_address' tool. Uses shared handleTool to authenticate and execute the Gmail API call to create a new forwarding address.
    async (params) => {
      return handleTool(config, async (gmail: gmail_v1.Gmail) => {
        const { data } = await gmail.users.settings.forwardingAddresses.create({ userId: 'me', requestBody: params })
        return formatResponse(data)
      })
    }
  • Input schema for 'create_forwarding_address' tool using Zod: requires 'forwardingEmail' string.
    {
      forwardingEmail: z.string().describe("An email address to which messages can be forwarded")
    },
  • Shared helper function 'handleTool' used by all Gmail API tools, including 'create_forwarding_address', for OAuth2 authentication and API 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}`
      }
    }
  • Shared helper 'formatResponse' used to standardize tool responses as MCP content blocks.
    const formatResponse = (response: any) => ({ content: [{ type: "text", text: JSON.stringify(response) }] })
Behavior1/5

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It states 'Creates' which implies a write/mutation operation, but doesn't specify permissions required, side effects (e.g., whether it sends verification emails), rate limits, or what happens on failure. For a creation tool with zero annotation coverage, this lack of behavioral detail is a significant gap.

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 with just three words, making it front-loaded and efficient. There's no wasted language or redundancy, though this brevity contributes to the overall inadequacy of the description for guiding tool usage.

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's complexity (a write operation with no annotations or output schema), the description is incomplete. It doesn't explain what a forwarding address is, how it integrates with the email system, what the creation process entails, or what happens after invocation. For a mutation tool in a rich sibling ecosystem, this minimal description leaves critical gaps in understanding.

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%, with the single parameter 'forwardingEmail' well-documented in the schema as 'An email address to which messages can be forwarded'. The description adds no additional parameter information beyond what the schema provides, so it meets the baseline score of 3 for high schema coverage without compensating value.

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

Purpose2/5

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

The description 'Creates a forwarding address' is a tautology that merely restates the tool name without adding specificity. It doesn't explain what a forwarding address is, what resource it creates, or how it differs from similar tools like 'create_filter' or 'create_send_as'. While the verb 'creates' is clear, the object 'forwarding address' lacks context about its function or domain.

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

Usage Guidelines1/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 doesn't mention prerequisites (e.g., needing admin permissions), use cases (e.g., setting up email redirection), or relationships to sibling tools like 'delete_forwarding_address' or 'get_forwarding_address'. Without any contextual cues, an agent must infer usage from the name alone.

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