Skip to main content
Glama

people.people.connections.list

List an authenticated user's contacts with pagination, field masks, sorting, and sync tokens for incremental updates.

Instructions

Provides a list of the authenticated user's contacts. Sync tokens expire 7 days after the full sync. A request with an expired sync token will get an error with an google.rpc.ErrorInfo with reason "EXPIRED_SYNC_TOKEN". In the case of such an error clients should make a full sync request without a sync_token. The first page of a full sync request has an additional quota. If the quota is exceeded, a 429 error will be returned. This quota is fixed and can not be increased. When the sync_token is specified, resources deleted since the l [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

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 connections to include in the response. Valid values are between 1 and 1000, inclusive. Defaults to 100 if not set or set to 0.
body_fileNoRead the request body from this file ('-' for stdin) instead of building one from the parameters.
pageTokenNo[query parameter] Optional. A page token, received from a previous response `next_page_token`. Provide this to retrieve the subsequent page. When paginating, all other parameters
sortOrderNo[query parameter] Optional. The order in which the connections should be sorted. Defaults to `LAST_MODIFIED_ASCENDING`. Values: `LAST_MODIFIED_ASCENDING` = Sort people by when they were changed; older entries first.; `LAST_MODIFIED_DESCENDING` = Sort people by when they were changed; newer entries first.; `FIRST_NAME_ASCENDING` = Sort people by first name.; `LAST_NAME_ASCENDING` = Sort people by last name..
syncTokenNo[query parameter] Optional. A sync token, received from a previous response `next_sync_token` Provide this to retrieve only the resources changed since the last request. When syn
personFieldsNo[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:
resourceNameYes[URL path segment] Required. The resource name to return connections for. Only `people/me` is valid.
requestSyncTokenNo[query parameter] Optional. Whether the response should return `next_sync_token` on the last page of results. It can be used to get incremental changes since the last request by
requestMask.includeFieldNo[query parameter] Required. Comma-separated list of person fields to be included in the response. Each path should start with `person.`: for example, `person.names` or `person.ph

Output Schema

NameRequiredDescriptionDefault
totalItemsNo
connectionsNo
totalPeopleNo
nextPageTokenNo
nextSyncTokenNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed14 schema fields changed
    • changedInput schema / properties / pageSize / description
      Previous value: -"Optional. The number of connections to include in the response. Valid values are between 1 and 1000, inclusive. Defaults to 100 if not set or set to 0."New value: +"[query parameter] Optional. The number of connections to include in the response. Valid values are between 1 and 1000, inclusive. Defaults to 100 if not set or set to 0."
    • addedInput schema / properties / pageSize / format
      Added value: +"int32"
    • changedInput schema / properties / pageToken / description
      Previous value: -"Optional. A page token, received from a previous response `next_page_token`. Provide this to retrieve the subsequent page. When paginating, all other parameters"New value: +"[query parameter] Optional. A page token, received from a previous response `next_page_token`. Provide this to retrieve the subsequent page. When paginating, all other parameters"
    • changedInput schema / properties / personFields / 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 / personFields / format
      Added value: +"google-fieldmask"
    • changedInput schema / properties / requestMask.includeField / description
      Previous value: -"Required. Comma-separated list of person fields to be included in the response. Each path should start with `person.`: for example, `person.names` or `person.ph"New value: +"[query parameter] Required. Comma-separated list of person fields to be included in the response. Each path should start with `person.`: for example, `person.names` or `person.ph"
    • addedInput schema / properties / requestMask.includeField / format
      Added value: +"google-fieldmask"
    • changedInput schema / properties / requestSyncToken / description
      Previous value: -"Optional. Whether the response should return `next_sync_token` on the last page of results. It can be used to get incremental changes since the last request by "New value: +"[query parameter] Optional. Whether the response should return `next_sync_token` on the last page of results. It can be used to get incremental changes since the last request by "
    • changedInput schema / properties / resourceName / description
      Previous value: -"Required. The resource name to return connections for. Only `people/me` is valid."New value: +"[URL path segment] Required. The resource name to return connections for. Only `people/me` is valid."
    • addedInput schema / properties / resourceName / pattern
      Added value: +"^people/[^/]+$"
    • changedInput schema / properties / sortOrder / description
      Previous value: -"Optional. The order in which the connections should be sorted. Defaults to `LAST_MODIFIED_ASCENDING`."New value: +"[query parameter] Optional. The order in which the connections should be sorted. Defaults to `LAST_MODIFIED_ASCENDING`. Values: `LAST_MODIFIED_ASCENDING` = Sort people by when they were changed; older entries first.; `LAST_MODIFIED_DESCENDING` = Sort people by when they were changed; newer entries first.; `FIRST_NAME_ASCENDING` = Sort people by first name.; `LAST_NAME_ASCENDING` = Sort people by last name.."
    • changedInput schema / properties / sources / items / description
      Previous value: -"Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set."New value: +"[query parameter] Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE 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.."
    • changedInput schema / properties / syncToken / description
      Previous value: -"Optional. A sync token, received from a previous response `next_sync_token` Provide this to retrieve only the resources changed since the last request. When syn"New value: +"[query parameter] Optional. A sync token, received from a previous response `next_sync_token` Provide this to retrieve only the resources changed since the last request. When syn"
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "properties": {
      +    "connections": {
      +      "items": {
      +        "properties": {
      +          "addresses": {
      +            "items": {
      +              "properties": {
      +                "city": {
      +                  "type": "string"
      +                },
      +                "country": {
      +                  "type": "string"
      +                },
      +                "countryCode": {
      +                  "type": "string"
      +                },
      +                "extendedAddress": {
      +                  "type": "string"
      +                },
      +                "formattedType": {
      +                  "type": "string"
      +                },
      +                "formattedValue": {
      +                  "type": "string"
      +                },
      +                "metadata": {
      +                  "properties": {
      +                    "primary": {
      +                      "type": "boolean"
      +                    },
      +                    "source": {
      +                      "type": "object"
      +                    },
      +                    "sourcePrimary": {
      +                      "type": "boolean"
      +                    },
      +                    "verified": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "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": {
      +                  "properties": {
      +                    "primary": {
      +                      "type": "boolean"
      +                    },
      +                    "source": {
      +                      "type": "object"
      +                    },
      +                    "sourcePrimary": {
      +                      "type": "boolean"
      +                    },
      +                    "verified": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "type": "object"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "biographies": {
      +            "items": {
      +              "properties": {
      +                "contentType": {
      +                  "enum": [
      +                    "CONTENT_TYPE_UNSPECIFIED",
      +                    "TEXT_PLAIN",
      +                    "TEXT_HTML"
      +                  ],
      +                  "type": "string"
      +                },
      +                "metadata": {
      +                  "properties": {
      +                    "primary": {
      +                      "type": "boolean"
      +                    },
      +                    "source": {
      +                      "type": "object"
      +                    },
      +                    "sourcePrimary": {
      +                      "type": "boolean"
      +                    },
      +                    "verified": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "value": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "birthdays": {
      +            "items": {
      +              "properties": {
      +                "date": {
      +                  "properties": {
      +                    "day": {
      +                      "type": "integer"
      +                    },
      +                    "month": {
      +                      "type": "integer"
      +                    },
      +                    "year": {
      +                      "type": "integer"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "metadata": {
      +                  "properties": {
      +                    "primary": {
      +                      "type": "boolean"
      +                    },
      +                    "source": {
      +                      "type": "object"
      +                    },
      +                    "sourcePrimary": {
      +                      "type": "boolean"
      +                    },
      +                    "verified": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "text": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "braggingRights": {
      +            "items": {
      +              "properties": {
      +                "metadata": {
      +                  "properties": {
      +                    "primary": {
      +                      "type": "boolean"
      +                    },
      +                    "source": {
      +                      "type": "object"
      +                    },
      +                    "sourcePrimary": {
      +                      "type": "boolean"
      +                    },
      +                    "verified": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "value": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "calendarUrls": {
      +            "items": {
      +              "properties": {
      +                "formattedType": {
      +                  "type": "string"
      +                },
      +                "metadata": {
      +                  "properties": {
      +                    "primary": {
      +                      "type": "boolean"
      +                    },
      +                    "source": {
      +                      "type": "object"
      +                    },
      +                    "sourcePrimary": {
      +                      "type": "boolean"
      +                    },
      +                    "verified": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "type": {
      +                  "type": "string"
      +                },
      +                "url": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "clientData": {
      +            "items": {
      +              "properties": {
      +                "key": {
      +                  "type": "string"
      +                },
      +                "metadata": {
      +                  "properties": {
      +                    "primary": {
      +                      "type": "boolean"
      +                    },
      +                    "source": {
      +                      "type": "object"
      +                    },
      +                    "sourcePrimary": {
      +                      "type": "boolean"
      +                    },
      +                    "verified": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "value": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "coverPhotos": {
      +            "items": {
      +              "properties": {
      +                "default": {
      +                  "type": "boolean"
      +                },
      +                "metadata": {
      +                  "properties": {
      +                    "primary": {
      +                      "type": "boolean"
      +                    },
      +                    "source": {
      +                      "type": "object"
      +                    },
      +                    "sourcePrimary": {
      +                      "type": "boolean"
      +                    },
      +                    "verified": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "url": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "emailAddresses": {
      +            "items": {
      +              "properties": {
      +                "displayName": {
      +                  "type": "string"
      +                },
      +                "formattedType": {
      +                  "type": "string"
      +                },
      +                "metadata": {
      +                  "properties": {
      +                    "primary": {
      +                      "type": "boolean"
      +                    },
      +                    "source": {
      +                      "type": "object"
      +                    },
      +                    "sourcePrimary": {
      +                      "type": "boolean"
      +                    },
      +                    "verified": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "type": {
      +                  "type": "string"
      +                },
      +                "value": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "etag": {
      +            "type": "string"
      +          },
      +          "events": {
      +            "items": {
      +              "properties": {
      +                "date": {
      +                  "properties": {
      +                    "day": {
      +                      "type": "integer"
      +                    },
      +                    "month": {
      +                      "type": "integer"
      +                    },
      +                    "year": {
      +                      "type": "integer"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "formattedType": {
      +                  "type": "string"
      +                },
      +                "metadata": {
      +                  "properties": {
      +                    "primary": {
      +                      "type": "boolean"
      +                    },
      +                    "source": {
      +                      "type": "object"
      +                    },
      +                    "sourcePrimary": {
      +                      "type": "boolean"
      +                    },
      +                    "verified": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "type": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "externalIds": {
      +            "items": {
      +              "properties": {
      +                "formattedType": {
      +                  "type": "string"
      +                },
      +                "metadata": {
      +                  "properties": {
      +                    "primary": {
      +                      "type": "boolean"
      +                    },
      +                    "source": {
      +                      "type": "object"
      +                    },
      +                    "sourcePrimary": {
      +                      "type": "boolean"
      +                    },
      +                    "verified": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "type": {
      +                  "type": "string"
      +                },
      +                "value": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "fileAses": {
      +            "items": {
      +              "properties": {
      +                "metadata": {
      +                  "properties": {
      +                    "primary": {
      +                      "type": "boolean"
      +                    },
      +                    "source": {
      +                      "type": "object"
      +                    },
      +                    "sourcePrimary": {
      +                      "type": "boolean"
      +                    },
      +                    "verified": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "value": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "genders": {
      +            "items": {
      +              "properties": {
      +                "addressMeAs": {
      +                  "type": "string"
      +                },
      +                "formattedValue": {
      +                  "type": "string"
      +                },
      +                "metadata": {
      +                  "properties": {
      +                    "primary": {
      +                      "type": "boolean"
      +                    },
      +                    "source": {
      +                      "type": "object"
      +                    },
      +                    "sourcePrimary": {
      +                      "type": "boolean"
      +                    },
      +                    "verified": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "value": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "imClients": {
      +            "items": {
      +              "properties": {
      +                "formattedProtocol": {
      +                  "type": "string"
      +                },
      +                "formattedType": {
      +                  "type": "string"
      +                },
      +                "metadata": {
      +                  "properties": {
      +                    "primary": {
      +                      "type": "boolean"
      +                    },
      +                    "source": {
      +                      "type": "object"
      +                    },
      +                    "sourcePrimary": {
      +                      "type": "boolean"
      +                    },
      +                    "verified": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "protocol": {
      +                  "type": "string"
      +                },
      +                "type": {
      +                  "type": "string"
      +                },
      +                "username": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "interests": {
      +            "items": {
      +              "properties": {
      +                "metadata": {
      +                  "properties": {
      +                    "primary": {
      +                      "type": "boolean"
      +                    },
      +                    "source": {
      +                      "type": "object"
      +                    },
      +                    "sourcePrimary": {
      +                      "type": "boolean"
      +                    },
      +                    "verified": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "value": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "locales": {
      +            "items": {
      +              "properties": {
      +                "metadata": {
      +                  "properties": {
      +                    "primary": {
      +                      "type": "boolean"
      +                    },
      +                    "source": {
      +                      "type": "object"
      +                    },
      +                    "sourcePrimary": {
      +                      "type": "boolean"
      +                    },
      +                    "verified": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "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": {
      +                  "properties": {
      +                    "primary": {
      +                      "type": "boolean"
      +                    },
      +                    "source": {
      +                      "type": "object"
      +                    },
      +                    "sourcePrimary": {
      +                      "type": "boolean"
      +                    },
      +                    "verified": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "type": {
      +                  "type": "string"
      +                },
      +                "value": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "memberships": {
      +            "items": {
      +              "properties": {
      +                "contactGroupMembership": {
      +                  "properties": {
      +                    "contactGroupId": {
      +                      "type": "string"
      +                    },
      +                    "contactGroupResourceName": {
      +                      "type": "string"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "domainMembership": {
      +                  "properties": {
      +                    "inViewerDomain": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "metadata": {
      +                  "properties": {
      +                    "primary": {
      +                      "type": "boolean"
      +                    },
      +                    "source": {
      +                      "type": "object"
      +                    },
      +                    "sourcePrimary": {
      +                      "type": "boolean"
      +                    },
      +                    "verified": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "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": {
      +                  "properties": {
      +                    "etag": {
      +                      "type": "string"
      +                    },
      +                    "id": {
      +                      "type": "string"
      +                    },
      +                    "profileMetadata": {
      +                      "type": "object"
      +                    },
      +                    "type": {
      +                      "enum": [
      +                        "SOURCE_TYPE_UNSPECIFIED",
      +                        "ACCOUNT",
      +                        "PROFILE",
      +                        "DOMAIN_PROFILE",
      +                        "CONTACT",
      +                        "OTHER_CONTACT",
      +                        "DOMAIN_CONTACT"
      +                      ],
      +                      "type": "string"
      +                    },
      +                    "updateTime": {
      +                      "type": "string"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "type": "array"
      +              }
      +            },
      +            "type": "object"
      +          },
      +          "miscKeywords": {
      +            "items": {
      +              "properties": {
      +                "formattedType": {
      +                  "type": "string"
      +                },
      +                "metadata": {
      +                  "properties": {
      +                    "primary": {
      +                      "type": "boolean"
      +                    },
      +                    "source": {
      +                      "type": "object"
      +                    },
      +                    "sourcePrimary": {
      +                      "type": "boolean"
      +                    },
      +                    "verified": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "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": {
      +                  "properties": {
      +                    "primary": {
      +                      "type": "boolean"
      +                    },
      +                    "source": {
      +                      "type": "object"
      +                    },
      +                    "sourcePrimary": {
      +                      "type": "boolean"
      +                    },
      +                    "verified": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "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": {
      +                  "properties": {
      +                    "primary": {
      +                      "type": "boolean"
      +                    },
      +                    "source": {
      +                      "type": "object"
      +                    },
      +                    "sourcePrimary": {
      +                      "type": "boolean"
      +                    },
      +                    "verified": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "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": {
      +                  "properties": {
      +                    "primary": {
      +                      "type": "boolean"
      +                    },
      +                    "source": {
      +                      "type": "object"
      +                    },
      +                    "sourcePrimary": {
      +                      "type": "boolean"
      +                    },
      +                    "verified": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "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": {
      +                  "properties": {
      +                    "day": {
      +                      "type": "integer"
      +                    },
      +                    "month": {
      +                      "type": "integer"
      +                    },
      +                    "year": {
      +                      "type": "integer"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "formattedType": {
      +                  "type": "string"
      +                },
      +                "fullTimeEquivalentMillipercent": {
      +                  "type": "integer"
      +                },
      +                "jobDescription": {
      +                  "type": "string"
      +                },
      +                "location": {
      +                  "type": "string"
      +                },
      +                "metadata": {
      +                  "properties": {
      +                    "primary": {
      +                      "type": "boolean"
      +                    },
      +                    "source": {
      +                      "type": "object"
      +                    },
      +                    "sourcePrimary": {
      +                      "type": "boolean"
      +                    },
      +                    "verified": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "name": {
      +                  "type": "string"
      +                },
      +                "phoneticName": {
      +                  "type": "string"
      +                },
      +                "startDate": {
      +                  "properties": {
      +                    "day": {
      +                      "type": "integer"
      +                    },
      +                    "month": {
      +                      "type": "integer"
      +                    },
      +                    "year": {
      +                      "type": "integer"
      +                    }
      +                  },
      +                  "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": {
      +                  "properties": {
      +                    "primary": {
      +                      "type": "boolean"
      +                    },
      +                    "source": {
      +                      "type": "object"
      +                    },
      +                    "sourcePrimary": {
      +                      "type": "boolean"
      +                    },
      +                    "verified": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "type": {
      +                  "type": "string"
      +                },
      +                "value": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "photos": {
      +            "items": {
      +              "properties": {
      +                "default": {
      +                  "type": "boolean"
      +                },
      +                "metadata": {
      +                  "properties": {
      +                    "primary": {
      +                      "type": "boolean"
      +                    },
      +                    "source": {
      +                      "type": "object"
      +                    },
      +                    "sourcePrimary": {
      +                      "type": "boolean"
      +                    },
      +                    "verified": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "url": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "relations": {
      +            "items": {
      +              "properties": {
      +                "formattedType": {
      +                  "type": "string"
      +                },
      +                "metadata": {
      +                  "properties": {
      +                    "primary": {
      +                      "type": "boolean"
      +                    },
      +                    "source": {
      +                      "type": "object"
      +                    },
      +                    "sourcePrimary": {
      +                      "type": "boolean"
      +                    },
      +                    "verified": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "person": {
      +                  "type": "string"
      +                },
      +                "type": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "relationshipInterests": {
      +            "items": {
      +              "properties": {
      +                "formattedValue": {
      +                  "type": "string"
      +                },
      +                "metadata": {
      +                  "properties": {
      +                    "primary": {
      +                      "type": "boolean"
      +                    },
      +                    "source": {
      +                      "type": "object"
      +                    },
      +                    "sourcePrimary": {
      +                      "type": "boolean"
      +                    },
      +                    "verified": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "value": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "relationshipStatuses": {
      +            "items": {
      +              "properties": {
      +                "formattedValue": {
      +                  "type": "string"
      +                },
      +                "metadata": {
      +                  "properties": {
      +                    "primary": {
      +                      "type": "boolean"
      +                    },
      +                    "source": {
      +                      "type": "object"
      +                    },
      +                    "sourcePrimary": {
      +                      "type": "boolean"
      +                    },
      +                    "verified": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "value": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "residences": {
      +            "items": {
      +              "properties": {
      +                "current": {
      +                  "type": "boolean"
      +                },
      +                "metadata": {
      +                  "properties": {
      +                    "primary": {
      +                      "type": "boolean"
      +                    },
      +                    "source": {
      +                      "type": "object"
      +                    },
      +                    "sourcePrimary": {
      +                      "type": "boolean"
      +                    },
      +                    "verified": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "value": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "resourceName": {
      +            "type": "string"
      +          },
      +          "sipAddresses": {
      +            "items": {
      +              "properties": {
      +                "formattedType": {
      +                  "type": "string"
      +                },
      +                "metadata": {
      +                  "properties": {
      +                    "primary": {
      +                      "type": "boolean"
      +                    },
      +                    "source": {
      +                      "type": "object"
      +                    },
      +                    "sourcePrimary": {
      +                      "type": "boolean"
      +                    },
      +                    "verified": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "type": {
      +                  "type": "string"
      +                },
      +                "value": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "skills": {
      +            "items": {
      +              "properties": {
      +                "metadata": {
      +                  "properties": {
      +                    "primary": {
      +                      "type": "boolean"
      +                    },
      +                    "source": {
      +                      "type": "object"
      +                    },
      +                    "sourcePrimary": {
      +                      "type": "boolean"
      +                    },
      +                    "verified": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "value": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "taglines": {
      +            "items": {
      +              "properties": {
      +                "metadata": {
      +                  "properties": {
      +                    "primary": {
      +                      "type": "boolean"
      +                    },
      +                    "source": {
      +                      "type": "object"
      +                    },
      +                    "sourcePrimary": {
      +                      "type": "boolean"
      +                    },
      +                    "verified": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "value": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "urls": {
      +            "items": {
      +              "properties": {
      +                "formattedType": {
      +                  "type": "string"
      +                },
      +                "metadata": {
      +                  "properties": {
      +                    "primary": {
      +                      "type": "boolean"
      +                    },
      +                    "source": {
      +                      "type": "object"
      +                    },
      +                    "sourcePrimary": {
      +                      "type": "boolean"
      +                    },
      +                    "verified": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "type": {
      +                  "type": "string"
      +                },
      +                "value": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "userDefined": {
      +            "items": {
      +              "properties": {
      +                "key": {
      +                  "type": "string"
      +                },
      +                "metadata": {
      +                  "properties": {
      +                    "primary": {
      +                      "type": "boolean"
      +                    },
      +                    "source": {
      +                      "type": "object"
      +                    },
      +                    "sourcePrimary": {
      +                      "type": "boolean"
      +                    },
      +                    "verified": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "value": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          }
      +        },
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "nextPageToken": {
      +      "type": "string"
      +    },
      +    "nextSyncToken": {
      +      "type": "string"
      +    },
      +    "totalItems": {
      +      "type": "integer"
      +    },
      +    "totalPeople": {
      +      "type": "integer"
      +    }
      +  },
      +  "type": "object"
      +}
  2. First observed

TDQS

B3.4/5.0
Behavior4/5

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

With no annotations provided, the description carries the full burden and does disclose meaningful behavior: authenticated-user scope, HTTP GET semantics, JSON response, sync-token expiry after 7 days, EXPIRED_SYNC_TOKEN handling, and fixed first-page quota with 429 responses. It stops short of fully covering pagination mechanics or OAuth scope requirements, but it is substantially better than bare purpose text.

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

Conciseness2/5

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

The description is front-loaded with a useful purpose sentence, but it becomes a rambling block mixing sync-token details, a truncated sentence, and generic HTTP-wrapper boilerplate about JSON responses and body_file. That boilerplate is not specific to this list operation and reduces clarity.

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 and parameter schema coverage is high, so the description need not explain return values or most fields. It adequately covers the list purpose and sync-token caveats, but it omits sibling-tool selection guidance and contains truncated/generic wrapper text, leaving it only minimally complete for a 13-parameter list tool.

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 92%, so the schema already documents most parameters thoroughly, including sources, pageSize, pageToken, sortOrder, syncToken, and personFields. The description adds some sync-token context but little parameter-level meaning beyond the schema, making 3 the appropriate 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 first sentence gives a specific verb and resource: 'Provides a list of the authenticated user's contacts.' It distinguishes the authenticated user's contacts from broader directory contacts, though it does not explicitly name the nearest siblings such as people.people.searchContacts or people.people.listDirectoryPeople.

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 description gives clear context for sync-token usage and quota errors, which helps with ongoing-sync scenarios. However, it does not say when to use this tool instead of searchContacts, listDirectoryPeople, otherContacts.list, or getBatchGet, leaving tool selection largely 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