MCP Tools Reference: file.googleapis.com

Tool: filestore_get_instance

Gets the details of a specific Filestore instance.

The following sample demonstrate how to use curl to invoke the filestore_get_instance MCP tool.

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

Input Schema

GetInstanceRequest gets the state of an instance.

GetInstanceRequest

JSON representation 
{
  "name": string
}
Fields
name

string

Required. The instance resource name, in the format projects/{project_id}/locations/{location}/instances/{instance_id}.

Output Schema

A Filestore instance.

Instance

JSON representation 
{
  "name": string,
  "description": string,
  "state": enum (State),
  "statusMessage": string,
  "createTime": string,
  "tier": enum (Tier),
  "labels": {
    string: string,
    ...
  },
  "fileShares": [
    {
      object (FileShareConfig)
    }
  ],
  "networks": [
    {
      object (NetworkConfig)
    }
  ],
  "etag": string,
  "satisfiesPzs": boolean,
  "satisfiesPzi": boolean,
  "kmsKeyName": string,
  "suspensionReasons": [
    enum (SuspensionReason)
  ],
  "replication": {
    object (Replication)
  },
  "tags": {
    string: string,
    ...
  },
  "protocol": enum (FileProtocol),
  "directoryServices": {
    object (DirectoryServicesConfig)
  },
  "customPerformanceSupported": boolean,
  "performanceConfig": {
    object (PerformanceConfig)
  },
  "performanceLimits": {
    object (PerformanceLimits)
  },
  "deletionProtectionEnabled": boolean,
  "deletionProtectionReason": string,
  "minCapacityGb": string,
  "maxCapacityGb": string,
  "capacityStepSizeGb": string
}
Fields
name

string

Output only. The resource name of the instance, in the format projects/{project}/locations/{location}/instances/{instance}.
description

string

The description of the instance (2048 characters or less).
state

enum (State)

Output only. The instance state.
statusMessage

string

Output only. Additional information about the instance state, if available.
createTime

string (Timestamp format)

Output only. The time when the instance was created.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
tier

enum (Tier)

The service tier of the instance.
labels

map (key: string, value: string)

Resource labels to represent user provided metadata.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
fileShares[]

object (FileShareConfig)

File system shares on the instance. For this version, only a single file share is supported.
networks[]

object (NetworkConfig)

VPC networks to which the instance is connected. For this version, only a single network is supported.
etag

string

Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.
satisfiesPzs

boolean

Output only. Reserved for future use.
satisfiesPzi

boolean

Output only. Reserved for future use.
kmsKeyName

string

KMS key name used for data encryption.
suspensionReasons[]

enum (SuspensionReason)

Output only. Field indicates all the reasons the instance is in "SUSPENDED" state.
replication

object (Replication)

Optional. Replication configuration.
tags

map (key: string, value: string)

Optional. Input only. Immutable. Tag key-value pairs bound to this resource. Each key must be a namespaced name and each value a short name. Example: "123456789012/environment" : "production", "123456789013/costCenter" : "marketing" See the documentation for more information: - Namespaced name: https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing#retrieving_tag_key - Short name: https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing#retrieving_tag_value

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
protocol

enum (FileProtocol)

Immutable. The protocol indicates the access protocol for all shares in the instance. This field is immutable and it cannot be changed after the instance has been created. Default value: NFS_V3.
directoryServices

object (DirectoryServicesConfig)

Optional. Directory Services configuration for Kerberos-based authentication. Should only be set if protocol is "NFS_V4_1".
customPerformanceSupported

boolean

Output only. Indicates whether this instance supports configuring its performance. If true, the user can configure the instance's performance by using the 'performance_config' field.
performanceConfig

object (PerformanceConfig)

Optional. Used to configure performance.
performanceLimits

object (PerformanceLimits)

Output only. Used for getting performance limits.
deletionProtectionEnabled

boolean

Optional. Indicates whether the instance is protected against deletion.
deletionProtectionReason

string

Optional. The reason for enabling deletion protection.
minCapacityGb

string (int64 format)

Output only. The minimum capacity of the instance in GB.
maxCapacityGb

string (int64 format)

Output only. The maximum capacity of the instance in GB.
capacityStepSizeGb

string (int64 format)

Output only. The incremental increase or decrease in capacity, designated in some number of GB.

Timestamp

JSON representation 
{
  "seconds": string,
  "nanos": integer
}
Fields
seconds

string (int64 format)

Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be between -62135596800 and 253402300799 inclusive (which corresponds to 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z).
nanos

integer

Non-negative fractions of a second at nanosecond resolution. This field is the nanosecond portion of the duration, not an alternative to seconds. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be between 0 and 999,999,999 inclusive.

