Skip to content

Commit 0e0cd28

Browse files
authored
docs: Add version information to README.md (#45)
* docs: update README with node prerequisites, codex installation and troubleshooting * docs: add version to README and update security section, add README to release-please-config * docs: update release-please markers and lychee ignore * docs: ignore broken comparison links in lychee
1 parent 317e597 commit 0e0cd28

3 files changed

Lines changed: 33 additions & 13 deletions

File tree

.lycheeignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,6 @@ https://github.com/gemini-cli-extensions/data-cloud-ai-dev-kit/compare/
22
https://github.com/gemini-cli-extensions/data-cloud-ai-dev-kit
33
https://raw.githubusercontent.com/gemini-cli-extensions/data-cloud-ai-dev-kit/main/codex-install.sh
44
https://docs.cloud.google.com/data-cloud-extension/vs-code/install
5+
https://docs.cloud.google.com/data-cloud-extension/vs-code/prompt-injection-risk
6+
https://github.com/gemini-cli-extensions/data-agent-kit-starter-pack/compare/
57
data-cloud-ai-dev-kit@data-cloud-ai-dev-kit-marketplace

README.md

Lines changed: 30 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,8 @@ Ensure you have the following installed:
4040

4141
## Getting Started
4242

43+
<!-- {x-release-please-start-version} -->
44+
4345
### Installation
4446

4547
Choose the installation method for your preferred coding agent. Run the commands in terminal
@@ -49,7 +51,7 @@ Choose the installation method for your preferred coding agent. Run the commands
4951

5052
Install the extension directly from GitHub:
5153
```bash
52-
gemini extensions install https://github.com/gemini-cli-extensions/data-agent-kit-starter-pack --consent
54+
gemini extensions install https://github.com/gemini-cli-extensions/data-agent-kit-starter-pack --ref 0.1.0
5355
```
5456
</details>
5557

@@ -60,7 +62,7 @@ Run the `claude` command to start the agent, then follow these steps:
6062

6163
1. **Add the marketplace:**
6264
```bash
63-
/plugin marketplace add https://github.com/gemini-cli-extensions/data-agent-kit-starter-pack
65+
/plugin marketplace add https://github.com/gemini-cli-extensions/data-agent-kit-starter-pack#0.1.0
6466
```
6567

6668
2. **Install the plugin:**
@@ -76,12 +78,12 @@ Run the `claude` command to start the agent, then follow these steps:
7678

7779
**macOS / Linux:**
7880
```bash
79-
curl -sSL https://raw.githubusercontent.com/gemini-cli-extensions/data-agent-kit-starter-pack/main/codex-install.sh | bash
81+
curl -sSL https://raw.githubusercontent.com/gemini-cli-extensions/data-agent-kit-starter-pack/0.1.0/codex-install.sh | bash
8082
```
8183

8284
**Windows:**
8385
```powershell
84-
irm https://raw.githubusercontent.com/gemini-cli-extensions/data-agent-kit-starter-pack/main/codex-install.ps1 | iex
86+
irm https://raw.githubusercontent.com/gemini-cli-extensions/data-agent-kit-starter-pack/0.1.0/codex-install.ps1 | iex
8587
```
8688

8789
2. **Install the plugin in Codex:**
@@ -125,7 +127,7 @@ Edit the configuration file:
125127
<summary><b>Claude Code</b></summary>
126128

127129
Edit the configuration file:
128-
`~/.claude/plugins/cache/data-agent-kit-starter-pack-marketplace/data-agent-kit-starter-pack/<version>/.mcp.json`
130+
`~/.claude/plugins/cache/data-agent-kit-starter-pack-marketplace/data-agent-kit-starter-pack/0.1.0/.mcp.json`
129131
</details>
130132

131133
<details>
@@ -140,6 +142,8 @@ Edit the configuration file:
140142
```
141143
</details>
142144

145+
<!-- {x-release-please-end} -->
146+
143147
## Usage Examples
144148

145149
Interact with your coding agent using natural language prompts to perform complex data engineering tasks:
@@ -174,11 +178,24 @@ Common issues:
174178

175179
## Security Reminder: Agent Environment Hardening
176180

177-
Your agent has the power to execute tools and commands on your behalf. Protect your GCP resources by enforcing **Strict Least Privilege** across all CLIs, MCP servers and other resources available to your agents.
178-
179-
* Use [service accounts](https://docs.cloud.google.com/docs/authentication/use-service-account-impersonation) for accessing your cloud resources.
180-
* Assign the service account a role with [limited permissions](https://docs.cloud.google.com/iam/docs/roles-overview).
181-
* Prevent unwanted cross-org agent access by utilizing **Principal Access Boundaries** to scope your agent to [projects](https://docs.cloud.google.com/iam/docs/principal-access-boundary-policies#use-case-one-project) you intend the agent to access.
182-
183-
> [!NOTE]
184-
> The Principal Access Boundary condition should bind the policy to the service accounts you intend to restrict.
181+
Your agent can execute tools and commands on your behalf. Protect your Google
182+
Cloud resources by enforcing **The Principle of Least Privilege** across all
183+
CLIs, MCP servers and other resources available to your agents.
184+
185+
* **Service Accounts:** Use
186+
[service accounts](https://docs.cloud.google.com/docs/authentication/use-service-account-impersonation)
187+
instead of end user credentials to access Google Cloud resources.
188+
* **Limited Permissions:** Assign roles with
189+
[limited permissions](https://docs.cloud.google.com/iam/docs/roles-overview)
190+
to the service account that you're using for authentication.
191+
* **Principal Access Boundaries:** Prevent unwanted cross-org agent access by
192+
using
193+
[Principal Access Boundary policies](https://docs.cloud.google.com/iam/docs/principal-access-boundary-policies#use-case-one-project)
194+
to scope your agent to projects you intend it to access.
195+
* [Include a condition in the policy binding](https://docs.cloud.google.com/iam/docs/principal-access-boundary-policies#use-case-one-project)
196+
to ensure that the policy only applies to the service accounts that you
197+
intend to restrict.
198+
199+
You can read more
200+
[here](https://docs.cloud.google.com/data-cloud-extension/vs-code/prompt-injection-risk)
201+
on how to mitigate prompt injection attacks with Google Cloud MCP.

release-please-config.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@
2828
"release-type": "simple",
2929
"package-name": "data-agent-kit-starter-pack",
3030
"extra-files": [
31+
"README.md",
3132
{
3233
"type": "json",
3334
"path": "gemini-extension.json",

0 commit comments

Comments
 (0)