Skip to main content
Glama

list_forwarding_addresses

Retrieve configured email forwarding addresses for a Gmail account to manage where incoming messages are redirected.

Instructions

Lists the forwarding addresses for the specified account

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • src/index.ts:1102-1111 (registration)
    Registration of the 'list_forwarding_addresses' tool, including inline handler that uses the Gmail API to list forwarding addresses for the account.
    server.tool("list_forwarding_addresses",
      "Lists the forwarding addresses for the specified account",
      {},
      async () => {
        return handleTool(config, async (gmail: gmail_v1.Gmail) => {
          const { data } = await gmail.users.settings.forwardingAddresses.list({ userId: 'me' })
          return formatResponse(data)
        })
      }
    )
  • The handler function for 'list_forwarding_addresses' is inline in the registration; it invokes handleTool which performs the authenticated Gmail API call to list forwarding addresses.
    server.tool("list_forwarding_addresses",
      "Lists the forwarding addresses for the specified account",
      {},
      async () => {
        return handleTool(config, async (gmail: gmail_v1.Gmail) => {
          const { data } = await gmail.users.settings.forwardingAddresses.list({ userId: 'me' })
          return formatResponse(data)
        })
      }
    )
  • Shared 'handleTool' helper function that manages OAuth2 authentication, validates credentials, creates Gmail client, and executes the API call provided by the tool handler.
    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}`
      }
    }
Behavior2/5

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

No annotations are provided, so the description carries full burden. It states the action ('Lists') but doesn't disclose behavioral traits such as authentication requirements, rate limits, pagination, return format, or whether it's read-only. For a list operation with zero annotation coverage, this is a significant gap in transparency.

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, efficient sentence with zero waste. It's front-loaded with the core action and resource, making it easy to parse quickly without 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?

Given the lack of annotations and output schema, the description is incomplete. It doesn't explain what the tool returns (e.g., list format, fields), authentication needs, or error conditions. For a tool in a context with many siblings and no structured output, more detail is warranted to ensure proper agent usage.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The input schema has 0 parameters with 100% coverage, so no parameter documentation is needed. The description doesn't add param info, which is appropriate, but it implies an unspecified account parameter ('for the specified account'), slightly exceeding the schema. This minor addition doesn't detract from the high baseline.

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 verb ('Lists') and resource ('forwarding addresses for the specified account'), making the purpose unambiguous. However, it doesn't distinguish this tool from similar siblings like 'get_forwarding_address' (which likely retrieves a single address) or 'list_delegates' (which lists a different resource), missing 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. It doesn't mention prerequisites (e.g., account specification), exclusions, or comparisons to siblings like 'get_forwarding_address' or 'list_delegates', leaving usage context implied at best.

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