grr

Overview Schema Source Related Servers Discussions Admin

analyticsadmin.properties.customDimensions.archive

Archives a custom dimension on a Google Analytics property, marking it inactive without deleting its historical data. Use it to retire a dimension you no longer collect or report on.

Instructions

Archives a CustomDimension on a property [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON GoogleAnalyticsAdminV1betaArchiveCustomDimensionRequest object; pass it via params or whole via body_file Siblings over the same resource: create, get, list, patch.

Input Schema

Name	Required	Description
`name`	Yes	[URL path segment] Required. The name of the CustomDimension to archive. Example format: properties/1234/customDimensions/5678
`query`	No	Extra KEY=VALUE query pairs for endpoints whose parameters Discovery does not describe.
`params`	No	Parameter map merged into the request; typed parameters win.
`dry_run`	No	Return the request that would be sent, without sending it.
`body_file`	No	Read the request body from this file ('-' for stdin) instead of building one from the parameters. The body is a JSON GoogleAnalyticsAdminV1betaArchiveCustomDimensionRequest object.
`request_body`	No	Request body of type GoogleAnalyticsAdminV1betaArchiveCustomDimensionRequest: pass it via `params` (merged into the built body) or whole via `body_file`.

Output Schema

Name	Required	Description	Default
No arguments

Schema Changelog

Changes observed during successful MCP inspections.

Changed2 schema fields changedOct 26, 2026

changedInput schema / properties / body_file / description

Previous value: -"Read the request body from this file ('-' for stdin) instead of building one from the parameters."New value: +"Read the request body from this file ('-' for stdin) instead of building one from the parameters. The body is a JSON GoogleAnalyticsAdminV1betaArchiveCustomDimensionRequest object."

addedInput schema / properties / request_body

Added value: +{
+  "description": "Request body of type GoogleAnalyticsAdminV1betaArchiveCustomDimensionRequest: pass it via `params` (merged into the built body) or whole via `body_file`.",
+  "type": "object"
+}

Changed3 schema fields changedOct 26, 2026

changedInput schema / properties / name / description

Previous value: -"Required. The name of the CustomDimension to archive. Example format: properties/1234/customDimensions/5678"New value: +"[URL path segment] Required. The name of the CustomDimension to archive. Example format: properties/1234/customDimensions/5678"

addedInput schema / properties / name / pattern

Added value: +"^properties/[^/]+/customDimensions/[^/]+$"

changedOutput schema / (root)

Previous value: -nullNew value: +{
+  "type": "object"
+}

First observedOct 26, 2026

TDQS

A4/5.0

Behavior4/5

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

With no annotations, the description carries the disclosure burden and does it well: HTTP POST, 'creates or triggers a change', explicit refusal under readonly profiles, and return of the API response resource. It stops short of saying whether archiving is reversible or what permissions/scopes are required, which keeps it from a 5.

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

Conciseness5/5

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

The core action and the readonly caveat come first, followed by return format and body-passing mechanics; every clause is load-bearing and there is no filler despite the dense em-dash construction.

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?

For a mutating call with no annotations, the description covers action, mutation semantics, safety-profile behavior, return type, and body-passing mechanics, and an output schema exists so return values need no elaboration. Missing only prerequisites such as required permissions or reversibility of the archive.

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 description restates that the body is a GoogleAnalyticsAdminV1betaArchiveCustomDimensionRequest passed via `params` or `body_file`, but that duplicates what the schema already documents for those properties rather than adding new meaning.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('Archives a CustomDimension on a property') and names the sibling operations over the same resource (create, get, list, patch), so an agent can distinguish it without opening another schema.

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 gives a real usage constraint — refused under --readonly safety profiles — which tells the agent when the call will not work, and it lists sibling operations. But it does not say when to archive versus patch or delete a custom dimension, so the choice guidance is only implied by the sibling enumeration.

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

Deploy Server