Skip to content

Commit 40ad689

Browse files
authored
Merge branch 'main' into version
2 parents 06d1f42 + 6a4f8ed commit 40ad689

2 files changed

Lines changed: 56 additions & 19 deletions

File tree

README.md

Lines changed: 53 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,17 @@ This plugin provides a specialized suite of skills and MCP tools for data engine
99
> **We Want Your Feedback!**
1010
> Please share your thoughts with us by opening an issue on GitHub. Your input is invaluable and helps us improve the project for everyone.
1111
12+
## Contents
13+
14+
- [Why Use the Data Agent Kit Starter Pack?](#why-use-the-data-agent-kit-starter-pack)
15+
- [Prerequisites](#prerequisites)
16+
- [Getting Started](#getting-started)
17+
- [Installation](#installation)
18+
- [Configuration](#configuration)
19+
- [Usage Examples](#usage-examples)
20+
- [Troubleshooting](#troubleshooting)
21+
- [Security Reminder: Agent Environment Hardening](#security-reminder-agent-environment-hardening)
22+
1223
## Why Use the Data Agent Kit Starter Pack?
1324

1425
* **Seamless Workflow:** Bring Google Cloud data engineering expertise directly into your terminal or IDE via Gemini CLI, Claude Code, or Codex.
@@ -20,9 +31,10 @@ This plugin provides a specialized suite of skills and MCP tools for data engine
2031

2132
Ensure you have the following installed:
2233
* **Node.js and npm** (Latest version recommended)
34+
* **Google Cloud SDK (gcloud CLI):** [Install and initialize](https://cloud.google.com/sdk/docs/install) the gcloud CLI and ensure [Application Default Credentials (ADC)](https://cloud.google.com/docs/authentication/provide-credentials-adc) are configured.
2335
* One of the following coding agents:
2436
* [Gemini CLI](https://github.com/google-gemini/gemini-cli) (v0.6.0+)
25-
* [Claude Code](https://docs.anthropic.com/en/docs/agents-and-tools/claude-code/overview)
37+
* [Claude Code](https://code.claude.com/docs)
2638
* Codex CLI
2739
* **(Optional) IDE Extension:** [Google Cloud Data Agent Kit](https://docs.cloud.google.com/data-cloud-extension/vs-code/install).
2840

@@ -35,26 +47,32 @@ Choose the installation method for your preferred coding agent. Run the commands
3547
<details>
3648
<summary><b>Gemini CLI and Gemini Code Assist</b></summary>
3749

50+
Install the extension directly from GitHub:
3851
```bash
39-
gemini extensions install https://github.com/gemini-cli-extensions/data-agent-kit-starter-pack
52+
gemini extensions install https://github.com/gemini-cli-extensions/data-agent-kit-starter-pack --consent
4053
```
4154
</details>
4255

4356
<details>
4457
<summary><b>Claude Code</b></summary>
4558

46-
Run the `claude` command to start the agent, then run:
59+
Run the `claude` command to start the agent, then follow these steps:
4760

61+
1. **Add the marketplace:**
4862
```bash
4963
/plugin marketplace add https://github.com/gemini-cli-extensions/data-agent-kit-starter-pack
64+
```
65+
66+
2. **Install the plugin:**
67+
```bash
5068
/plugin install data-agent-kit-starter-pack@data-agent-kit-starter-pack-marketplace
5169
```
5270
</details>
5371

5472
<details>
5573
<summary><b>Codex</b></summary>
5674

57-
Run the following commands in your terminal:
75+
1. **Run the installation script in your terminal:**
5876

5977
**macOS / Linux:**
6078
```bash
@@ -66,20 +84,35 @@ curl -sSL https://raw.githubusercontent.com/gemini-cli-extensions/data-agent-kit
6684
irm https://raw.githubusercontent.com/gemini-cli-extensions/data-agent-kit-starter-pack/main/codex-install.ps1 | iex
6785
```
6886

69-
After running the installation script, run the `codex` command to start the agent, then run:
87+
2. **Install the plugin in Codex:**
7088

89+
Start the Codex agent (`codex`), then run:
7190
```bash
7291
/plugins
7392
```
74-
75-
Use the interactive options to install the extension with the name `Data Agent Kit Starter Pack`.
93+
Use the interactive options to install the plugin with the name `Data Agent Kit Starter Pack`.
7694
</details>
7795

7896
### Configuration
7997

80-
MCP toolboxes are added to the respective agent configuration files. You must configure the MCP toolboxes in your agent's configuration files for them to start successfully.
98+
This extension brings a suite of specialized **Skills** and **MCP toolboxes**. While skills are ready to use upon installation, you **must** configure the MCP toolboxes and authenticate with Google Cloud for them to start successfully.
8199

82-
In all cases, you must restart the agent after updating the configuration files.
100+
> [!NOTE]
101+
> If you use Gemini CLI, Claude Code, or Codex in your IDE (e.g., via VS Code extensions), they share the same underlying configuration and MCP servers as the CLI agents.
102+
103+
#### 1. Authenticate with Google Cloud
104+
The MCP toolboxes require an active authenticated session to interact with your resources. Run the following commands in your terminal:
105+
```bash
106+
gcloud auth login
107+
gcloud auth application-default login
108+
```
109+
110+
#### 2. Update Agent Configuration
111+
You must configure the MCP toolboxes in your agent's configuration files for them to start successfully. After updating, you must restart the agent.
112+
113+
To verify your configuration:
114+
* Run the `/mcp` command to check the status of available MCP servers.
115+
* Ask your agent "What skills are available?" to view the list of active skills.
83116

84117
<details>
85118
<summary><b>Gemini CLI and Gemini Code Assist</b></summary>
@@ -91,11 +124,8 @@ Edit the configuration file:
91124
<details>
92125
<summary><b>Claude Code</b></summary>
93126

94-
1. Edit the configuration file:
127+
Edit the configuration file:
95128
`~/.claude/plugins/cache/data-agent-kit-starter-pack-marketplace/data-agent-kit-starter-pack/<version>/.mcp.json`
96-
97-
2. Reinstall the plugin:
98-
Run `/plugin` and use interactive options to uninstall `data-agent-kit-starter-pack`. Then run `/plugin install` to add it back.
99129
</details>
100130

101131
<details>
@@ -104,11 +134,10 @@ Run `/plugin` and use interactive options to uninstall `data-agent-kit-starter-p
104134
1. Edit the configuration file:
105135
`~/.agents/plugins/data-agent-kit-starter-pack/.mcp.json`
106136

107-
2. Use interactive options to uninstall and install the extension:
137+
2. Use the interactive options to uninstall and install the plugin with the name `Data Agent Kit Starter Pack`:
108138
```bash
109139
/plugins
110140
```
111-
Install with name: `Data Agent Kit Starter Pack`
112141
</details>
113142

114143
## Usage Examples
@@ -131,9 +160,17 @@ Interact with your coding agent using natural language prompts to perform comple
131160

132161
## Troubleshooting
133162

163+
Use `gemini --debug` to enable debugging.
164+
165+
Common issues:
166+
134167
* **Plugin Not Found:** Ensure you have restarted your agent (e.g., Gemini CLI or Codex) after installation.
135-
* **Authentication Errors:** Many GCP skills require an active authenticated session. Ensure you have run `gcloud auth login` and `gcloud auth application-default login` on your machine.
168+
* **Authentication Errors:** Many GCP skills require an active authenticated session. Ensure you have run `gcloud auth login` and `gcloud auth application-default login` on your machine. See [Set up Application Default Credentials](https://cloud.google.com/docs/authentication/provide-credentials-adc) for more information.
169+
* **"failed to find default credentials: google: could not find default credentials."**: Ensure Application Default Credentials (ADC) are available in your environment.
136170
* **MCP Connection Issues:** Update the MCP server configurations such as project, region etc. needed by MCP toolboxes in order to connect successfully to them.
171+
* **"✖ Error during discovery for server: MCP error -32000: Connection closed"**: The connection could not be established. Ensure your configuration is correctly set in the agent's configuration file.
172+
* **"✖ MCP ERROR: Error: spawn .../toolbox ENOENT"**: The Toolbox binary did not download correctly. Ensure you are using Gemini CLI v0.6.0+.
173+
* **"cannot execute binary file"**: The Toolbox binary did not download correctly. Ensure the correct binary for your OS/Architecture has been downloaded.
137174

138175
## Security Reminder: Agent Environment Hardening
139176

mcp/package-lock.json

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)