Skip to main content
Glama
debanjanbasu

grr

by debanjanbasu
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Rust
Local

sheets.spreadsheets.developerMetadata.search

Search developer metadata in a spreadsheet using DataFilter to retrieve entries matching a DeveloperMetadataLookup or associated with a specific location.

Instructions

Returns all developer metadata matching the specified DataFilter. For more information, see Read, write, and search metadata. If the provided DataFilter represents a DeveloperMetadataLookup object, this will return all DeveloperMetadata entries selected by it. If the DataFilter represents a location in a spreadsheet, this will return all developer metadata associated with locations intersecting that region [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 SearchDeveloperMetadataRequest object accepting dataFilters; pass it via params or whole via body_file Siblings over the same resource: get.

Input Schema

NameRequiredDescriptionDefault
queryNoExtra KEY=VALUE query pairs for endpoints whose parameters Discovery does not describe.
paramsNoParameter map merged into the request; typed parameters win.
dry_runNoReturn the request that would be sent, without sending it.
body_fileNoRead the request body from this file ('-' for stdin) instead of building one from the parameters. The body is a JSON SearchDeveloperMetadataRequest object.
request_bodyNoRequest body of type SearchDeveloperMetadataRequest: pass it via `params` (merged into the built body) or whole via `body_file`.
spreadsheetIdYes[URL path segment] The ID of the spreadsheet to retrieve metadata from.

Output Schema

NameRequiredDescriptionDefault
matchedDeveloperMetadataNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • 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 SearchDeveloperMetadataRequest object."
    • addedInput schema / properties / request_body
      Added value: +{
+  "description": "Request body of type SearchDeveloperMetadataRequest: pass it via `params` (merged into the built body) or whole via `body_file`.",
+  "properties": {
+    "dataFilters": {
+      "items": {
+        "properties": {
+          "a1Range": {
+            "type": "string"
+          },
+          "developerMetadataLookup": {
+            "properties": {
+              "locationMatchingStrategy": {
+                "enum": [
+                  "DEVELOPER_METADATA_LOCATION_MATCHING_STRATEGY_UNSPECIFIED",
+                  "EXACT_LOCATION",
+                  "INTERSECTING_LOCATION"
+                ],
+                "type": "string"
+              },
+              "locationType": {
+                "enum": [
+                  "DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED",
+                  "ROW",
+                  "COLUMN",
+                  "SHEET",
+                  "SPREADSHEET"
+                ],
+                "type": "string"
+              },
+              "metadataId": {
+                "type": "integer"
+              },
+              "metadataKey": {
+                "type": "string"
+              },
+              "metadataLocation": {
+                "properties": {
+                  "dimensionRange": {
+                    "type": "object"
+                  },
+                  "locationType": {
+                    "enum": [
+                      "DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED",
+                      "ROW",
+                      "COLUMN",
+                      "SHEET",
+                      "SPREADSHEET"
+                    ],
+                    "type": "string"
+                  },
+                  "sheetId": {
+                    "type": "integer"
+                  },
+                  "spreadsheet": {
+                    "type": "boolean"
+                  }
+                },
+                "type": "object"
+              },
+              "metadataValue": {
+                "type": "string"
+              },
+              "visibility": {
+                "enum": [
+                  "DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED",
+                  "DOCUMENT",
+                  "PROJECT"
+                ],
+                "type": "string"
+              }
+            },
+            "type": "object"
+          },
+          "gridRange": {
+            "properties": {
+              "endColumnIndex": {
+                "type": "integer"
+              },
+              "endRowIndex": {
+                "type": "integer"
+              },
+              "sheetId": {
+                "type": "integer"
+              },
+              "startColumnIndex": {
+                "type": "integer"
+              },
+              "startRowIndex": {
+                "type": "integer"
+              }
+            },
+            "type": "object"
+          }
+        },
+        "type": "object"
+      },
+      "type": "array"
+    }
+  },
+  "type": "object"
+}
  2. Changed2 schema fields changed
    • changedInput schema / properties / spreadsheetId / description
      Previous value: -"The ID of the spreadsheet to retrieve metadata from."New value: +"[URL path segment] The ID of the spreadsheet to retrieve metadata from."
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
+  "properties": {
+    "matchedDeveloperMetadata": {
+      "items": {
+        "properties": {
+          "dataFilters": {
+            "items": {
+              "properties": {
+                "a1Range": {
+                  "type": "string"
+                },
+                "developerMetadataLookup": {
+                  "properties": {
+                    "locationMatchingStrategy": {
+                      "enum": [
+                        "DEVELOPER_METADATA_LOCATION_MATCHING_STRATEGY_UNSPECIFIED",
+                        "EXACT_LOCATION",
+                        "INTERSECTING_LOCATION"
+                      ],
+                      "type": "string"
+                    },
+                    "locationType": {
+                      "enum": [
+                        "DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED",
+                        "ROW",
+                        "COLUMN",
+                        "SHEET",
+                        "SPREADSHEET"
+                      ],
+                      "type": "string"
+                    },
+                    "metadataId": {
+                      "type": "integer"
+                    },
+                    "metadataKey": {
+                      "type": "string"
+                    },
+                    "metadataLocation": {
+                      "type": "object"
+                    },
+                    "metadataValue": {
+                      "type": "string"
+                    },
+                    "visibility": {
+                      "enum": [
+                        "DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED",
+                        "DOCUMENT",
+                        "PROJECT"
+                      ],
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "gridRange": {
+                  "properties": {
+                    "endColumnIndex": {
+                      "type": "integer"
+                    },
+                    "endRowIndex": {
+                      "type": "integer"
+                    },
+                    "sheetId": {
+                      "type": "integer"
+                    },
+                    "startColumnIndex": {
+                      "type": "integer"
+                    },
+                    "startRowIndex": {
+                      "type": "integer"
+                    }
+                  },
+                  "type": "object"
+                }
+              },
+              "type": "object"
+            },
+            "type": "array"
+          },
+          "developerMetadata": {
+            "properties": {
+              "location": {
+                "properties": {
+                  "dimensionRange": {
+                    "type": "object"
+                  },
+                  "locationType": {
+                    "enum": [
+                      "DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED",
+                      "ROW",
+                      "COLUMN",
+                      "SHEET",
+                      "SPREADSHEET"
+                    ],
+                    "type": "string"
+                  },
+                  "sheetId": {
+                    "type": "integer"
+                  },
+                  "spreadsheet": {
+                    "type": "boolean"
+                  }
+                },
+                "type": "object"
+              },
+              "metadataId": {
+                "type": "integer"
+              },
+              "metadataKey": {
+                "type": "string"
+              },
+              "metadataValue": {
+                "type": "string"
+              },
+              "visibility": {
+                "enum": [
+                  "DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED",
+                  "DOCUMENT",
+                  "PROJECT"
+                ],
+                "type": "string"
+              }
+            },
+            "type": "object"
+          }
+        },
+        "type": "object"
+      },
+      "type": "array"
+    }
+  },
+  "type": "object"
+}
  3. First observed

TDQS

B3.4/5.0
Behavior3/5

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

No annotations exist, so the description carries the full burden, and it does disclose the POST method, the readonly-profile refusal, and the JSON response shape. But the phrase 'creates or triggers a change' mischaracterizes a search operation that mutates nothing, which could cause an agent to avoid a safe read or misjudge side effects.

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 core behavior is front-loaded in the first two sentences, but the remainder is a pasted mix of API guide prose, an HTTP-method/safety note, and body-routing instructions that reads as assembled rather than edited. Nothing is egregiously wasteful, but the ordering buries the safety constraint mid-sentence.

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?

Covers both DataFilter interpretation branches, the request body format and two transport options, and the readonly refusal, and an output schema exists so return-value detail is unnecessary. Only the search-vs-get distinction is left for the agent to infer.

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 schema already documents spreadsheetId, params, body_file, and the dataFilters body. The description restates that the body is a SearchDeveloperMetadataRequest and can go via `params` or `body_file`, adding confirmation but little new meaning.

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

Purpose4/5

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

States a specific verb and resource ('Returns all developer metadata matching the specified DataFilter') and explains the two filter modes clearly. It names the sibling 'get' but never says what distinguishes search from get, so full sibling differentiation is missing.

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?

Provides one real usage constraint — it is an HTTP POST that is refused under readonly safety profiles — which tells the agent when the call will fail. However there is no guidance on when to use search versus developerMetadata.get or spreadsheets.getByDataFilter, only a bare 'Siblings over the same resource: get' note.

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