Console
    Start free

    MCP Tools Reference: composer.googleapis.com

    Tool: create_environment

    Initiates the creation of a new Cloud Composer environment with default settings.

    This tool creates a small private IP environment with a default configuration, including default networking settings.

    Creating public IP environments, or customizing most settings (such as network, subnetwork, network attachment, environment size, CMEK or custom environment bucket) is not supported.

    If the user requests settings that aren't supported by the tool parameters, inform them that this tool can't create an environment in the requested configuration, and that they should use gcloud CLI or Cloud Console instead.

    Some environment configuration parameters are mandatory. Always ask about them:

    • Always ask the user to provide a service account that they want to use for their environment. Users are strongly recommended to use a dedicated user-managed service account and are discouraged from using the default Cloud Compute service account for security reasons.

    • Always ask the user to specify the IP ranges that they want to use to access the Airflow UI and web server. If the user doesn't specify IP ranges, clarify that the default is not allowing access from any IPs. We also recommend to not allow access from all IP addresses to avoid potential security risks.

    This tool creates an environment without pre-installed PyPI packages. Use the manage_pypi_packages tool to install PyPI packages after the environment is created.

    This tool triggers the environment creation process, which is a long-running operation. The tool returns an operation object. Use the get_operation tool with the operation name returned by this tool to poll for creation status. Environment creation typically takes 25-30 minutes. A completed operation will include the details of the created environment.

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

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

    Input Schema

    Parameters of the create_environment tool.

    CreateEnvironmentRequestMCP

    JSON representation 
     { 
 "parent" 
 : 
 string 
 , 
 "environmentId" 
 : 
 string 
 , 
 "serviceAccount" 
 : 
 string 
 , 
 "allowedWebServerIpRanges" 
 : 
 [ 
 string 
 ] 
 , 
 "imageVersion" 
 : 
 string 
 }
    Fields
    parent

    string

    Required. The parent resource under which the environment is created. Format: projects/{projectId}/locations/{locationId}

    environmentId

    string

    Required. The name of the environment.

    serviceAccount

    string

    Required. The Google Cloud Platform Service Account to be used by the environment.

    allowedWebServerIpRanges[]

    string

    Required. Specifies the IP ranges allowed to access the Airflow web server.

    • To allow access from ANY IP address, provide a list containing only the wildcard "*". Example: ["*"] . WARNING: This makes the web server accessible from the public internet and can be a security risk.
    • To DENY access from all IP addresses, provide an empty list: [] .
    • To allow access ONLY from specific IP ranges, provide a list of IP ranges in CIDR notation. Example: ["192.0.2.0/24", "198.51.100.0/24"] .
    imageVersion

    string

    Optional. The version of the Composer environment. If not specified, the latest version of Composer 3 and Airflow 2 will be used. Users are recommended to use Composer 3 over Composer 2.

    The format must match composer-{composer-version}-airflow-{airflow-version} , where: * {composer-version} must be a full semantic version or an alias in the form of major version number or latest . When an alias is provided, the server uses the latest supported Cloud Composer version that satisfies the alias. * {airflow-version} must be a full semantic version that points to one of the supported Apache Airflow versions, or an alias in the form of only major or major.minor versions specified. When an alias is provided, the server uses the latest supported Apache Airflow version that satisfies the alias.

    Example values: * composer-3-airflow-2 * composer-3-airflow-2.10.5 * composer-latest-airflow-3.1.0 * composer-2.16.5-airflow-2.9

    Output Schema

    This resource represents a long-running operation that is the result of a network API call.

    Operation

    JSON representation 
     { 
 "name" 
 : 
 string 
 , 
 "metadata" 
 : 
 { 
 "@type" 
 : 
 string 
 , 
 field1 
 : 
 ... 
 , 
 ... 
 } 
 , 
 "done" 
 : 
 boolean 
 , 
 // Union field result 
can be only one of the following: 
 "error" 
 : 
 { 
 object (  Status 
 
) 
 } 
 , 
 "response" 
 : 
 { 
 "@type" 
 : 
 string 
 , 
 field1 
 : 
 ... 
 , 
 ... 
 } 
 // End of list of possible types for union field result 
. 
 }
    Fields
    name

    string

    The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id} .

    metadata

    object

    Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

    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" } .

    done

    boolean

    If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available.

    Union field result . The operation result, which can be either an error or a valid response . If done == false , neither error nor response is set. If done == true , exactly one of error or response can be set. Some services might not provide the result. result can be only one of the following:
    error

    object ( Status )

    The error result of the operation in case of failure or cancellation.

    response

    object

    The normal, successful response of the operation. If the original method returns no data on success, such as Delete , the response is google.protobuf.Empty . If the original method is standard Get / Create / Update , the response should be the resource. For other methods, the response should have the type XxxResponse , where Xxx is the original method name. For example, if the original method name is TakeSnapshot() , the inferred response type is TakeSnapshotResponse .

    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" } .

    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 ( bytes format)

    Holds a Protobuf serialization of the type described by type_url.

    A base64-encoded string.

    Status

    JSON representation 
     { 
 "code" 
 : 
 integer 
 , 
 "message" 
 : 
 string 
 , 
 "details" 
 : 
 [ 
 { 
 "@type" 
 : 
 string 
 , 
 field1 
 : 
 ... 
 , 
 ... 
 } 
 ] 
 }
    Fields
    code

    integer

    The status code, which should be an enum value of google.rpc.Code .
    message

    string

    A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
    details[]

    object

    A list of messages that carry the error details. There is a common set of message types for APIs to use.

    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" } .

    Tool Annotations

    Destructive Hint: ❌ | Idempotent Hint: ✅ | Read Only Hint: ❌ | Open World Hint: ❌
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: