Skip to main content
Glama
debanjanbasu

grr

by debanjanbasu
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Rust
Local

analyticsadmin.properties.customMetrics.list

Lists custom metrics defined on a Google Analytics property, with pagination, so you can inspect available metric definitions.

Instructions

Lists CustomMetrics on a property [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: archive, create, get, patch.

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.
parentYes[URL path segment] Required. Example format: properties/1234
dry_runNoReturn the request that would be sent, without sending it.
pageSizeNo[query parameter] The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the
body_fileNoRead the request body from this file ('-' for stdin) instead of building one from the parameters.
pageTokenNo[query parameter] A page token, received from a previous `ListCustomMetrics` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to

Output Schema

NameRequiredDescriptionDefault
customMetricsNo
nextPageTokenNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed6 schema fields changed
    • changedInput schema / properties / pageSize / description
      Previous value: -"The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the"New value: +"[query parameter] The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the"
    • addedInput schema / properties / pageSize / format
      Added value: +"int32"
    • changedInput schema / properties / pageToken / description
      Previous value: -"A page token, received from a previous `ListCustomMetrics` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to"New value: +"[query parameter] A page token, received from a previous `ListCustomMetrics` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to"
    • changedInput schema / properties / parent / description
      Previous value: -"Required. Example format: properties/1234"New value: +"[URL path segment] Required. Example format: properties/1234"
    • addedInput schema / properties / parent / pattern
      Added value: +"^properties/[^/]+$"
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
+  "properties": {
+    "customMetrics": {
+      "items": {
+        "properties": {
+          "description": {
+            "type": "string"
+          },
+          "displayName": {
+            "type": "string"
+          },
+          "measurementUnit": {
+            "enum": [
+              "MEASUREMENT_UNIT_UNSPECIFIED",
+              "STANDARD",
+              "CURRENCY",
+              "FEET",
+              "METERS",
+              "KILOMETERS",
+              "MILES",
+              "MILLISECONDS",
+              "SECONDS",
+              "MINUTES",
+              "HOURS"
+            ],
+            "type": "string"
+          },
+          "name": {
+            "type": "string"
+          },
+          "parameterName": {
+            "type": "string"
+          },
+          "restrictedMetricType": {
+            "items": {
+              "enum": [
+                "RESTRICTED_METRIC_TYPE_UNSPECIFIED",
+                "COST_DATA",
+                "REVENUE_DATA"
+              ],
+              "type": "string"
+            },
+            "type": "array"
+          },
+          "scope": {
+            "enum": [
+              "METRIC_SCOPE_UNSPECIFIED",
+              "EVENT"
+            ],
+            "type": "string"
+          }
+        },
+        "type": "object"
+      },
+      "type": "array"
+    },
+    "nextPageToken": {
+      "type": "string"
+    }
+  },
+  "type": "object"
+}
  2. First observed

TDQS

B3.4/5.0
Behavior3/5

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

With no annotations, the description carries the full burden. It discloses the safe read profile via '[HTTP GET]' and that the result is JSON, which is genuinely useful. However, the majority of the second sentence describes request-body construction and body_file mechanics that are irrelevant to a GET list call, and it says nothing about pagination behavior, permissions, or rate limits.

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

Conciseness3/5

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

The purpose is front-loaded and the sibling sentence earns its place, but the intervening sentence about typed parameters overriding the params map and reading whole bodies from body_file is boilerplate noise for a list endpoint and dilutes an otherwise short definition.

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?

An output schema exists and all seven parameters are fully documented in the schema, so the description need not explain return values or pagination mechanics. Combined with the explicit sibling list and GET indication, this is complete enough to call 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 description coverage is 100%, so the baseline is 3; the schema already documents parent, pageSize, pageToken, dry_run, params, query and body_file. The description adds no parameter-level meaning and in fact muddies things by discussing body_file/body-building for a query-only operation.

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 states a specific verb and resource ('Lists CustomMetrics on a property') and names the sibling verbs over the same resource (archive, create, get, patch), so an agent can place it as the enumeration variant. It falls short of a 5 because the siblings are merely enumerated without routing guidance.

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?

Listing the sibling operations implies this is the tool for enumerating existing custom metrics rather than mutating or fetching a single one, but it never states when to prefer list over get, nor any exclusions or prerequisites. Usage is inferable rather than spelled out.

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