Skip to content

docs: align MCP installation and launch executable (hosted #5090) #5091

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
schickling-assistant merged 1 commit into from
Nov 4, 2026
Merged

docs: align MCP installation and launch executable (hosted #5090) #5091

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/site/reference/mcp-server.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,16 @@ Install and configure [Fractal](../getting-started/install.md) first. The daemon
Build the adapter from the repository root with Rust and the repository's build prerequisites:

```sh
cargo build --release -p fractal-chatgpt --bin fractal-chatgpt
cargo build --release -p fractal-chatgpt --bin st-chatgpt
```

The binary is `target/release/fractal-chatgpt` (`st-chatgpt` kept as an alias binary). Alternatively, obtain the current Nix package:
The binary is `target/release/st-chatgpt`. The source package also provides the canonical `fractal-chatgpt` binary via `--bin fractal-chatgpt`; the examples here use `st-chatgpt`, which both installation methods provide. Alternatively, obtain the current Nix package:

```sh
nix build github:compoundingtech/fractal#st-chatgpt
```

That binary is `result/bin/st-chatgpt`. Use a matching Fractal revision. The examples below assume the binary is on `PATH`.
That binary is `result/bin/st-chatgpt`. Use a matching Fractal revision. The shell examples below assume `st-chatgpt` is on `PATH`; in the MCP client configuration, use the absolute path to the binary produced by your chosen installation method.

## Pair and prepare a grant

Expand Down Expand Up @@ -96,7 +96,7 @@ A generic MCP client configuration looks like this; adapt the outer configuratio
{
"mcpServers": {
"fractal": {
"command": "/PATH/TO/fractal-chatgpt",
"command": "/PATH/TO/st-chatgpt",
"args": [
"--transport", "stdio",
"--socket", "/PATH/TO/st3-client.sock",
Expand Down
12 changes: 12 additions & 0 deletions release-notes/docs-mcp-install-executable.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"version": 1,
"summary": "Align the MCP server source and Nix installation instructions with the st-chatgpt executable used by the launch examples and client configuration.",
"commits": [],
"replay": {"status": "none", "detail": "Documentation only; no replay changes."},
"schema": {"status": "none", "detail": "No schema changes."},
"rules": {"status": "none", "detail": "No checkpoint rule changes."},
"compatibility": {"status": "none", "detail": "No runtime or client contract changes; both existing Cargo binary targets and the Nix package remain unchanged."},
"downtime": {"status": "none", "detail": "No service interruption."},
"manual": {"status": "none", "detail": "No upgrade steps; installation examples now select the executable available from both documented methods."},
"recovery": {"status": "none", "detail": "No persistent state changes."}
}
Loading