aljaz/goose
1
0
Fork 0
mirror of https://github.com/aljazceru/goose.git synced 2025-12-18 06:34:26 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: Add tool shim to experimental features (#1866)

Browse Source
This commit is contained in:
Adewale Abati
2025-03-26 15:46:43 +01:00
committed by GitHub
parent 9254f2251f
commit fb35d875b4
1 changed files with 42 additions and 45 deletions
Download Patch File Download Diff File Expand all files Collapse all files

87
documentation/docs/guides/experimental-features.md
View File

@@ -2,58 +2,55 @@
Goose is an open source project that is constantly being improved, and new features are added regularly. Some of these features are considered experimental, meaning they are still in development and may not be fully stable or ready for production use. This guide covers how to enable and use experimental features in Goose, as well as how to provide feedback on them.
:::note
Experimental features are new capabilities that are still being tested and refined. While they can provide additional functionality, they may be less stable than standard features.
:::
## Enabling Experimental Features
To access experimental features, run:
```sh
goose configure
```
Select "Goose Settings" from the menu:
```sh
┌ goose-configure
│
◆ What would you like to configure?
| ○ Configure Providers
| ○ Add Extension
| ○ Toggle Extensions
| ○ Remove Extension
// highlight-next-line
| ● Goose Settings (Set the Goose Mode, Tool Output, Experiment and more)
└
```
Then select "Toggle Experiment" option in the menu:
```sh
┌ goose-configure
│
◇ What would you like to configure?
│ Goose Settings
│
◆ What setting would you like to configure?
│ ○ Goose Mode
│ ○ Tool Output
// highlight-next-line
│ ● Toggle Experiment (Enable or disable an experiment feature)
└
```
## Available Experimental Features
:::note
There are no experimental features at this time!
:::
:::note
The list of experimental features may change as Goose development progresses. Some features may be promoted to stable features, while others might be modified or removed.This section will be updated with specific experimental features as they become available
:::
### Ollama Tool Shim
The Ollama tool shim is an experimental feature that enables tool calling capabilities for language models that don't natively support tool calling (like DeepSeek). It works by instructing the primary model to output json for intended tool usage, the interpretive model uses ollama structured outputs to translate the primary model's message into valid json, and then that json is translated into valid tool calls to be invoked.
#### How to use the Ollama Tool Shim
1. Make sure you have [Ollama](https://ollama.com/download) installed and running
2. The default interpreter model is `mistral-nemo`, if you want to proceed with this, you have to pull it from ollama server by running:
```bash
ollama pull mistral-nemo
```
3. If you want to use a different model, make sure to pull it first from the Ollama server. Then override the default interpreter model using the `GOOSE_TOOLSHIM_OLLAMA_MODEL` environment variable. For example, to use the `llama3.2` model, run:
```bash
ollama pull llama3.2
```
Then,
```bash
GOOSE_TOOLSHIM_OLLAMA_MODEL=llama3.2
```
4. For optimal performance, run the Ollama server with an increased context length:
```bash
OLLAMA_CONTEXT_LENGTH=32768 ollama serve
```
5. Enable the tool shim by setting the `GOOSE_TOOLSHIM` environment variable:
```bash
GOOSE_TOOLSHIM=1
```
Start a new Goose session with your tool shim preferences:
```bash
GOOSE_TOOLSHIM=1 GOOSE_TOOLSHIM_OLLAMA_MODEL=llama3.2 cargo run --bin goose session
```
## Feedback
If you encounter any issues with these features, check if the issue is already reported in the [GitHub issues](https://github.com/goose/goose/issues) or join the [Discord community](https://discord.gg/block-opensource) to share.