LabelsEntry

JSON representation 
{
  "key": string,
  "value": string
}
Fields
key

string
value

string

FileShareConfig

JSON representation 
{
  "name": string,
  "capacityGb": string,
  "nfsExportOptions": [
    {
      object (NfsExportOptions)
    }
  ],

  // Union field source can be only one of the following:
  "sourceBackup": string,
  "sourceBackupdrBackup": string
  // End of list of possible types for union field source.
}
Fields
name

string

Required. The name of the file share. Must use 1-16 characters for the basic service tier and 1-63 characters for all other service tiers. Must use lowercase letters, numbers, or underscores [a-z0-9_]. Must start with a letter. Immutable.
capacityGb

string (int64 format)

File share capacity in gigabytes (GB). Filestore defines 1 GB as 1024^3 bytes.
nfsExportOptions[]

object (NfsExportOptions)

Nfs Export Options. There is a limit of 10 export options per file share.
Union field source. The source that this file share has been restored from. Empty if the file share is created from scratch. source can be only one of the following:
sourceBackup

string

The resource name of the backup, in the format projects/{project_number}/locations/{location_id}/backups/{backup_id}, that this file share has been restored from.
sourceBackupdrBackup

string

The resource name of the BackupDR backup, in the format projects/{project_id}/locations/{location_id}/backupVaults/{backupvault_id}/dataSources/{datasource_id}/backups/{backup_id},

NfsExportOptions

JSON representation 
{
  "ipRanges": [
    string
  ],
  "network": string,
  "accessMode": enum (AccessMode),
  "squashMode": enum (SquashMode),
  "anonUid": string,
  "anonGid": string
}
Fields
ipRanges[]

string

List of either an IPv4 addresses in the format {octet1}.{octet2}.{octet3}.{octet4} or CIDR ranges in the format {octet1}.{octet2}.{octet3}.{octet4}/{mask size} which may mount the file share. Overlapping IP ranges are not allowed, both within and across NfsExportOptions. An error will be returned. The limit is 64 IP ranges/addresses for each FileShareConfig among all NfsExportOptions.
network

string

Optional. The source VPC network for ip_ranges. Required for instances using Private Service Connect, optional otherwise. If provided, must be the same network specified in the NetworkConfig.network field.
accessMode

enum (AccessMode)

Either READ_ONLY, for allowing only read requests on the exported directory, or READ_WRITE, for allowing both read and write requests. The default is READ_WRITE.
squashMode

enum (SquashMode)

Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH.
anonUid

string (int64 format)

An integer representing the anonymous user id with a default value of 65534. Anon_uid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
anonGid

string (int64 format)

An integer representing the anonymous group id with a default value of 65534. Anon_gid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.

NetworkConfig

JSON representation 
{
  "network": string,
  "modes": [
    enum (AddressMode)
  ],
  "reservedIpRange": string,
  "ipAddresses": [
    string
  ],
  "connectMode": enum (ConnectMode),
  "pscConfig": {
    object (PscConfig)
  }
}
Fields
network

string

The name of the Google Compute Engine VPC network to which the instance is connected.
modes[]

enum (AddressMode)

Internet protocol versions for which the instance has IP addresses assigned.
reservedIpRange

string

Optional, reserved_ip_range can have one of the following two types of values.

  • CIDR range value when using DIRECT_PEERING connect mode.
  • Allocated IP address range when using PRIVATE_SERVICE_ACCESS connect mode.

When the name of an allocated IP address range is specified, it must be one of the ranges associated with the private service access connection. When specified as a direct CIDR value, it must be a /29 CIDR block for Basic tier, a /24 CIDR block for High Scale tier, or a /26 CIDR block for Enterprise tier in one of the internal IP address ranges that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29, 192.168.0.0/24 or 192.168.0.0/26, respectively. The range you specify can't overlap with either existing subnets or assigned IP address ranges for other Filestore instances in the selected VPC network.
ipAddresses[]

string

Output only. IPv4 addresses in the format {octet1}.{octet2}.{octet3}.{octet4} or IPv6 addresses in the format {block1}:{block2}:{block3}:{block4}:{block5}:{block6}:{block7}:{block8}.
connectMode

enum (ConnectMode)

The network connect mode of the Filestore instance. If not provided, the connect mode defaults to DIRECT_PEERING.
pscConfig

object (PscConfig)

Optional. Private Service Connect configuration. Should only be set when connect_mode is PRIVATE_SERVICE_CONNECT.

PscConfig

JSON representation 
{
  "endpointProject": string
}
Fields
endpointProject

string

