Skip to main content
Glama
debanjanbasu

grr

by debanjanbasu
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Rust
Local

people.people.searchContacts

Search the authenticated user's grouped contacts by name, nickname, email, phone, or organization and return matches as JSON. Send an empty warmup query first to update the cache.

Instructions

Provides a list of contacts in the authenticated user's grouped contacts that matches the search query. The query matches on a contact's names, nickNames, emailAddresses, phoneNumbers, and organizations fields that are from the CONTACT source. IMPORTANT: Before searching, clients should send a warmup request with an empty query to update the cache. See https://developers.google.com/people/v1/contacts#search_the_users_contacts [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: batchCreateContacts, batchDeleteContacts, batchUpdateContacts, createContact, deleteContact, deleteContactPhoto, get, getBatchGet, listDirectoryPeople, searchDirectoryPeople, updateContact, updateContactPhoto.

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.
sourcesNo
pageSizeNo[query parameter] Optional. The number of results to return. Defaults to 10 if field is not set, or set to 0. Values greater than 30 will be capped to 30.
readMaskNo[query parameter] Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are:
body_fileNoRead the request body from this file ('-' for stdin) instead of building one from the parameters.

Output Schema

NameRequiredDescriptionDefault
resultsNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed6 schema fields changed
    • changedInput schema / properties / pageSize / description
      Previous value: -"Optional. The number of results to return. Defaults to 10 if field is not set, or set to 0. Values greater than 30 will be capped to 30."New value: +"[query parameter] Optional. The number of results to return. Defaults to 10 if field is not set, or set to 0. Values greater than 30 will be capped to 30."
    • addedInput schema / properties / pageSize / format
      Added value: +"int32"
    • changedInput schema / properties / readMask / description
      Previous value: -"Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: "New value: +"[query parameter] Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: "
    • addedInput schema / properties / readMask / format
      Added value: +"google-fieldmask"
    • changedInput schema / properties / sources / items / description
      Previous value: -"Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT if not set."New value: +"[query parameter] Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT if not set. Values: `READ_SOURCE_TYPE_UNSPECIFIED` = Unspecified.; `READ_SOURCE_TYPE_PROFILE` = Returns SourceType.ACCOUNT, SourceType.DOMAIN_PROFILE, and SourceType.PROFILE.; `READ_SOURCE_TYPE_CONTACT` = Returns SourceType.CONTACT.; `READ_SOURCE_TYPE_DOMAIN_CONTACT` = Returns SourceType.DOMAIN_CONTACT.; `READ_SOURCE_TYPE_OTHER_CONTACT` = Returns SourceType.OTHER_CONTACT.."
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
+  "properties": {
+    "results": {
+      "items": {
+        "properties": {
+          "person": {
+            "properties": {
+              "addresses": {
+                "items": {
+                  "properties": {
+                    "city": {
+                      "type": "string"
+                    },
+                    "country": {
+                      "type": "string"
+                    },
+                    "countryCode": {
+                      "type": "string"
+                    },
+                    "extendedAddress": {
+                      "type": "string"
+                    },
+                    "formattedType": {
+                      "type": "string"
+                    },
+                    "formattedValue": {
+                      "type": "string"
+                    },
+                    "metadata": {
+                      "type": "object"
+                    },
+                    "poBox": {
+                      "type": "string"
+                    },
+                    "postalCode": {
+                      "type": "string"
+                    },
+                    "region": {
+                      "type": "string"
+                    },
+                    "streetAddress": {
+                      "type": "string"
+                    },
+                    "type": {
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "ageRange": {
+                "enum": [
+                  "AGE_RANGE_UNSPECIFIED",
+                  "LESS_THAN_EIGHTEEN",
+                  "EIGHTEEN_TO_TWENTY",
+                  "TWENTY_ONE_OR_OLDER"
+                ],
+                "type": "string"
+              },
+              "ageRanges": {
+                "items": {
+                  "properties": {
+                    "ageRange": {
+                      "enum": [
+                        "AGE_RANGE_UNSPECIFIED",
+                        "LESS_THAN_EIGHTEEN",
+                        "EIGHTEEN_TO_TWENTY",
+                        "TWENTY_ONE_OR_OLDER"
+                      ],
+                      "type": "string"
+                    },
+                    "metadata": {
+                      "type": "object"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "biographies": {
+                "items": {
+                  "properties": {
+                    "contentType": {
+                      "enum": [
+                        "CONTENT_TYPE_UNSPECIFIED",
+                        "TEXT_PLAIN",
+                        "TEXT_HTML"
+                      ],
+                      "type": "string"
+                    },
+                    "metadata": {
+                      "type": "object"
+                    },
+                    "value": {
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "birthdays": {
+                "items": {
+                  "properties": {
+                    "date": {
+                      "type": "object"
+                    },
+                    "metadata": {
+                      "type": "object"
+                    },
+                    "text": {
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "braggingRights": {
+                "items": {
+                  "properties": {
+                    "metadata": {
+                      "type": "object"
+                    },
+                    "value": {
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "calendarUrls": {
+                "items": {
+                  "properties": {
+                    "formattedType": {
+                      "type": "string"
+                    },
+                    "metadata": {
+                      "type": "object"
+                    },
+                    "type": {
+                      "type": "string"
+                    },
+                    "url": {
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "clientData": {
+                "items": {
+                  "properties": {
+                    "key": {
+                      "type": "string"
+                    },
+                    "metadata": {
+                      "type": "object"
+                    },
+                    "value": {
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "coverPhotos": {
+                "items": {
+                  "properties": {
+                    "default": {
+                      "type": "boolean"
+                    },
+                    "metadata": {
+                      "type": "object"
+                    },
+                    "url": {
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "emailAddresses": {
+                "items": {
+                  "properties": {
+                    "displayName": {
+                      "type": "string"
+                    },
+                    "formattedType": {
+                      "type": "string"
+                    },
+                    "metadata": {
+                      "type": "object"
+                    },
+                    "type": {
+                      "type": "string"
+                    },
+                    "value": {
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "etag": {
+                "type": "string"
+              },
+              "events": {
+                "items": {
+                  "properties": {
+                    "date": {
+                      "type": "object"
+                    },
+                    "formattedType": {
+                      "type": "string"
+                    },
+                    "metadata": {
+                      "type": "object"
+                    },
+                    "type": {
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "externalIds": {
+                "items": {
+                  "properties": {
+                    "formattedType": {
+                      "type": "string"
+                    },
+                    "metadata": {
+                      "type": "object"
+                    },
+                    "type": {
+                      "type": "string"
+                    },
+                    "value": {
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "fileAses": {
+                "items": {
+                  "properties": {
+                    "metadata": {
+                      "type": "object"
+                    },
+                    "value": {
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "genders": {
+                "items": {
+                  "properties": {
+                    "addressMeAs": {
+                      "type": "string"
+                    },
+                    "formattedValue": {
+                      "type": "string"
+                    },
+                    "metadata": {
+                      "type": "object"
+                    },
+                    "value": {
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "imClients": {
+                "items": {
+                  "properties": {
+                    "formattedProtocol": {
+                      "type": "string"
+                    },
+                    "formattedType": {
+                      "type": "string"
+                    },
+                    "metadata": {
+                      "type": "object"
+                    },
+                    "protocol": {
+                      "type": "string"
+                    },
+                    "type": {
+                      "type": "string"
+                    },
+                    "username": {
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "interests": {
+                "items": {
+                  "properties": {
+                    "metadata": {
+                      "type": "object"
+                    },
+                    "value": {
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "locales": {
+                "items": {
+                  "properties": {
+                    "metadata": {
+                      "type": "object"
+                    },
+                    "value": {
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "locations": {
+                "items": {
+                  "properties": {
+                    "buildingId": {
+                      "type": "string"
+                    },
+                    "current": {
+                      "type": "boolean"
+                    },
+                    "deskCode": {
+                      "type": "string"
+                    },
+                    "floor": {
+                      "type": "string"
+                    },
+                    "floorSection": {
+                      "type": "string"
+                    },
+                    "metadata": {
+                      "type": "object"
+                    },
+                    "type": {
+                      "type": "string"
+                    },
+                    "value": {
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "memberships": {
+                "items": {
+                  "properties": {
+                    "contactGroupMembership": {
+                      "type": "object"
+                    },
+                    "domainMembership": {
+                      "type": "object"
+                    },
+                    "metadata": {
+                      "type": "object"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "metadata": {
+                "properties": {
+                  "deleted": {
+                    "type": "boolean"
+                  },
+                  "linkedPeopleResourceNames": {
+                    "items": {
+                      "type": "string"
+                    },
+                    "type": "array"
+                  },
+                  "objectType": {
+                    "enum": [
+                      "OBJECT_TYPE_UNSPECIFIED",
+                      "PERSON",
+                      "PAGE"
+                    ],
+                    "type": "string"
+                  },
+                  "previousResourceNames": {
+                    "items": {
+                      "type": "string"
+                    },
+                    "type": "array"
+                  },
+                  "sources": {
+                    "items": {
+                      "type": "object"
+                    },
+                    "type": "array"
+                  }
+                },
+                "type": "object"
+              },
+              "miscKeywords": {
+                "items": {
+                  "properties": {
+                    "formattedType": {
+                      "type": "string"
+                    },
+                    "metadata": {
+                      "type": "object"
+                    },
+                    "type": {
+                      "enum": [
+                        "TYPE_UNSPECIFIED",
+                        "OUTLOOK_BILLING_INFORMATION",
+                        "OUTLOOK_DIRECTORY_SERVER",
+                        "OUTLOOK_KEYWORD",
+                        "OUTLOOK_MILEAGE",
+                        "OUTLOOK_PRIORITY",
+                        "OUTLOOK_SENSITIVITY",
+                        "OUTLOOK_SUBJECT",
+                        "OUTLOOK_USER",
+                        "HOME",
+                        "WORK",
+                        "OTHER"
+                      ],
+                      "type": "string"
+                    },
+                    "value": {
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "names": {
+                "items": {
+                  "properties": {
+                    "displayName": {
+                      "type": "string"
+                    },
+                    "displayNameLastFirst": {
+                      "type": "string"
+                    },
+                    "familyName": {
+                      "type": "string"
+                    },
+                    "givenName": {
+                      "type": "string"
+                    },
+                    "honorificPrefix": {
+                      "type": "string"
+                    },
+                    "honorificSuffix": {
+                      "type": "string"
+                    },
+                    "metadata": {
+                      "type": "object"
+                    },
+                    "middleName": {
+                      "type": "string"
+                    },
+                    "phoneticFamilyName": {
+                      "type": "string"
+                    },
+                    "phoneticFullName": {
+                      "type": "string"
+                    },
+                    "phoneticGivenName": {
+                      "type": "string"
+                    },
+                    "phoneticHonorificPrefix": {
+                      "type": "string"
+                    },
+                    "phoneticHonorificSuffix": {
+                      "type": "string"
+                    },
+                    "phoneticMiddleName": {
+                      "type": "string"
+                    },
+                    "unstructuredName": {
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "nicknames": {
+                "items": {
+                  "properties": {
+                    "metadata": {
+                      "type": "object"
+                    },
+                    "type": {
+                      "enum": [
+                        "DEFAULT",
+                        "MAIDEN_NAME",
+                        "INITIALS",
+                        "GPLUS",
+                        "OTHER_NAME",
+                        "ALTERNATE_NAME",
+                        "SHORT_NAME"
+                      ],
+                      "type": "string"
+                    },
+                    "value": {
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "occupations": {
+                "items": {
+                  "properties": {
+                    "metadata": {
+                      "type": "object"
+                    },
+                    "value": {
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "organizations": {
+                "items": {
+                  "properties": {
+                    "costCenter": {
+                      "type": "string"
+                    },
+                    "current": {
+                      "type": "boolean"
+                    },
+                    "department": {
+                      "type": "string"
+                    },
+                    "domain": {
+                      "type": "string"
+                    },
+                    "endDate": {
+                      "type": "object"
+                    },
+                    "formattedType": {
+                      "type": "string"
+                    },
+                    "fullTimeEquivalentMillipercent": {
+                      "type": "integer"
+                    },
+                    "jobDescription": {
+                      "type": "string"
+                    },
+                    "location": {
+                      "type": "string"
+                    },
+                    "metadata": {
+                      "type": "object"
+                    },
+                    "name": {
+                      "type": "string"
+                    },
+                    "phoneticName": {
+                      "type": "string"
+                    },
+                    "startDate": {
+                      "type": "object"
+                    },
+                    "symbol": {
+                      "type": "string"
+                    },
+                    "title": {
+                      "type": "string"
+                    },
+                    "type": {
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "phoneNumbers": {
+                "items": {
+                  "properties": {
+                    "canonicalForm": {
+                      "type": "string"
+                    },
+                    "formattedType": {
+                      "type": "string"
+                    },
+                    "metadata": {
+                      "type": "object"
+                    },
+                    "type": {
+                      "type": "string"
+                    },
+                    "value": {
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "photos": {
+                "items": {
+                  "properties": {
+                    "default": {
+                      "type": "boolean"
+                    },
+                    "metadata": {
+                      "type": "object"
+                    },
+                    "url": {
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "relations": {
+                "items": {
+                  "properties": {
+                    "formattedType": {
+                      "type": "string"
+                    },
+                    "metadata": {
+                      "type": "object"
+                    },
+                    "person": {
+                      "type": "string"
+                    },
+                    "type": {
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "relationshipInterests": {
+                "items": {
+                  "properties": {
+                    "formattedValue": {
+                      "type": "string"
+                    },
+                    "metadata": {
+                      "type": "object"
+                    },
+                    "value": {
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "relationshipStatuses": {
+                "items": {
+                  "properties": {
+                    "formattedValue": {
+                      "type": "string"
+                    },
+                    "metadata": {
+                      "type": "object"
+                    },
+                    "value": {
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "residences": {
+                "items": {
+                  "properties": {
+                    "current": {
+                      "type": "boolean"
+                    },
+                    "metadata": {
+                      "type": "object"
+                    },
+                    "value": {
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "resourceName": {
+                "type": "string"
+              },
+              "sipAddresses": {
+                "items": {
+                  "properties": {
+                    "formattedType": {
+                      "type": "string"
+                    },
+                    "metadata": {
+                      "type": "object"
+                    },
+                    "type": {
+                      "type": "string"
+                    },
+                    "value": {
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "skills": {
+                "items": {
+                  "properties": {
+                    "metadata": {
+                      "type": "object"
+                    },
+                    "value": {
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "taglines": {
+                "items": {
+                  "properties": {
+                    "metadata": {
+                      "type": "object"
+                    },
+                    "value": {
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "urls": {
+                "items": {
+                  "properties": {
+                    "formattedType": {
+                      "type": "string"
+                    },
+                    "metadata": {
+                      "type": "object"
+                    },
+                    "type": {
+                      "type": "string"
+                    },
+                    "value": {
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "userDefined": {
+                "items": {
+                  "properties": {
+                    "key": {
+                      "type": "string"
+                    },
+                    "metadata": {
+                      "type": "object"
+                    },
+                    "value": {
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              }
+            },
+            "type": "object"
+          }
+        },
+        "type": "object"
+      },
+      "type": "array"
+    }
+  },
+  "type": "object"
+}
  2. First observed

TDQS

A3.7/5.0
Behavior4/5

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

With no annotations, the description carries the burden and does add useful behavioral context: it states the HTTP method, the warmup-cache requirement, and that request bodies are built from typed parameters or body_file. It does not discuss auth, permissions, or rate limits, but it is substantially more transparent than a bare 'search contacts' description.

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 purpose and search-field semantics are front-loaded, and the important warmup caveat is bolded early. The sibling enumeration and generic body_file/params explanation add some boilerplate at the end, but the description remains readable and appropriately sized overall.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given an output schema and 86% schema coverage, the description supplies the missing search semantics and the all-important warmup behavior. It does not cover auth requirements or quota behavior, but it is complete enough for an agent to identify and invoke this search endpoint correctly.

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 high at 86%, so the schema already documents most parameters and the baseline is 3. The description adds meaning for the search query by naming the fields it matches, but it does not reconcile that search semantics with the schema's generic `query` array description or explain the required-looking `readMask` in prose.

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 gives a specific verb and resource: it searches contacts in the authenticated user's grouped contacts and states which fields are matched. The scoping to 'grouped contacts' and CONTACT source helps distinguish it from people.searchDirectoryPeople, but it does not explicitly route between them.

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?

It includes a valuable usage prerequisite: clients should send a warmup request with an empty query before searching. However, it does not clearly say when to use this tool rather than siblings like searchDirectoryPeople or listDirectoryPeople, so the when-vs-alternative guidance is only implied.

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