Add xAI Provider Support for Grok Models #2976

jackjackbits · 2025-06-17T22:24:25Z

Add xAI Provider Support for Grok Models

Summary

This PR adds comprehensive support for xAI's Grok models to Goose, enabling users to interact with models like grok-3, grok-3-mini, and grok-3-fast through the xAI API. The implementation includes both CLI and GUI support with proper authentication, context limits, and visual branding.

Motivation

xAI's Grok models offer competitive performance with a large 131,072 token context window, making them valuable alternatives for users seeking high-capacity language models. This addition expands Goose's provider ecosystem and gives users more flexibility in choosing their preferred AI models.

Changes

Core Provider Implementation

New xAI Provider (crates/goose/src/providers/xai.rs)
- Implements the Goose provider interface for xAI API
- Proper authentication via XAI_API_KEY environment variable or config
- Configurable host with default to https://api.x.ai/v1
- Full streaming support for responses
Provider Integration
- Added xAI to provider factory (crates/goose/src/providers/factory.rs)
- Registered in provider module (crates/goose/src/providers/mod.rs)
- Added to desktop app provider registry

Model Support

Context Limits (crates/goose/src/model.rs)
- Added Grok models to MODEL_SPECIFIC_LIMITS with 131,072 token limit
- Ensures proper context window display in both CLI and GUI
Supported Models
- grok-3
- grok-3-mini
- grok-3-fast
- grok-2-vision-1212
- grok-vision
- grok-2
- grok
- grok-1.5

GUI Integration

Provider Logo
- Added custom xAI logo to provider selection modal
- Implemented CSS invert filter to handle black logo on dark background
- Adjusted logo size (w-8 h-8) to fit properly within circular container
Desktop App Support
- Full integration with Settings → Providers interface
- Seamless model selection and configuration

Documentation

Updated documentation/docs/getting-started/providers.md to include xAI
Added configuration details and API key requirements

Bug Fixes

Fixed API URL construction issue where base URL wasn't properly joined with endpoint path
Ensured trailing slash handling for proper URL formation
Fixed context limit display (was showing 0/32000, now correctly shows 0/131072)

Testing

✅ Provider authentication and API calls working
✅ Context limits display correctly in both CLI and GUI
✅ Logo displays properly with correct sizing and visibility
✅ All linting and formatting checks pass
✅ Rust compilation with no warnings

Usage

CLI

# Set API key
export XAI_API_KEY=your-api-key

# Start a session
goose session --model grok-3

GUI

Open Goose Desktop
Go to Settings → Providers
Click "Add Provider" and select xAI
Enter your API key
Select your preferred Grok model

Configuration File

# ~/.config/goose/config.yaml
XAI_API_KEY: your-api-key
provider: xai
model: grok-3

Screenshots

Notes

The xAI logo required special handling due to being black text on transparent background
CSS filter inversion and size adjustment ensure proper visibility in dark mode
API endpoint confirmed working at https://api.x.ai/v1/chat/completions

Checklist