Optional. Consumer service project in which the Private Service Connect endpoint would be set up. This is optional, and only relevant in case the network is a shared VPC. If this is not specified, the endpoint would be setup in the VPC host project.

BoolValue

JSON representation 
{
  "value": boolean
}
Fields
value

boolean

The bool value.

Replication

JSON representation 
{
  "role": enum (Role),
  "replicas": [
    {
      object (ReplicaConfig)
    }
  ]
}
Fields
role

enum (Role)

Optional. The replication role. When creating a new replica, this field must be set to STANDBY.
replicas[]

object (ReplicaConfig)

Optional. Replication configuration for the replica instance associated with this instance. Only a single replica is supported.

ReplicaConfig

JSON representation 
{
  "state": enum (State),
  "stateUpdateTime": string,
  "stateReasons": [
    enum (StateReason)
  ],
  "peerInstance": string,
  "lastActiveSyncTime": string
}
Fields
state

enum (State)

Output only. The replica state.
stateUpdateTime

string (Timestamp format)

Output only. The time when the replica state was updated.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
stateReasons[]

enum (StateReason)

Output only. Additional information about the replication state, if available.
peerInstance

string

Optional. The name of the source instance for the replica, in the format projects/{project}/locations/{location}/instances/{instance}. This field is required when creating a replica.
lastActiveSyncTime

string (Timestamp format)

Output only. The timestamp of the latest replication snapshot taken on the active instance and is already replicated safely.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

TagsEntry

JSON representation 
{
  "key": string,
  "value": string
}
Fields
key

string
value

string

DirectoryServicesConfig

JSON representation 
{

  // Union field config can be only one of the following:
  "ldap": {
    object (LdapConfig)
  }
  // End of list of possible types for union field config.
}
Fields

Union field config.

config can be only one of the following:
ldap

object (LdapConfig)

Configuration for LDAP servers.

LdapConfig

JSON representation 
{
  "domain": string,
  "servers": [
    string
  ],
  "usersOu": string,
  "groupsOu": string
}
Fields
domain

string

Required. The LDAP domain name in the format of my-domain.com.
servers[]

string

Required. The servers names are used for specifying the LDAP servers names. The LDAP servers names can come with two formats: 1. DNS name, for example: ldap.example1.com, ldap.example2.com. 2. IP address, for example: 10.0.0.1, 10.0.0.2, 10.0.0.3. All servers names must be in the same format: either all DNS names or all IP addresses.
usersOu

string

Optional. The users Organizational Unit (OU) is optional. This parameter is a hint to allow faster lookup in the LDAP namespace. In case that this parameter is not provided, Filestore instance will query the whole LDAP namespace.
groupsOu

string

Optional. The groups Organizational Unit (OU) is optional. This parameter is a hint to allow faster lookup in the LDAP namespace. In case that this parameter is not provided, Filestore instance will query the whole LDAP namespace.

PerformanceConfig

JSON representation 
{

  // Union field mode can be only one of the following:
  "iopsPerTb": {
    object (IOPSPerTB)
  },
  "fixedIops": {
    object (FixedIOPS)
  }
  // End of list of possible types for union field mode.
}
Fields

Union field mode.

mode can be only one of the following:
iopsPerTb

object (IOPSPerTB)

Provision IOPS dynamically based on the capacity of the instance. Provisioned IOPS will be calculated by multiplying the capacity of the instance in TiB by the iops_per_tb value. For example, for a 2 TiB instance with an iops_per_tb value of 17000 the provisioned IOPS will be 34000.

If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an InvalidArgument error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an InvalidArgument error.
fixedIops

object (FixedIOPS)

Choose a fixed provisioned IOPS value for the instance, which will remain constant regardless of instance capacity. Value must be a multiple of 1000.

If the chosen value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an InvalidArgument error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an InvalidArgument error.

IOPSPerTB

JSON representation 
{
  "maxIopsPerTb": string
}
Fields
maxIopsPerTb

string (int64 format)

Required. Maximum IOPS per TiB.

FixedIOPS

JSON representation 
{
  "maxIops": string
}
Fields
maxIops

string (int64 format)

Required. Maximum IOPS.

PerformanceLimits

JSON representation 
{
  "maxIops": string,
  "maxReadIops": string,
  "maxWriteIops": string,
  "maxReadThroughputBps": string,
  "maxWriteThroughputBps": string
}
Fields
maxIops

string (int64 format)

Output only. The maximum IOPS.
maxReadIops

string (int64 format)

Output only. The maximum read IOPS.
maxWriteIops

string (int64 format)

Output only. The maximum write IOPS.
maxReadThroughputBps

string (int64 format)

Output only. The maximum read throughput in bytes per second.
maxWriteThroughputBps

string (int64 format)

