Skip to content

Commit db01516

Browse files
committed
Improve callouts
1 parent 2b9a450 commit db01516

2 files changed

Lines changed: 18 additions & 12 deletions

File tree

docs/02-usage/020_running.md

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,9 @@ Explore the CLI to see some of the customization options that serena provides (m
4444
(docker)=
4545
### Using Docker (Experimental)
4646

47-
⚠️ Docker support is currently experimental with several limitations. Please read the [Docker documentation](https://github.com/oraios/serena/blob/main/DOCKER.md) for important caveats before using it.
47+
:::{warning}
48+
Docker support is currently experimental with several limitations.
49+
:::
4850

4951
You can run the Serena MCP server directly via docker as follows,
5052
assuming that the projects you want to work on are all located in `/path/to/your/projects`:
@@ -61,7 +63,7 @@ Replace `/path/to/your/projects` with the absolute path to your projects directo
6163

6264
Alternatively, use docker compose with the `compose.yml` file provided in the repository.
6365

64-
See the [Docker documentation](https://github.com/oraios/serena/blob/main/DOCKER.md) for detailed setup instructions, configuration options, and known limitations.
66+
See our [Docker Setup](https://github.com/oraios/serena/blob/main/DOCKER.md) documentation for more detailed setup instructions, configuration options, and known limitations.
6567

6668
### Using Nix
6769

@@ -88,6 +90,13 @@ The typical usage involves the client (e.g. Claude Code, Codex or Cursor) runnin
8890
the MCP server as a subprocess and using the process' stdin/stdout streams to communicate with it.
8991
In order to launch the server, the client thus needs to be provided with the command to run the MCP server.
9092

93+
:::{note}
94+
MCP servers which use stdio as a protocol are somewhat unusual as far as client/server architectures go, as the server
95+
necessarily has to be started by the client in order for communication to take place via the server's standard input/output streams.
96+
In other words, you do not need to start the server yourself. The client application (e.g. Claude Desktop) takes care of this and
97+
therefore needs to be configured with a launch command.
98+
:::
99+
91100
Communication over stdio is the default for the Serena MCP server, so in the simplest
92101
case, you can simply run the `start-mcp-server` command without any additional options.
93102
@@ -96,14 +105,9 @@ case, you can simply run the `start-mcp-server` command without any additional o
96105
For example, to run the server in stdio mode via `uvx`, you would run:
97106
98107
uvx --from git+https://github.com/oraios/serena serena start-mcp-server
99-
100-
ℹ️ See the section ["Configuring Your MCP Client"](030_clients) for information on how to configure your MCP client (e.g. Claude Code, Codex, Cursor, etc.)
101-
to connect to the Serena MCP server.
102-
103-
ℹ️ Note that MCP servers which use stdio as a protocol are somewhat unusual as far as client/server architectures go, as the server
104-
necessarily has to be started by the client in order for communication to take place via the server's standard input/output stream.
105-
In other words, you do not need to start the server yourself. The client application (e.g. Claude Desktop) takes care of this and
106-
therefore needs to be configured with a launch command.
108+
109+
See the section ["Configuring Your MCP Client"](030_clients) for specific information on how to configure your MCP client (e.g. Claude Code, Codex, Cursor, etc.)
110+
to use such a launch command.
107111
108112
### Streamable HTTP Mode
109113
@@ -122,7 +126,7 @@ you would run
122126
123127
and then configure your client to connect to `http://localhost:9121/mcp`.
124128
125-
ℹ️ Note that while SSE transport is also supported, its use is discouraged.
129+
Note that while the legacy SSE transport is also supported (via `--transport sse` with corresponding /sse endpoint), its use is discouraged.
126130
127131
(mcp-args)=
128132
### MCP Server Command-Line Arguments

docs/02-usage/030_clients.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,9 @@ If you are using paths containing backslashes for paths on Windows
113113

114114
That's it! Save the config and then restart Claude Desktop. You are ready for activating your first project.
115115

116-
⚠️ Be sure to fully quit the Claude Desktop application, as closing Claude will just minimize it to the system tray – at least on Windows.
116+
:::{attention}
117+
Be sure to fully quit the Claude Desktop application via File / Exit, as regularly closing the application will just minimize it.
118+
:::
117119

118120
After restarting, you should see Serena's tools in your chat interface (notice the small hammer icon).
119121

0 commit comments

Comments
 (0)