## Tool: `list_locations`

Lists information about the supported locations.

**When to use it:**

- Use this tool to discover which Google Cloud regions are supported by Firebase SQL Connect for your project.

**How to use it:**

- Call `list_locations` with the `name` parameter set to the project resource name (e.g., `projects/my-project`).
- Supports pagination with `pageSize` and `pageToken`. By not providing `pageSize`, it returns as many locations as the server can pack into a single response. But you must still use `pageToken` to get the next page of locations.
- Supports filtering with `filter`.

**JSON Example:**

    {
              "name": "projects/my-project",
              "pageSize": 10
            }
            

The following code sample shows how to use `curl` to call the `list_locations` MCP tool.

| Curl Request |
|---|
| ```bash curl --location 'https://firebasedataconnect.googleapis.com/mcp' \ --header 'content-type: application/json' \ --header 'accept: application/json, text/event-stream' \ --data '{ "method": "tools/call", "params": { "name": "list_locations", "arguments": { // provide these details according to the tool's MCP specification } }, "jsonrpc": "2.0", "id": 1 }' ``` |

## Input Schema

The request message for `Locations.ListLocations`.

### ListLocationsRequest

| JSON representation |
|---|
| ``` { "name": string, "filter": string, "pageSize": integer, "pageToken": string, "extraLocationTypes": [ string ] } ``` |

| Fields ||
|---|---|
| `name` | `string` The resource that owns the locations collection, if applicable. |
| `filter` | `string` A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). |
| `pageSize` | `integer` The maximum number of results to return. If not set, the service selects a default. |
| `pageToken` | `string` A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. |
| `extraLocationTypes[]` | `string` Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. |

## Output Schema

The response message for `Locations.ListLocations`.

### ListLocationsResponse

| JSON representation |
|---|
| ``` { "locations": [ { object (`https://firebase.google.com/docs/reference/sql-connect/mcp/tools_list/list_locations#Output.Schema.Location`) } ], "nextPageToken": string } ``` |

| Fields ||
|---|---|
| `locations[]` | ``object (`https://firebase.google.com/docs/reference/sql-connect/mcp/tools_list/list_locations#Output.Schema.Location`)`` A list of locations that matches the specified filter in the request. |
| `nextPageToken` | `string` The standard List next-page token. |

### Location

| JSON representation |
|---|
| ``` { "name": string, "locationId": string, "displayName": string, "labels": { string: string, ... }, "metadata": { "@type": string, field1: ..., ... } } ``` |

| Fields ||
|---|---|
| `name` | `string` Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` |
| `locationId` | `string` The canonical id for this location. For example: `"us-east1"`. |
| `displayName` | `string` The friendly name for this location, typically a nearby city name. For example, "Tokyo". |
| `labels` | `map (key: string, value: string)` Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} An object containing a list of `"key": value` pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`. |
| `metadata` | `object` Service-specific metadata. For example the available capacity at the given location. An object containing fields of an arbitrary type. An additional field `"@type"` contains a URI identifying the type. Example: `{ "id": 1234, "@type": "types.example.com/standard/id" }`. |

### LabelsEntry

| JSON representation |
|---|
| ``` { "key": string, "value": string } ``` |

| Fields ||
|---|---|
| `key` | `string` |
| `value` | `string` |

### Any

| JSON representation |
|---|
| ``` { "typeUrl": string, "value": string } ``` |

| Fields ||
|---|---|
| `typeUrl` | `string` Identifies the type of the serialized Protobuf message with a URI reference consisting of a prefix ending in a slash and the fully-qualified type name. Example: type.googleapis.com/google.protobuf.StringValue This string must contain at least one `/` character, and the content after the last `/` must be the fully-qualified name of the type in canonical form, without a leading dot. Do not write a scheme on these URI references so that clients do not attempt to contact them. The prefix is arbitrary and Protobuf implementations are expected to simply strip off everything up to and including the last `/` to identify the type. `type.googleapis.com/` is a common default prefix that some legacy implementations require. This prefix does not indicate the origin of the type, and URIs containing it are not expected to respond to any requests. All type URL strings must be legal URI references with the additional restriction (for the text format) that the content of the reference must consist only of alphanumeric characters, percent-encoded escapes, and characters in the following set (not including the outer backticks): `/-.~_!$&()*+,;=`. Despite our allowing percent encodings, implementations should not unescape them to prevent confusion with existing parsers. For example, `type.googleapis.com%2FFoo` should be rejected. In the original design of `Any`, the possibility of launching a type resolution service at these type URLs was considered but Protobuf never implemented one and considers contacting these URLs to be problematic and a potential security issue. Do not attempt to contact type URLs. |
| `value` | `string (https://developers.google.com/discovery/v1/type-format format)` Holds a Protobuf serialization of the type described by type_url. A base64-encoded string. |

### Tool Annotations


[Tool annotations](https://modelcontextprotocol.io/specification/latest/schema#toolannotations) are sent to MCP clients to describe the basic risk of a given tool. Most clients treat these hints as untrusted, but they can be used to decide when a confirmation prompt might be sent to a user.


Along with the title string, the following boolean hints are defined as follows:

- `readOnlyHint`: If true, the tool doesn't modify its environment. Default: false.
- `destructiveHint`: If true, then the tool can perform destructive actions. If false, then the tool can only perform additive actions. Default: true.
- `idempotentHint`: If true, then calling the tool repeatedly with the same arguments will have no additional effect on its environment. Default: false.
- `openWorldHint`: If true, then the tool can interact with an 'open world' of external entities. If false, then the tool can only interact with internal entities. For example, a web search tool would be open world, while a memory tool would not be open world.

Destructive Hint: ❌ \| Idempotent Hint: ✅ \| Read Only Hint: ✅ \| Open World Hint: ❌