Output only. The maximum write throughput in bytes per second.

State

The instance state.

Enums
STATE_UNSPECIFIED State not set.
CREATING The instance is being created.
READY The instance is available for use.
REPAIRING Work is being done on the instance. You can get further details from the statusMessage field of the Instance resource.
DELETING The instance is shutting down.
ERROR The instance is experiencing an issue and might be unusable. You can get further details from the statusMessage field of the Instance resource.
RESTORING The instance is restoring a backup to an existing file share and may be unusable during this time.
SUSPENDED The instance is suspended. You can get further details from the suspension_reasons field of the Instance resource.
SUSPENDING The instance is in the process of becoming suspended.
RESUMING The instance is in the process of becoming active.
REVERTING The instance is reverting to a snapshot.
PROMOTING The replica instance is being promoted.

Tier

Available service tiers.

Enums
TIER_UNSPECIFIED Not set.
STANDARD STANDARD tier. BASIC_HDD is the preferred term for this tier.
PREMIUM PREMIUM tier. BASIC_SSD is the preferred term for this tier.
BASIC_HDD BASIC instances offer a maximum capacity of 63.9 TB. BASIC_HDD is an alias for STANDARD Tier, offering economical performance backed by HDD.
BASIC_SSD BASIC instances offer a maximum capacity of 63.9 TB. BASIC_SSD is an alias for PREMIUM Tier, and offers improved performance backed by SSD.
HIGH_SCALE_SSD HIGH_SCALE instances offer expanded capacity and performance scaling capabilities.
ENTERPRISE ENTERPRISE instances offer the features and availability needed for mission-critical workloads.
ZONAL ZONAL instances offer expanded capacity and performance scaling capabilities.
REGIONAL REGIONAL instances offer the features and availability needed for mission-critical workloads.

AccessMode

The access mode.

Enums
ACCESS_MODE_UNSPECIFIED AccessMode not set.
READ_ONLY The client can only read the file share.
READ_WRITE The client can read and write the file share (default).

SquashMode

The squash mode.

Enums
SQUASH_MODE_UNSPECIFIED SquashMode not set.
NO_ROOT_SQUASH The Root user has root access to the file share (default).
ROOT_SQUASH The Root user has squashed access to the anonymous uid/gid.

AddressMode

Internet protocol versions supported by Filestore.

Enums
ADDRESS_MODE_UNSPECIFIED Internet protocol not set.
MODE_IPV4 Use the IPv4 internet protocol.
MODE_IPV6 Use the IPv6 internet protocol. Only supported when using Private Service Connect.

ConnectMode

Available connection modes.

Enums
CONNECT_MODE_UNSPECIFIED Not set.
DIRECT_PEERING Connect via direct peering to the Filestore service.
PRIVATE_SERVICE_ACCESS Connect to your Filestore instance using Private Service Access. Private services access provides an IP address range for multiple Google Cloud services, including Filestore.
PRIVATE_SERVICE_CONNECT Connect to your Filestore instance using Private Service Connect. A connection policy must exist in the region for the VPC network and the google-cloud-filestore service class.

SuspensionReason

SuspensionReason contains the possible reasons for a suspension.

Enums
SUSPENSION_REASON_UNSPECIFIED Not set.
KMS_KEY_ISSUE The KMS key used by the instance is either revoked or denied access to.

Role

Replication role.

Enums
ROLE_UNSPECIFIED Role not set.
ACTIVE The instance is the ACTIVE replication member, functions as the replication source instance.
STANDBY The instance is the STANDBY replication member, functions as the replication destination instance.

State

The replica state.

Enums
STATE_UNSPECIFIED State not set.
CREATING The replica is being created.
READY The replica is ready.
REMOVING The replica is being removed.
FAILED The replica is experiencing an issue and might be unusable. You can get further details from the stateReasons field of the ReplicaConfig object.
PROMOTING The replica is being promoted.
PAUSING The replica is being paused.
PAUSED The replica is paused.
RESUMING The replica is being resumed.

StateReason

Additional information about the replication state, if available.

Enums
STATE_REASON_UNSPECIFIED Reason not specified.
PEER_INSTANCE_UNREACHABLE The peer instance is unreachable.
REMOVE_FAILED The remove replica peer instance operation failed.
PAUSE_FAILED The pause replica operation failed.
RESUME_FAILED The resume replica operation failed.

FileProtocol

File access protocol.

Enums
FILE_PROTOCOL_UNSPECIFIED FILE_PROTOCOL_UNSPECIFIED serves a "not set" default value when a FileProtocol is a separate field in a message.
NFS_V3 NFS 3.0.
NFS_V4_1 NFS 4.1.

Tool Annotations

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