Skip to content

Commit 7b21eb5

Browse files
committed
Explain how to use goose with cavil
1 parent 2701375 commit 7b21eb5

File tree

1 file changed

+72
-1
lines changed

1 file changed

+72
-1
lines changed

docs/UserAPI.md

Lines changed: 72 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ Once you have installed and set up [gemini-cli](https://github.com/google-gemini
7171
mcp command to add Cavil:
7272

7373
```
74-
gemini mcp add cavil https://legaldb.suse.de/mcp -H 'Authorization: Bearer generated_api_key_here' -t http
74+
$ gemini mcp add cavil https://legaldb.suse.de/mcp -H 'Authorization: Bearer generated_api_key_here' -t http
7575
```
7676

7777
After restarting gemini-cli, it will automatically discover available Cavil tools and make use of them on its own:
@@ -150,6 +150,77 @@ statements, but it references recognized open source and documentation licenses
150150
compliance barriers are present.
151151
```
152152

153+
#### goose
154+
155+
Once you have installed and set up [goose](https://github.com/block/goose) for use with your preferred model, you can
156+
add Cavil with the `goose configure` command:
157+
158+
```
159+
$ goose configure
160+
161+
This will update your existing config files
162+
if you prefer, you can edit them directly at /home/user/.config/goose
163+
164+
┌ goose-configure
165+
166+
◇ What would you like to configure?
167+
│ Add Extension
168+
169+
◇ What type of extension would you like to add?
170+
│ Remote Extension (Streamable HTTP)
171+
172+
◇ What would you like to call this extension?
173+
│ cavil
174+
175+
◇ What is the Streaming HTTP endpoint URI?
176+
│ https://legaldb.suse.de/mcp
177+
178+
◇ Please set the timeout for this tool (in secs):
179+
│ 300
180+
181+
◇ Enter a description for this extension:
182+
│ Cavil
183+
184+
◇ Would you like to add custom headers?
185+
│ Yes
186+
187+
◇ Header name:
188+
│ Authorization
189+
190+
◇ Header value:
191+
│ Bearer generated_api_key_here
192+
193+
◇ Add another header?
194+
│ No
195+
196+
└ Added cavil extension
197+
└ Configuration saved successfully to /home/user/.config/goose/config.yaml
198+
```
199+
200+
After restarting goose, it will automatically discover available Cavil tools and make use of them on its own:
201+
202+
```
203+
( O)> You are a legal reviewer for SUSE Linux Enterprise. Take a look at report 476346 and make a
204+
recommendation if that package update should be accepted for distribution to customers. Don't be too
205+
critical of legal risks classified as low by the license scanner. Only give a short summary with the
206+
reason for your decision.
207+
208+
─── cavil_get_report | cavil ──────────────────────────
209+
package_id: 476346
210+
211+
### Recommendation: Accept for Distribution
212+
213+
**Summary:**
214+
The legal report for the update to `perl-Mojolicious` (version 9.420.0) indicates only low risks according
215+
to the license scanner. All detected licenses (Artistic-2.0, BSD-3-Clause, MIT, OFL-1.1, and CC-BY-SA-4.0)
216+
are compatible with SUSE’s distribution policies. Unmatched license keyword snippets also reference
217+
well-known open-source licenses without red flags. There are no significant unresolved legal issues.
218+
219+
**Reason:**
220+
All risk findings are classified as low or minor. No action is required beyond the routine, and the update
221+
should be approved for release to customers.
222+
```
223+
153224
## REST API
154225

155226
### Compression

0 commit comments

Comments
 (0)