Skip to content

fix: Remove link and other cleanup in Application Integration Tools section #730

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Oct 6, 2025
+94 −115
Merged

fix: Remove link and other cleanup in Application Integration Tools section #730

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c821bbd
fix: Remove link and other cleanup for Application Integration Tools …
koverholt Oct 1, 2025
04100e2
Formatting
koverholt Oct 1, 2025
86e2b4b
Merge branch 'main' into app-integration-tools-cleanup
koverholt Oct 1, 2025
912b217
Rework video link and add embed
koverholt Oct 1, 2025
4c58f24
Merge branch 'main' into app-integration-tools-cleanup
koverholt Oct 1, 2025
8634c1e
Merge branch 'main' into app-integration-tools-cleanup
joefernandez Oct 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
209 changes: 94 additions & 115 deletions docs/tools/google-cloud-tools.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,126 +136,105 @@ you only need to follow a subset of these steps.

## Application Integration Tools

With **ApplicationIntegrationToolset**, you can seamlessly give your agents secure and governed access to enterprise applications using Integration Connectors' 100+ pre-built connectors for systems like Salesforce, ServiceNow, JIRA, SAP, and more.
With **ApplicationIntegrationToolset**, you can seamlessly give your agents
secure and governed access to enterprise applications using Integration
Connectors' 100+ pre-built connectors for systems like Salesforce, ServiceNow,
JIRA, SAP, and more.

It supports both on-premise and SaaS applications. In addition, you can turn your existing Application Integration process automations into agentic workflows by providing application integration workflows as tools to your ADK agents.
It supports both on-premise and SaaS applications. In addition, you can turn
your existing Application Integration process automations into agentic workflows
by providing application integration workflows as tools to your ADK agents.

Federated search within Application Integration lets you use ADK agents to query multiple enterprise applications and data sources simultaneously.
Federated search within Application Integration lets you use ADK agents to query
multiple enterprise applications and data sources simultaneously.