- Added XaiProvider in crates/goose/src/providers/xai.rs with support for all Grok models - Supports grok-3, grok-3-fast, grok-3-mini, grok-3-mini-fast, grok-2-vision, grok-2-image, and legacy models - Follows x.ai OpenAI-compatible API format (https://api.x.ai/v1/chat/completions) - Requires XAI_API_KEY environment variable for authentication - Optional XAI_HOST configuration (defaults to https://api.x.ai) - Updated factory.rs to include xAI provider in the provider registry - Added xAI to the GUI provider registry in ProviderRegistry.tsx - Includes proper error handling for authentication, rate limits, and server errors - All tests pass, code formatted and lints clean

- Changed XAI_API_HOST from 'https://api.x.ai' to 'https://api.x.ai/v1' - Updated URL joining to append 'chat/completions' instead of 'v1/chat/completions' - This creates the correct endpoint: https://api.x.ai/v1/chat/completions - Updated UI provider registry with correct default host - Tested with curl and confirmed API returns proper 400 auth error instead of 404

- Added 'grok' pattern to MODEL_SPECIFIC_LIMITS with 131_072 token limit - This fixes the issue where CLI was showing 0/32000 tokens for Grok models - All Grok models (grok-3, grok-3-mini, etc) now correctly show 0/131072 tokens - Added debug logging to xAI provider for better troubleshooting

jackjackbits · 2025-06-17T22:24:34Z

Screenshot

Here's the xAI provider with the custom logo in the Settings interface:

(Uploading screenshot...)

FaresKi · 2025-06-17T22:32:35Z

looks good to me jack, i'd approve if i could 👍🏽

.goose/memory/project improvement ideas.txt

…se into jackjackbits-feature/add-grok-models * 'feature/add-grok-models' of github.com:jackjackbits/goose: Add xAI to supported providers documentation Reduce xAI logo size to fit properly within circle Fix xAI logo visibility by applying CSS invert filter for black logo Add xAI logo to GUI provider selection Fix xAI API URL construction by ensuring base URL ends with slash Add Grok model context limits (131K tokens) Fix xAI API endpoint URL Add xAI provider support for Grok models

michaelneale · 2025-06-18T02:07:06Z

updated this to main and added .gitignore, hopefully didn't mess up the history (well hopefully goose didn't!), seemed to work for me

salman1993 · 2025-06-18T02:24:58Z

it'd be good to add a test for xai provider, similar to the one here:

goose/crates/goose/tests/providers.rs

Lines 449 to 458 in d8b6e60

    
           #[tokio::test] 
        
           async fn test_anthropic_provider() -> Result<()> { 
        
               test_provider( 
        
                   "Anthropic", 
        
                   &["ANTHROPIC_API_KEY"], 
        
                   None, 
        
                   anthropic::AnthropicProvider::default, 
        
               ) 
        
               .await 
        
           }

michaelneale · 2025-06-18T03:10:08Z

also don't worry about the apparent "extra" changes (which are already on main) its a forever github bug with showing synced fork diffs (will see if can get rid of it, but they aren't actual changes as already on main upstream/origin!)

michaelneale · 2025-06-18T03:22:32Z

.. and cleaned up history again from github quirk

realtamimuddin · 2025-06-18T05:09:32Z

wow

eminogrande · 2025-06-18T14:54:29Z

Fantastic and this is all made with https://github.com/block/goose ? any tips on writing issues?

sambradbury · 2025-06-19T02:03:16Z

it'd be good to add a test for xai provider, similar to the one here:

goose/crates/goose/tests/providers.rs

Lines 449 to 458 in d8b6e60

#[tokio::test]

async fn test_anthropic_provider() -> Result<()> {

test_provider(

"Anthropic",

&["ANTHROPIC_API_KEY"],

None,

anthropic::AnthropicProvider::default,

)

.await

}

Opened a PR against the base branch to add tests https://github.com/jackjackbits/goose/pull/1/files

sambradbury · 2025-06-19T02:22:49Z

Tested these changes locally but grok-3 failed.

 ~/Documents/code/goose/ [add-xai-tests] ./target/debug/goose session 
starting session | provider: xai model: grok-3
    logging to /Users/sambradbury/.local/share/goose/sessions/20250618_212026.jsonl
    working directory: /Users/sambradbury/Documents/code/goose

Goose is running! Enter your instructions, or try asking what goose can do.

Context: ○○○○○○○○○○ 0% (0/131072 tokens)
( O)> What is the fourth word in your response to this prompt? 
I'm not sure how to predict the fourth word of my response before writing it, but let's make this fun. The fourth word in my response to your prompt is "fourth."

Just to clarify, I'm responding with this sentence, and the fourth word is indeed "fourth." If you have any other questions or need assistance, feel free to ask!
Context: ●○○○○○○○○○ 6% (7226/131072 tokens)

michaelneale · 2025-06-19T02:29:54Z

@sambradbury that looked like it worked though?

sambradbury · 2025-06-19T03:56:12Z

@sambradbury that looked like it worked though?

Yes the changes worked. My poorly delivered joke was about grok giving the wrong answer.

joanna2028 · 2025-06-19T21:13:20Z

