Skip to main content
Glama

people.contactGroups.batchGet

Fetch details for multiple contact groups owned by the authenticated user by passing up to 200 resource names; returns the requested groups as JSON.

Instructions

Get a list of contact groups owned by the authenticated user by specifying a list of contact group resource names [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, delete, get, list, update.

Input Schema

NameRequiredDescriptionDefault
queryNoExtra KEY=VALUE query pairs for endpoints whose parameters Discovery does not describe.
paramsNoParameter map merged into the request; typed parameters win.
dry_runNoReturn the request that would be sent, without sending it.
body_fileNoRead the request body from this file ('-' for stdin) instead of building one from the parameters.
maxMembersNo[query parameter] Optional. Specifies the maximum number of members to return for each group. Defaults to 0 if not set, which will return zero members.
groupFieldsNo[query parameter] Optional. A field mask to restrict which fields on the group are returned. Defaults to `metadata`, `groupType`, `memberCount`, and `name` if not set or set to e
resourceNamesNo

Output Schema

NameRequiredDescriptionDefault
responsesNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed6 schema fields changed
    • changedInput schema / properties / groupFields / description
      Previous value: -"Optional. A field mask to restrict which fields on the group are returned. Defaults to `metadata`, `groupType`, `memberCount`, and `name` if not set or set to e"New value: +"[query parameter] Optional. A field mask to restrict which fields on the group are returned. Defaults to `metadata`, `groupType`, `memberCount`, and `name` if not set or set to e"
    • addedInput schema / properties / groupFields / format
      Added value: +"google-fieldmask"
    • changedInput schema / properties / maxMembers / description
      Previous value: -"Optional. Specifies the maximum number of members to return for each group. Defaults to 0 if not set, which will return zero members."New value: +"[query parameter] Optional. Specifies the maximum number of members to return for each group. Defaults to 0 if not set, which will return zero members."
    • addedInput schema / properties / maxMembers / format
      Added value: +"int32"
    • changedInput schema / properties / resourceNames / items / description
      Previous value: -"Required. The resource names of the contact groups to get. There is a maximum of 200 resource names."New value: +"[query parameter] Required. The resource names of the contact groups to get. There is a maximum of 200 resource names."
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "properties": {
      +    "responses": {
      +      "items": {
      +        "properties": {
      +          "contactGroup": {
      +            "properties": {
      +              "clientData": {
      +                "items": {
      +                  "properties": {
      +                    "key": {
      +                      "type": "string"
      +                    },
      +                    "value": {
      +                      "type": "string"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "type": "array"
      +              },
      +              "etag": {
      +                "type": "string"
      +              },
      +              "formattedName": {
      +                "type": "string"
      +              },
      +              "groupType": {
      +                "enum": [
      +                  "GROUP_TYPE_UNSPECIFIED",
      +                  "USER_CONTACT_GROUP",
      +                  "SYSTEM_CONTACT_GROUP"
      +                ],
      +                "type": "string"
      +              },
      +              "memberCount": {
      +                "type": "integer"
      +              },
      +              "memberResourceNames": {
      +                "items": {
      +                  "type": "string"
      +                },
      +                "type": "array"
      +              },
      +              "metadata": {
      +                "properties": {
      +                  "deleted": {
      +                    "type": "boolean"
      +                  },
      +                  "updateTime": {
      +                    "type": "string"
      +                  }
      +                },
      +                "type": "object"
      +              },
      +              "name": {
      +                "type": "string"
      +              },
      +              "resourceName": {
      +                "type": "string"
      +              }
      +            },
      +            "type": "object"
      +          },
      +          "requestedResourceName": {
      +            "type": "string"
      +          },
      +          "status": {
      +            "properties": {
      +              "code": {
      +                "type": "integer"
      +              },
      +              "details": {
      +                "items": {
      +                  "type": "object"
      +                },
      +                "type": "array"
      +              },
      +              "message": {
      +                "type": "string"
      +              }
      +            },
      +            "type": "object"
      +          }
      +        },
      +        "type": "object"
      +      },
      +      "type": "array"
      +    }
      +  },
      +  "type": "object"
      +}
  2. First observed

TDQS

B3.3/5.0
Behavior3/5

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

With no annotations, the description carries the full load; it does disclose that this is an HTTP GET returning JSON, which establishes read-only semantics, and explains the params-vs-typed-parameter precedence. But the claim that 'request bodies are built from the typed parameters ... or read whole from body_file' is incoherent for a GET endpoint and adds confusion rather than clarity. It also says nothing about auth scopes or the 200-resource cap.

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

Conciseness3/5

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

Two sentences, so length is fine and the purpose is front-loaded. The middle clause about request bodies and body_file is boilerplate that does not earn its place on a GET tool and actively distracts, while the genuinely useful sibling routing is buried at the very end.

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?

An output schema exists, so return values need not be explained, and the schema covers most parameters. What is missing for a 7-parameter tool with zero annotations is any statement of auth requirements or the practical constraint that omitting maxMembers returns zero members per group — leaving the agent to infer batching limits from the schema alone.

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 86%, so the schema already documents maxMembers, groupFields, and resourceNames in detail; baseline is 3. The description only echoes the resourceNames intent ('a list of contact group resource names') and gives a precedence rule for the generic `params` map versus typed flags, without adding format or default guidance beyond the schema.

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?

States a specific verb and resource with scope: get contact groups owned by the authenticated user, keyed by a list of resource names. It names the sibling family (create, delete, get, list, update), which helps placement. However, it never distinguishes batchGet from the singular `get` sibling on the same resource, and the framing is muddied by generic request-body boilerplate that does not belong to a read call.

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

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The phrase 'by specifying a list of contact group resource names' implies this is the bulk-retrieval variant, and the sibling list gives context. But there is no explicit when-to-use rule such as 'use this instead of get when you have multiple group resource names', and no stated prerequisites or exclusions.

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

Deploy Server

Other Tools