Skip to content

Commit e486729

Browse files
docs: fix outdated Codex MCP setup instructions (#1656)
* docs: fix outdated Codex MCP setup instructions - Replace broken config.toml + 'codex mcp login' primary path with 'codex mcp add sourcebot --url <URL>' which matches Settings → MCP - Add tip near Getting Started pointing users to Settings → MCP for easiest setup (one-click install cards) - Update Codex docs link to current official location - Fix API key path to use CLI flag instead of manual config.toml editing Co-authored-by: Michael Sukkarieh <msukkari@users.noreply.github.com> * docs: remove anonymous access mentions from MCP docs Co-authored-by: Michael Sukkarieh <msukkari@users.noreply.github.com> * docs: consolidate example notes and restore anonymous access mention - Remove redundant sentence from Fastest setup tip - Combine public deployment note with anonymous access into single Note - Restore anonymous access mention in Authorization section Co-authored-by: Michael Sukkarieh <msukkari@users.noreply.github.com> --------- Co-authored-by: Cursor Agent <cursoragent@cursor.com> Co-authored-by: Michael Sukkarieh <msukkari@users.noreply.github.com>
1 parent c0d0df9 commit e486729

1 file changed

Lines changed: 20 additions & 19 deletions

File tree

docs/docs/features/mcp-server.mdx

Lines changed: 20 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,14 @@ Sourcebot MCP uses a [Streamable HTTP](https://modelcontextprotocol.io/specifica
2323

2424
You can read more about the options in the [authorization](#authorization) section.
2525

26-
<Note>
27-
If [anonymous access](https://docs.sourcebot.dev/docs/configuration/auth/access-settings#anonymous-access) is enabled on your Sourcebot instance, no OAuth token or API key is required. You can connect directly to the MCP endpoint without any authorization.
28-
</Note>
26+
<Tip>
27+
**Fastest setup:** Open **Settings → MCP** in your Sourcebot deployment to copy the Server URL and use one-click install cards for supported clients.
28+
</Tip>
2929

3030
<Note>
31-
The examples below add the MCP server and connect it to Sourcebot's public deployment at [app.sourcebot.dev](https://app.sourcebot.dev). Replace the URL with your own Sourcebot deployment as needed.
31+
Note the following about these examples:
32+
- The examples add the MCP server and connect it to Sourcebot's public deployment at [app.sourcebot.dev](https://app.sourcebot.dev). Replace the URL with your own Sourcebot deployment as needed.
33+
- If [anonymous access](/docs/configuration/auth/access-settings#anonymous-access) is enabled on your Sourcebot instance, no OAuth token or API key is required. You can connect directly to the MCP endpoint without any authorization.
3234
</Note>
3335

3436
<AccordionGroup>
@@ -145,30 +147,29 @@ You can read more about the options in the [authorization](#authorization) secti
145147
</Accordion>
146148

147149
<Accordion title="Codex">
148-
[Codex MCP docs](https://developers.openai.com/codex/mcp)
149-
150-
Add the following to your `~/.codex/config.toml` file:
150+
[Codex MCP docs](https://learn.chatgpt.com/docs/extend/mcp)
151151

152152
<Tabs>
153153
<Tab title="OAuth">
154154
<LicenseKeyRequired feature="OAuth" />
155155

156-
```toml
157-
[mcp_servers.sourcebot]
158-
url = "https://app.sourcebot.dev/api/mcp"
159-
```
160-
161-
Replace `https://app.sourcebot.dev` with wherever your Sourcebot instance is hosted. Then run the following to authenticate:
156+
Run the following command:
162157

163158
```sh
164-
codex mcp login sourcebot
159+
codex mcp add sourcebot --url https://app.sourcebot.dev/api/mcp
165160
```
161+
162+
Replace `https://app.sourcebot.dev` with wherever your Sourcebot instance is hosted. Codex will automatically detect OAuth support and prompt you to authorize in your browser when you first connect.
163+
164+
<Tip>
165+
Open **Settings → MCP** in your Sourcebot deployment and click **Copy command** on the Codex card for a ready-to-run command with the correct Server URL.
166+
</Tip>
166167
</Tab>
167168
<Tab title="API Key">
168-
```toml
169-
[mcp_servers.sourcebot]
170-
url = "https://app.sourcebot.dev/api/mcp"
171-
bearer_token_env_var = "SOURCEBOT_API_KEY"
169+
Run the following command:
170+
171+
```sh
172+
codex mcp add sourcebot --url https://app.sourcebot.dev/api/mcp --bearer-token-env-var SOURCEBOT_API_KEY
172173
```
173174

174175
Replace `https://app.sourcebot.dev` with wherever your Sourcebot instance is hosted, then set your API key as an environment variable:
@@ -276,7 +277,7 @@ You can read more about the options in the [authorization](#authorization) secti
276277

277278
## Authorization
278279

279-
The Sourcebot MCP server supports two authorization methods, OAuth and API keys. If [anonymous access](/docs/configuration/auth/access-settings#anonymous-access) is enabled on your instance, no authorization is required.
280+
The Sourcebot MCP server supports two authorization methods: OAuth and API keys. If [anonymous access](/docs/configuration/auth/access-settings#anonymous-access) is enabled on your instance, no authorization is required.
280281

281282
Regardless of which method you use, all MCP requests are scoped to the associated Sourcebot user and inherit the [user's role and permissions](/docs/configuration/auth/roles-and-permissions). When [permission syncing](/docs/features/permission-syncing) is configured, this includes repository permissions - the MCP server will only surface results from repositories the user has access to.
282283

0 commit comments

Comments
 (0)