WHO the hell deleted my comments? and WHY?

skinder

LGTM

baxen · 2025-06-20T17:27:20Z

@sambradbury I'm going to merge this PR in since it's working with manual testing, could you please retarget your PR from the fork to our main when that is done? Then we can have your test in our main repo too 🙏

illahnajih · 2025-06-21T17:52:23Z

Screenshot

Here's the xAI provider with the custom logo in the Settings interface:

(Uploading screenshot...)

Dear Jack Dorsey @jackjackbits , I Need Borrowing You're Money And I will do whatever I can for you please help me 😄 😄 😙 😙 😚

illahnajih · 2025-06-21T18:42:32Z

Dear Jack Dorsey @jackjackbits I Need Borrowing You're Money And I will do whatever I can for you please help me 😄 😄 😙 😙 😚

illahnajih · 2025-06-21T18:43:07Z

Dear Jack Dorsey @jackjackbits I Need Borrowing You're Money And I will do whatever I can for you please help me 😄 😄 😙 😙 😚

illahnajih · 2025-06-21T18:43:50Z

Dear Jack Dorsey @jackjackbits I Need Borrowing You're Money And I will do whatever I can for you please help me 😄 😄 😙 😙 😚 > # Add xAI Provider Support for Grok Models

Summary

This PR adds comprehensive support for xAI's Grok models to Goose, enabling users to interact with models like grok-3, grok-3-mini, and grok-3-fast through the xAI API. The implementation includes both CLI and GUI support with proper authentication, context limits, and visual branding.

Motivation

xAI's Grok models offer competitive performance with a large 131,072 token context window, making them valuable alternatives for users seeking high-capacity language models. This addition expands Goose's provider ecosystem and gives users more flexibility in choosing their preferred AI models.

Changes

Core Provider Implementation

New xAI Provider (crates/goose/src/providers/xai.rs)

Implements the Goose provider interface for xAI API

Proper authentication via XAI_API_KEY environment variable or config

Configurable host with default to https://api.x.ai/v1

Full streaming support for responses

Provider Integration

Added xAI to provider factory (crates/goose/src/providers/factory.rs)

Registered in provider module (crates/goose/src/providers/mod.rs)

Added to desktop app provider registry

Model Support

Context Limits (crates/goose/src/model.rs)

Added Grok models to MODEL_SPECIFIC_LIMITS with 131,072 token limit

Ensures proper context window display in both CLI and GUI

Supported Models

grok-3

grok-3-mini

grok-3-fast

grok-2-vision-1212

grok-vision

grok-2

grok

grok-1.5

GUI Integration

Provider Logo

Added custom xAI logo to provider selection modal

Implemented CSS invert filter to handle black logo on dark background

Adjusted logo size (w-8 h-8) to fit properly within circular container

Desktop App Support

Full integration with Settings → Providers interface

Seamless model selection and configuration

Documentation

Updated documentation/docs/getting-started/providers.md to include xAI

Added configuration details and API key requirements

Bug Fixes

Fixed API URL construction issue where base URL wasn't properly joined with endpoint path

Ensured trailing slash handling for proper URL formation

Fixed context limit display (was showing 0/32000, now correctly shows 0/131072)

Testing

✅ Provider authentication and API calls working

✅ Context limits display correctly in both CLI and GUI

✅ Logo displays properly with correct sizing and visibility

✅ All linting and formatting checks pass

✅ Rust compilation with no warnings

Usage

CLI
# Set API key
export XAI_API_KEY=your-api-key

# Start a session
goose session --model grok-3
GUI

Open Goose Desktop

Go to Settings → Providers

Click "Add Provider" and select xAI

Enter your API key

Select your preferred Grok model

Configuration File
# ~/.config/goose/config.yaml
XAI_API_KEY: your-api-key
provider: xai
model: grok-3
Screenshots

Notes

The xAI logo required special handling due to being black text on transparent background

CSS filter inversion and size adjustment ensure proper visibility in dark mode

API endpoint confirmed working at https://api.x.ai/v1/chat/completions

Checklist

Code compiles without errors

All tests pass