[:fontawesome-brands-youtube:{.youtube-red-icon} Watch "Federated Search in Application Integration"!](https://www.youtube.com/watch?v=JdlWOQe5RgU&t=1s target="_blank" rel="noopener noreferrer")
[:fontawesome-brands-youtube:{.youtube-red-icon} See how ADK Federated Search in Application Integration works in this video walkthrough](https://www.youtube.com/watch?v=JdlWOQe5RgU){: target="_blank" rel="noopener noreferrer"}

<iframe width="560" height="315" src="https://www.youtube.com/embed/JdlWOQe5RgU?si=bFY_-jJ6Oliy5UMG" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>

### Prerequisites


#### 1. Install ADK

=== "Python"

Install the latest version of [ADK](../get-started/installation.md). For information about the latest version of ADK, see [Agent Development Kit Walkthrough](https://docs.google.com/document/d/1oqXkqX9m5wjWE-rkwp-qO0CGpSEQHBTYAYQcWRf91XU/edit?tab=t.0#heading=h.7k9wrm8jpdug).

=== "Java"

Install the latest version of [ADK](../get-started/installation.md). For information about the latest version of ADK, see [Agent Development Kit Walkthrough](https://docs.google.com/document/d/1oqXkqX9m5wjWE-rkwp-qO0CGpSEQHBTYAYQcWRf91XU/edit?tab=t.0#heading=h.7k9wrm8jpdug).

Install Agent Development Kit following the steps in the
[installation guide](../get-started/installation.md).

#### 2. Install CLI

=== "Python"
Install the
[Google Cloud CLI](https://cloud.google.com/sdk/docs/install#installation_instructions).
To use the tool with default credentials, run the following commands:

Install [Google Cloud CLI](https://cloud.google.com/sdk/docs/install#installation_instructions). To use the tool with default credentials, run the following commands:

```shell
gcloud config set project <project-id>
gcloud auth application-default login
gcloud auth application-default set-quota-project <project-id>
```

Replace `<project-id>` with the unique ID of your Google Cloud project.

=== "Java"

Install [Google Cloud CLI](https://cloud.google.com/sdk/docs/install#installation_instructions). To use the tool with default credentials, run the following commands:

```bash
gcloud config set project <project-id>
gcloud auth application-default login
gcloud auth application-default set-quota-project <project-id>
```

Replace `<project-id>` with the unique ID of your Google Cloud project.
```shell
gcloud config set project <project-id>
gcloud auth application-default login
gcloud auth application-default set-quota-project <project-id>
```

Replace `<project-id>` with the unique ID of your Google Cloud project.

#### 3. Provision Application Integration workflow and publish Connection Tool

=== "Python"

Use an existing [Application Integration](https://cloud.google.com/application-integration/docs/overview) workflow or [Integrations Connector](https://cloud.google.com/integration-connectors/docs/overview) connection you want to use with your agent. You can also create a new [Application Integration workflow](https://cloud.google.com/application-integration/docs/setup-application-integration) or a [connection](https://cloud.google.com/integration-connectors/docs/connectors/neo4j/configure#configure-the-connector).

Import and publish the [Connection Tool](https://console.cloud.google.com/integrations/templates/connection-tool/locations/global) from the template library.

**Note**: To use a connector from Integration Connectors, you need to provision Application Integration in the same region as your connection.
Use an existing
[Application Integration](https://cloud.google.com/application-integration/docs/overview)
workflow or
[Integrations Connector](https://cloud.google.com/integration-connectors/docs/overview)
connection you want to use with your agent. You can also create a new
[Application Integration workflow](https://cloud.google.com/application-integration/docs/setup-application-integration)
or a
[connection](https://cloud.google.com/integration-connectors/docs/connectors/neo4j/configure#configure-the-connector).

=== "Java"
Import and publish the
[Connection Tool](https://console.cloud.google.com/integrations/templates/connection-tool/locations/global)
from the template library.

Use an existing [Application Integration](https://cloud.google.com/application-integration/docs/overview) workflow or [Integrations Connector](https://cloud.google.com/integration-connectors/docs/overview) connection you want to use with your agent. You can also create a new [Application Integration workflow](https://cloud.google.com/application-integration/docs/setup-application-integration) or a [connection](https://cloud.google.com/integration-connectors/docs/connectors/neo4j/configure#configure-the-connector).

Import and publish the [Connection Tool](https://console.cloud.google.com/integrations/templates/connection-tool/locations/global) from the template library.

**Note**: To use a connector from Integration Connectors, you need to provision Application Integration in the same region as your connection, import and publish Connection Tool from the template library.
**Note**: To use a connector from Integration Connectors, you need to provision
the Application Integration in the same region as your connection.

#### 4. Create project structure

=== "Python"

Set up your project structure and create required files.
Set up your project structure and create the required files:

```console
project_root_folder
|-- .env
`-- my_agent
|-- __init__.py
|-- agent.py
`__ tools.py
├── .env
└── my_agent
├── __init__.py
├── agent.py
└── tools.py
```
When running the agent, make sure to run `adk web` in the `project\_root_folder`.

When running the agent, make sure to run `adk web` from the `project_root_folder`.

=== "Java"

Set up your project structure and create required files.

```console
project_root_folder
|-- my_agent
| |-- agent.java
| `-- pom.xml
```

When running the agent, make sure to run the commands in the `project\_root_folder`.
Set up your project structure and create the required files:

#### 5. Set roles and permissions
```console
project_root_folder
└── my_agent
├── agent.java
└── pom.xml
```

=== "Python"
When running the agent, make sure to run the commands from the `project_root_folder`.

To get the permissions that you need to set up **ApplicationIntegrationToolset**, you must have the following IAM roles on the project (common to both Integration Connectors and Application Integration Workflows):

- `roles/integrations.integrationEditor`
- `roles/connectors.invoker`
- `roles/secretmanager.secretAccessor`

**Note:** For Agent Engine (AE), don't use `roles/integrations.integrationInvoker`, as it can result in 403 errors. Use `roles/integrations.integrationEditor` instead.
#### 5. Set roles and permissions

=== "Java"
To get the permissions that you need to set up
**ApplicationIntegrationToolset**, you must have the following IAM roles on the
project (common to both Integration Connectors and Application Integration
Workflows):

To get the permissions that you need to set up **ApplicationIntegrationToolset**, you must have the following IAM roles on the project (common to both Integration Connectors and Application Integration Workflows):

- `roles/integrations.integrationEditor`
- `roles/connectors.invoker`
- `roles/secretmanager.secretAccessor`
- roles/integrations.integrationEditor
- roles/connectors.invoker
- roles/secretmanager.secretAccessor

**Note:** For Agent Engine (AE), don't use `roles/integrations.integrationInvoker`, as it can result in 403 errors. Use `roles/integrations.integrationEditor` instead.

**Note:** When using Agent Engine (AE) for deployment, don't use
`roles/integrations.integrationInvoker`, as it can result in 403 errors. Use
`roles/integrations.integrationEditor` instead.

### Use Integration Connectors

Expand All @@ -270,8 +249,8 @@ Connect your agent to enterprise applications using
Application Integration in the same region as your connection.

![Google Cloud Tools](../assets/application-integration-overview.png)



2. Go to the [Connection Tool](https://console.cloud.google.com/integrations/templates/connection-tool/locations/us-central1)
template in the template library and click **USE TEMPLATE**.
Expand All @@ -286,11 +265,11 @@ Connect your agent to enterprise applications using


![Google Cloud Tools](../assets/publish-integration.png)


#### Create an Application Integration Toolset

To create an Application Integration Toolset for Integration Connectors, follow these steps:
To create an Application Integration Toolset for Integration Connectors, follow these steps:

1. Create a tool with `ApplicationIntegrationToolset` in the `tools.py` file:

Expand Down Expand Up @@ -404,12 +383,12 @@ Use an existing
workflow as a tool for your agent or create a new one.


#### 1. Create a tool
#### 1. Create a tool

=== "Python"

To create a tool with `ApplicationIntegrationToolset` in the `tools.py` file, use the following code:

```py
integration_tool = ApplicationIntegrationToolset(
project="test-project", # TODO: replace with GCP project of the connection
Expand All @@ -421,23 +400,23 @@ workflow as a tool for your agent or create a new one.
tool_instructions="..."
)
```
**Note:** You can provide a service account to be used instead of using default credentials. To do this, generate a [Service Account Key](https://cloud.google.com/iam/docs/keys-create-delete#creating) and provide the correct

**Note:** You can provide a service account to be used instead of using default credentials. To do this, generate a [Service Account Key](https://cloud.google.com/iam/docs/keys-create-delete#creating) and provide the correct
[Application Integration and Integration Connector IAM roles](#prerequisites) to the service account. For more details about the IAM roles, refer to the [Prerequisites](#prerequisites) section.

=== "Java"

To create a tool with `ApplicationIntegrationToolset` in the `tools.java` file, use the following code:
```java

```java
import com.google.adk.tools.applicationintegrationtoolset.ApplicationIntegrationToolset;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;

public class Tools {
private static ApplicationIntegrationToolset integrationTool;
private static ApplicationIntegrationToolset connectionsTool;

static {
integrationTool = new ApplicationIntegrationToolset(
"test-project",
Expand All @@ -450,7 +429,7 @@ workflow as a tool for your agent or create a new one.
"{...}",
"tool_prefix1",
"...");

connectionsTool = new ApplicationIntegrationToolset(
"test-project",
"us-central1",
Expand All @@ -465,19 +444,19 @@ workflow as a tool for your agent or create a new one.
}
}
```

**Note:** You can provide a service account to be used instead of using default credentials. To do this, generate a [Service Account Key](https://cloud.google.com/iam/docs/keys-create-delete#creating) and provide the correct [Application Integration and Integration Connector IAM roles](#prerequisites) to the service account. For more details about the IAM roles, refer to the [Prerequisites](#prerequisites) section.

#### 2. Add the tool to your agent

=== "Python"

To update the `agent.py` file and add the tool to your agent, use the following code:

```py
from google.adk.agents.llm_agent import LlmAgent
from .tools import integration_tool, connector_tool

root_agent = LlmAgent(
model='gemini-2.0-flash',
name='integration_agent',
Expand All @@ -494,15 +473,15 @@ workflow as a tool for your agent or create a new one.
import com.google.adk.agent.LlmAgent;
import com.google.adk.tools.BaseTool;
import com.google.common.collect.ImmutableList;

public class MyAgent {
public static void main(String[] args) {
// Assuming Tools class is defined as in the previous step
ImmutableList<BaseTool> tools = ImmutableList.<BaseTool>builder()
.add(Tools.integrationTool)
.add(Tools.connectionsTool)
.build();

// Finally, create your agent with the tools generated automatically.
LlmAgent rootAgent = LlmAgent.builder()
.name("science-teacher")
Expand All @@ -513,22 +492,22 @@ workflow as a tool for your agent or create a new one.
)
.tools(tools)
.build();

// You can now use rootAgent to interact with the LLM
// For example, you can start a conversation with the agent.
}
}
```
**Note:** To find the list of supported entities and actions for a
connection, use these Connector APIs: `listActions`, `listEntityTypes`.

**Note:** To find the list of supported entities and actions for a
connection, use these Connector APIs: `listActions`, `listEntityTypes`.

#### 3. Expose your agent

=== "Python"

To configure `__init__.py` to expose your agent, use the following code:

```py
from . import agent
```
Expand All @@ -538,28 +517,28 @@ workflow as a tool for your agent or create a new one.
=== "Python"

To start the Google ADK Web UI and use your agent, use the following commands:

```shell
# make sure to run `adk web` from your project_root_folder
adk web
```
After completing the above steps, go to [http://localhost:8000](http://localhost:8000), and choose the `my_agent` agent (which is the same as the agent folder name).

=== "Java"

To start the Google ADK Web UI and use your agent, use the following commands:

```bash
mvn install

mvn exec:java \
-Dexec.mainClass="com.google.adk.web.AdkWebServer" \
-Dexec.args="--adk.agents.source-dir=src/main/java" \
-Dexec.classpathScope="compile"
```

After completing the above steps, go to [http://localhost:8000](http://localhost:8000), and choose the `my_agent` agent (which is the same as the agent folder name).

---

## Toolbox Tools for Databases
Expand Down