You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: DEVELOPER.md
+9-26Lines changed: 9 additions & 26 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
# DEVELOPER.md
2
2
3
3
This document provides instructions for setting up your development environment
4
-
and contributing to the Knowledge Catalog (formerly known as Dataplex) Gemini CLI Extension project.
4
+
and contributing to the Knowledge Catalog (formerly known as Dataplex) Agent skills project.
5
5
6
6
## Prerequisites
7
7
@@ -16,39 +16,23 @@ Before you begin, ensure you have the following:
16
16
17
17
### Running from Local Source
18
18
19
-
The core logic for this extension is handled by a pre-built `toolbox` binary. The development process involves installing the extension locally into the Gemini CLI to test changes.
Copy file name to clipboardExpand all lines: KNOWLEDGE_CATALOG.md
+21-7Lines changed: 21 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,11 +8,11 @@ Your primary objective is to help discover, organize and manage metadata related
8
8
9
9
To install this extension, the Gemini CLI version must be v0.6.0 or above. The version can be found by running: `gemini --version`.
10
10
11
-
## Knowledge Catalog(formerly known as Dataplex) MCP Server (Data Plane: Connecting and Querying)
11
+
## Knowledge Catalog(formerly known as Dataplex) Agent Skills (Data Plane: Connecting and Querying)
12
12
13
13
This section covers connecting to a Knowledge Catalog instance.
14
14
15
-
1.**Verify Environment Variables**: The extension requires the following environment variables to be set before the Gemini CLI is started:
15
+
1.**Verify Environment Variables**: The extension requires the following environment variables to be set before the agent is started:
16
16
17
17
*`DATAPLEX_PROJECT`: The GCP project ID.
18
18
@@ -24,6 +24,20 @@ This section covers connecting to a Knowledge Catalog instance.
24
24
25
25
---
26
26
27
+
# Usage Guidelines
28
+
29
+
## Reusing Project Values
30
+
31
+
Users may have set project environment variables:
32
+
33
+
*`DATAPLEX_PROJECT`: The GCP project ID.
34
+
35
+
Instead of prompting the user for these values for specific skill calls, prompt the user to verify the reuse of a specific setting value.
36
+
Make sure to not use the environment variable name like `DATAPLEX_PROJECT`, `${DATAPLEX_PROJECT}`, or `$DATAPLEX_PROJECT`.
37
+
The value can be verified by the user using the `gemini extensions config knowledge-catalog` command or by checking their local settings.
38
+
39
+
---
40
+
27
41
# Data Model
28
42
29
43
## Entries
@@ -145,9 +159,9 @@ Entries are organized within Entry Groups, which are logical groupings of Entrie
145
159
146
160
Entries can be linked together using EntryLinks to represent relationships between data assets (e.g. foreign keys).
147
161
148
-
# Tool instructions
162
+
# Skill instructions
149
163
150
-
## Tool: search_entries
164
+
## Skill: search_entries
151
165
152
166
## General
153
167
@@ -341,12 +355,12 @@ This abbreviated syntax works for the qualified predicates except for `label` in
341
355
1. Explain that no search result was found
342
356
2. Suggest to provide a more specific search query.
343
357
344
-
## Tool: lookup_entry
358
+
## Skill: lookup_entry
345
359
346
360
### Request
347
361
348
-
1. Always try to limit the size of the response by specifying `aspect_types` parameter. Make sure to include to select view=CUSTOM when using aspect_types parameter. If you do not know the name of the aspect type, use the `search_aspect_types` tool.
349
-
2. If you do not know the name of the entry, use `search_entries` tool
362
+
1. Always try to limit the size of the response by specifying `aspect_types` parameter. Make sure to include to select view=CUSTOM when using aspect_types parameter. If you do not know the name of the aspect type, use the `search_aspect_types` skill.
363
+
2. If you do not know the name of the entry, use `search_entries` skill
0 commit comments