Linting checks pass

Documentation updated

UI/UX tested in both light and dark modes

API integration tested with real API key

* main: fix: Improves reliability of flaky log tests (#3029) Add xAI Test Coverage (#3020) Reorganizing tutorials (#3028) feat(providers): update Google Gemini models to latest available models (#2989) fix(docker): install protoc to fix lance-encoding build (#2995) fix: updated openrouter known models (#3021) Mnovich/temporal foreground tasks (#2895) add 'install in goose' asset (#3016) Added useDarkMode hook for detecting dark mode setting dynamically (#3019) docs: add sagemaker provider (#2980) Docs: Add Goose Recipes Cookbook Page (#2998) feat (cli): add an alias --id for --name param for goose session --resume command (#3018) fix: disable extension (#3000) Add xAI Provider Support for Grok Models (#2976) removing dlls from core bin (#3014) docs: Update Leaderboard in New Community Landing Page (#2954) Douwe/fix include for recipes (#2914)

Co-authored-by: jack <jack@deck.local>

rebeca898989 · 2025-06-25T22:48:14Z

Screenshot

Here's the xAI provider with the custom logo in the Settings interface:

(Uploading screenshot...)
Hi jack. For a long time i try to talk with u. Could send a email? rebecateatro@yahoo.com.br

rebeca898989 · 2025-06-25T22:51:14Z

@jackjackbits Here's the xAI provider with the custom logo in the Settings interface:

(Uploading screenshot...)
Hi jack. For a long time i try to talk with u. Could send a email? rebecateatro@yahoo.com.br

illahnajih · 2025-07-01T17:57:12Z

Dear Jack Dorsey @jackjackbits , I Need Borrowing You're Money And I will do whatever I can for you please help me

vioricavg · 2025-07-01T18:10:49Z

Try to mine :)

…

