docs: add tool shim guide covering when to enable, backends, and troubleshooting - #10858
Merged
Merged
Conversation
Abhijay007
requested review from
DOsinga,
The-Best-Codes,
alexhancock,
angiejones and
michaelneale
July 31, 2026 18:20
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 2dc4b3ec19
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: b853abb664
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
| ollama pull mistral-nemo | ||
|
|
||
| # Optional: use a different interpreter model | ||
| export GOOSE_TOOLSHIM_OLLAMA_MODEL=llama3.2 |
There was a problem hiding this comment.
When a user follows the optional override on a fresh Ollama setup, this guide only pulled mistral-nemo but then points goose at llama3.2. The tool shim sends the interpreter request to exactly GOOSE_TOOLSHIM_OLLAMA_MODEL, so the session will fail with a missing-model Ollama error unless the user separately knows to run ollama pull llama3.2; add that pull step next to the override.
Useful? React with 👍 / 👎.
Abhijay007
force-pushed
the
docs/tool-shim-guide
branch
from
July 31, 2026 18:32
b853abb to
a7fd838
Compare
The-Best-Codes
approved these changes
Aug 3, 2026
michaelneale
removed their request for review
August 10, 2026 04:17
lifeizhou-ap
added a commit
to vincenzopalazzo/goose
that referenced
this pull request
Aug 10, 2026
* main: docs: add tool shim guide covering when to enable, backends, and troubleshooting (aaif-goose#10858) fix(deep-link): route extension/session deep links to regular windows not standalone app windows (aaif-goose#10908) fix(ui): raise chat input z-index so slash menu appears above loading indicator (aaif-goose#11015) fix(ui): support remote working directory for external backend (aaif-goose#10827) fix(acp): resume provider-native sessions (aaif-goose#10379) fix (UI): Fix Form/JSON toggle buttons invisible in dark mode on Deeplink Generator (aaif-goose#11077) fix(streaming): skip metadata-only SSE frames instead of failing the turn (aaif-goose#10942) fix(telegram): send responses as rich markdown (aaif-goose#11062) fix(acp): send session setup updates after new and fork session responses (aaif-goose#11018) fix(ui): remove duplicated brace-expansion keys that break every pnpm install (aaif-goose#11071)
michaelneale
added a commit
that referenced
this pull request
Aug 10, 2026
* origin/main: fix(conversation): sanitize nested tool responses (#10609) fix(hints): bound recursive file expansion (#10546) fix(providers): drop stale signed thinking blocks after a mid-conversation model switch (#10007) fix(desktop): clarify compact cost display (#11093) Index messages by (session_id, created_timestamp, id) to stop on-disk sort storms (#10874) docs: add tool shim guide covering when to enable, backends, and troubleshooting (#10858) fix(deep-link): route extension/session deep links to regular windows not standalone app windows (#10908) fix(ui): raise chat input z-index so slash menu appears above loading indicator (#11015) fix(ui): support remote working directory for external backend (#10827)
michaelneale
added a commit
that referenced
this pull request
Aug 10, 2026
* origin/main: fix(mcp): prune dead notification subscribers (#11032) chore: remove the extension and tool count suggestion (#10869) feat: compaction in the GDK (#11042) fix(provider): retry transient errors on first stream item before ending turn (#10968) feat(cli): add /new to start a fresh session without restarting (#10767) feat(acp): title new sessions from _meta.sessionTitle (#10712) fix: adjust rmcp::model::Meta ref (#11107) Skip hook loading and lifecycle events for subagents (#10596) Sanitize Unicode tags in Responses output (#10745) fix(conversation): sanitize nested tool responses (#10609) fix(hints): bound recursive file expansion (#10546) fix(providers): drop stale signed thinking blocks after a mid-conversation model switch (#10007) fix(desktop): clarify compact cost display (#11093) Index messages by (session_id, created_timestamp, id) to stop on-disk sort storms (#10874) docs: add tool shim guide covering when to enable, backends, and troubleshooting (#10858) fix(deep-link): route extension/session deep links to regular windows not standalone app windows (#10908) fix(ui): raise chat input z-index so slash menu appears above loading indicator (#11015) fix(ui): support remote working directory for external backend (#10827)
lifeizhou-ap
added a commit
that referenced
this pull request
Aug 11, 2026
* main: fix(mcp): prune dead notification subscribers (#11032) chore: remove the extension and tool count suggestion (#10869) feat: compaction in the GDK (#11042) fix(provider): retry transient errors on first stream item before ending turn (#10968) feat(cli): add /new to start a fresh session without restarting (#10767) feat(acp): title new sessions from _meta.sessionTitle (#10712) fix: adjust rmcp::model::Meta ref (#11107) Skip hook loading and lifecycle events for subagents (#10596) Sanitize Unicode tags in Responses output (#10745) fix(conversation): sanitize nested tool responses (#10609) fix(hints): bound recursive file expansion (#10546) fix(providers): drop stale signed thinking blocks after a mid-conversation model switch (#10007) fix(desktop): clarify compact cost display (#11093) Index messages by (session_id, created_timestamp, id) to stop on-disk sort storms (#10874) docs: add tool shim guide covering when to enable, backends, and troubleshooting (#10858) fix(deep-link): route extension/session deep links to regular windows not standalone app windows (#10908) fix(ui): raise chat input z-index so slash menu appears above loading indicator (#11015) fix(ui): support remote working directory for external backend (#10827)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes : #8269
Summary
Wrote a user-focused tool shim guide at docs/guides/tool-shim.md, This covers when to enable (symptom-first), Ollama/local/custom provider setup with tabs, full env var table (
GOOSE_TOOLSHIM,GOOSE_TOOLSHIM_BACKEND,GOOSE_TOOLSHIM_OLLAMA_MODEL,GOOSE_TOOLSHIM_MODEL), and troubleshooting. Updated experimental/ollama.md to a quick-start stub linking to the new guide, and added the two missing vars to environment-variables.mdTesting
manual