diff --git a/docs/site/reference/mcp-server.md b/docs/site/reference/mcp-server.md index 603978e46eb..6510eda05c6 100644 --- a/docs/site/reference/mcp-server.md +++ b/docs/site/reference/mcp-server.md @@ -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 @@ -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", diff --git a/release-notes/docs-mcp-install-executable.json b/release-notes/docs-mcp-install-executable.json new file mode 100644 index 00000000000..59b2d1f1d10 --- /dev/null +++ b/release-notes/docs-mcp-install-executable.json @@ -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."} +}