On Tue, Jul 1, 2025, 20:57 illahnajih ***@***.***> wrote: *illahnajih* left a comment (block/goose#2976) <#2976 (comment)> Dear Jack Dorsey @jackjackbits <https://github.com/jackjackbits> , I Need Borrowing You're Money And I will do whatever I can for you please help me — Reply to this email directly, view it on GitHub <#2976 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/BHAVKJPETUVHIJQHGPM2AUD3GLDZBAVCNFSM6AAAAAB7RN6AICVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZTAMRVGAYTANJWGU> . You are receiving this because you are subscribed to this thread.Message ID: ***@***.***>

vioricavg · 2025-07-01T18:14:06Z

You know, I kept trying to borrow like you, but in the end they tried to steal from me. I don't know by whom.

…

On Tue, Jul 1, 2025, 21:10 Viorica Girbu ***@***.***> wrote: Try to mine :) On Tue, Jul 1, 2025, 20:57 illahnajih ***@***.***> wrote: > *illahnajih* left a comment (block/goose#2976) > <#2976 (comment)> > > Dear Jack Dorsey @jackjackbits <https://github.com/jackjackbits> , I > Need Borrowing You're Money And I will do whatever I can for you please > help me > > — > Reply to this email directly, view it on GitHub > <#2976 (comment)>, or > unsubscribe > <https://github.com/notifications/unsubscribe-auth/BHAVKJPETUVHIJQHGPM2AUD3GLDZBAVCNFSM6AAAAAB7RN6AICVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZTAMRVGAYTANJWGU> > . > You are receiving this because you are subscribed to this thread.Message > ID: ***@***.***> >

illahnajih · 2025-07-01T18:36:42Z

Really

vioricavg · 2025-07-01T18:45:17Z

Yes

Co-authored-by: jack <jack@deck.local> Signed-off-by: Soroosh <soroosh.sarabadani@gmail.com>

Co-authored-by: jack <jack@deck.local>

jack added 8 commits June 17, 2025 23:01

Fix xAI API URL construction by ensuring base URL ends with slash

5bc305a

Add xAI logo to GUI provider selection

67e9952

Fix xAI logo visibility by applying CSS invert filter for black logo

c7b1241

Reduce xAI logo size to fit properly within circle

98a75e7

Add xAI to supported providers documentation

a9b821d

michaelneale reviewed Jun 18, 2025

View reviewed changes

.goose/memory/project improvement ideas.txt Outdated Show resolved Hide resolved

michaelneale added 2 commits June 18, 2025 10:11

adding goose working memory to gitignore

ec1b960

michaelneale approved these changes Jun 18, 2025

View reviewed changes

salman1993 approved these changes Jun 18, 2025

View reviewed changes

michaelneale changed the base branch from main to micn/main June 18, 2025 03:21

michaelneale changed the base branch from micn/main to main June 18, 2025 03:22

block deleted a comment from joanna2028 Jun 18, 2025

sambradbury mentioned this pull request Jun 19, 2025

Add tests for Xai provider jackjackbits/goose#1

Closed

sambradbury approved these changes Jun 19, 2025

View reviewed changes

sambradbury mentioned this pull request Jun 19, 2025

Feature Request: Support for Grok Live Search #2863

Closed

skinder approved these changes Jun 20, 2025

View reviewed changes

baxen merged commit bd25b15 into block:main Jun 20, 2025
7 checks passed

sambradbury mentioned this pull request Jun 20, 2025

Add xAI Test Coverage #3020

Merged

chaitanyarahalkar mentioned this pull request Jun 24, 2025

chaitanyarahalkar/elicitation support mcp chaitanyarahalkar/goose#4

Open

btdeviant pushed a commit to btdeviant/goose that referenced this pull request Jun 25, 2025

Add xAI Provider Support for Grok Models (block#2976)

0adb6be

Co-authored-by: jack <jack@deck.local>

s-soroosh pushed a commit to s-soroosh/goose that referenced this pull request Jul 18, 2025

Add xAI Provider Support for Grok Models (block#2976)

f8bf9cf

Co-authored-by: jack <jack@deck.local> Signed-off-by: Soroosh <soroosh.sarabadani@gmail.com>

cbruyndoncx pushed a commit to cbruyndoncx/goose that referenced this pull request Jul 20, 2025

Add xAI Provider Support for Grok Models (block#2976)

3a68abd

Co-authored-by: jack <jack@deck.local>

Add xAI Provider Support for Grok Models #2976

Add xAI Provider Support for Grok Models #2976

Uh oh!

Conversation

jackjackbits commented Jun 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Add xAI Provider Support for Grok Models

Summary

Motivation

Changes

Core Provider Implementation

Model Support

GUI Integration

Documentation

Bug Fixes

Testing

Usage

CLI

GUI

Configuration File

Screenshots

Notes

Checklist

Uh oh!

jackjackbits commented Jun 17, 2025

Screenshot

Uh oh!

FaresKi commented Jun 17, 2025

Uh oh!

Uh oh!

michaelneale commented Jun 18, 2025

Uh oh!

salman1993 commented Jun 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

michaelneale commented Jun 18, 2025

Uh oh!

michaelneale commented Jun 18, 2025

Uh oh!

realtamimuddin commented Jun 18, 2025

Uh oh!

eminogrande commented Jun 18, 2025

Uh oh!

sambradbury commented Jun 19, 2025

Uh oh!

sambradbury commented Jun 19, 2025

Uh oh!

michaelneale commented Jun 19, 2025

Uh oh!

sambradbury commented Jun 19, 2025

Uh oh!

joanna2028 commented Jun 19, 2025

Uh oh!

skinder left a comment

Choose a reason for hiding this comment

Uh oh!

baxen commented Jun 20, 2025

Uh oh!

Uh oh!

illahnajih commented Jun 21, 2025

Screenshot

Uh oh!

illahnajih commented Jun 21, 2025

Uh oh!

illahnajih commented Jun 21, 2025

Uh oh!

illahnajih commented Jun 21, 2025

Summary

Motivation

Changes

Core Provider Implementation

Model Support

GUI Integration

Documentation

Bug Fixes

Testing

Usage

CLI

GUI

Configuration File

jackjackbits commented Jun 17, 2025 •

edited

Loading

salman1993 commented Jun 18, 2025 •

edited

Loading