Skip to content

Commit 105b927

Browse files
committed
docs(clients): update client setup docs
1 parent 5ecee96 commit 105b927

2 files changed

Lines changed: 37 additions & 5 deletions

File tree

README.md

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -543,6 +543,9 @@ npx -y @continuedev/cli@latest -p \
543543
'Reply with exactly: continue ok'
544544
```
545545

546+
The Pool API key authenticates model requests. The MCP token authenticates only
547+
the operator metadata endpoint.
548+
546549
</details>
547550

548551
<details>
@@ -594,15 +597,17 @@ For deployed instances, change `--baseurl` to `https://codex-pooler.example.com/
594597
and, if you keep the optional operator MCP add-on, change the MCP `url` to
595598
`https://codex-pooler.example.com/mcp`.
596599

600+
Use a Pool API key for `/v1` model requests and an operator MCP token for
601+
`/mcp`. Do not reuse the Pool API key for MCP.
602+
597603
</details>
598604

599605
<details>
600606
<summary><img src=".github/assets/goose-favicon.png" alt="Goose logo" width="16" height="16"> Goose <code>~/.config/goose/config.yaml</code></summary>
601607

602-
Goose's OpenAI provider supports OpenAI-compatible endpoints through
603-
`OPENAI_HOST` and `OPENAI_BASE_PATH`. Point the host at Codex Pooler and keep the
604-
Pool API key in the `OPENAI_API_KEY` environment variable or Goose's secret
605-
storage.
608+
Configure Goose's OpenAI provider for Codex Pooler's OpenAI-compatible
609+
chat-completions path. Keep the Pool API key in `OPENAI_API_KEY` or Goose's
610+
secret storage.
606611

607612
```yaml
608613
GOOSE_PROVIDER: openai
@@ -611,6 +616,18 @@ OPENAI_HOST: http://localhost:4000
611616
OPENAI_BASE_PATH: v1/chat/completions
612617
```
613618

619+
Check the headless CLI path with tool access enabled:
620+
621+
```bash
622+
export OPENAI_API_KEY="$CODEX_POOLER_API_KEY"
623+
goose run \
624+
--no-session \
625+
--provider openai \
626+
--model gpt-5.5 \
627+
--with-builtin developer \
628+
--text 'Use your developer tool to create goose-ok.txt containing exactly: goose ok. Then reply with exactly: goose ok'
629+
```
630+
614631
For optional operator MCP metadata access, add a remote Streamable HTTP
615632
extension. Codex Pooler model use does not require this. Goose stores remote
616633
extension headers in its config, so use a dedicated MCP token.
@@ -634,6 +651,9 @@ For deployed instances, change `OPENAI_HOST` to `https://codex-pooler.example.co
634651
if you keep the optional operator MCP add-on, change the extension `uri` to
635652
`https://codex-pooler.example.com/mcp`.
636653

654+
Use a Pool API key for OpenAI-compatible model requests and an operator MCP token
655+
for `/mcp`. Do not reuse the Pool API key for MCP.
656+
637657
</details>
638658

639659
<details>

docs-site/src/content/docs/clients/goose.mdx

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Goose
33
description: Configure Goose with Codex Pooler's narrow OpenAI-compatible /v1 chat completions path and optional operator MCP metadata access.
44
---
55

6-
Goose's OpenAI provider supports OpenAI-compatible endpoints through `OPENAI_HOST` and `OPENAI_BASE_PATH`. Point the host at Codex Pooler and keep the Pool API key in the `OPENAI_API_KEY` environment variable or Goose's secret storage.
6+
Configure Goose's OpenAI provider with `OPENAI_HOST` and `OPENAI_BASE_PATH`. Point the host at Codex Pooler and keep the Pool API key in the `OPENAI_API_KEY` environment variable or Goose's secret storage.
77

88
```yaml
99
GOOSE_PROVIDER: openai
@@ -14,6 +14,18 @@ OPENAI_BASE_PATH: v1/chat/completions
1414
1515
For local setup, change `OPENAI_HOST` to `http://localhost:4000`.
1616

17+
Check the headless CLI path with tool access enabled:
18+
19+
```bash
20+
export OPENAI_API_KEY="$CODEX_POOLER_API_KEY"
21+
goose run \
22+
--no-session \
23+
--provider openai \
24+
--model gpt-5.5 \
25+
--with-builtin developer \
26+
--text 'Use your developer tool to create goose-ok.txt containing exactly: goose ok. Then reply with exactly: goose ok'
27+
```
28+
1729
For optional operator MCP metadata access, add a remote Streamable HTTP extension. Codex Pooler model use does not require this. Goose stores remote extension headers in its config, so use a dedicated MCP token.
1830

1931
```yaml

0 commit comments

Comments
 (0)