You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/02-usage/020_running.md
+15-11Lines changed: 15 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -44,7 +44,9 @@ Explore the CLI to see some of the customization options that serena provides (m
44
44
(docker)=
45
45
### Using Docker (Experimental)
46
46
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
+
:::
48
50
49
51
You can run the Serena MCP server directly via docker as follows,
50
52
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
61
63
62
64
Alternatively, use docker compose with the `compose.yml` file provided in the repository.
63
65
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.
65
67
66
68
### Using Nix
67
69
@@ -88,6 +90,13 @@ The typical usage involves the client (e.g. Claude Code, Codex or Cursor) runnin
88
90
the MCP server as a subprocess and using the process' stdin/stdout streams to communicate with it.
89
91
In order to launch the server, the client thus needs to be provided with the command to run the MCP server.
90
92
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
+
91
100
Communication over stdio is the default for the Serena MCP server, so in the simplest
92
101
case, you can simply run the `start-mcp-server` command without any additional options.
93
102
@@ -96,14 +105,9 @@ case, you can simply run the `start-mcp-server` command without any additional o
96
105
For example, to run the server in stdio mode via `uvx`, you would run:
ℹ️ 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.
107
111
108
112
### Streamable HTTP Mode
109
113
@@ -122,7 +126,7 @@ you would run
122
126
123
127
and then configure your client to connect to `http://localhost:9121/mcp`.
124
128
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.
0 commit comments