From 3ffbaa090e46662b12e43e4b3a188ecf1994cdd6 Mon Sep 17 00:00:00 2001 From: Dominik Jain Date: Fri, 21 Nov 2025 15:45:50 +0100 Subject: [PATCH] Improve documentation on connecting clients --- docs/02-usage/020_running.md | 2 ++ docs/02-usage/030_clients.md | 15 ++++++++++++--- 2 files changed, 14 insertions(+), 3 deletions(-) diff --git a/docs/02-usage/020_running.md b/docs/02-usage/020_running.md index f248a4c7..ede78ec2 100644 --- a/docs/02-usage/020_running.md +++ b/docs/02-usage/020_running.md @@ -80,6 +80,7 @@ nix run github:oraios/serena -- [options] You can also install Serena by referencing this repo (`github:oraios/serena`) and using it in your Nix flake. The package is exported as `serena`. +(start-mcp-server)= ## Running the MCP Server Given your preferred method of running Serena, you can start the MCP server using the `start-mcp-server` command: @@ -114,6 +115,7 @@ For example, to run the server in stdio mode via `uvx`, you would run: 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.) to use such a launch command. +(streamable-http)= ### Streamable HTTP Mode When using instead the *Streamable HTTP* mode, you control the server lifecycle yourself, diff --git a/docs/02-usage/030_clients.md b/docs/02-usage/030_clients.md index b0ea27b4..a323f3b8 100644 --- a/docs/02-usage/030_clients.md +++ b/docs/02-usage/030_clients.md @@ -1,4 +1,4 @@ -# Configuring Your MCP Client +# Connecting Your MCP Client In the following, we provide default configurations for popular MCP-enabled clients. @@ -123,6 +123,16 @@ For more information on MCP servers with Claude Desktop, see [the official quick ## Other Clients +In general, Serena can be used with any MCP-enabled client. +To connect Serena to your favourite client, simply + +1. determine how to add a custom MCP server to your client (refer to the client's documentation). +2. add a new MCP server entry by specifying either + * a [run command](start-mcp-server) that allows the client to start the MCP server in stdio mode as a subprocess, or + * the URL of the HTTP/SSE endpoint, having started the [Serena MCP server in HTTP/SSE mode](streamable-http) beforehand. + +Below, we list some popular categories of clients that Serena can be used with. + ### Terminal-Based Clients There are many terminal-based coding assistants that support MCP servers, such as @@ -138,8 +148,7 @@ by writing your own context, modes or prompts to adjust it to the client's respe ### MCP-Enabled IDEs and Coding Clients (Cline, Roo-Code, Cursor, Windsurf, etc.) -Being an MCP Server, Serena can be included in any MCP Client. Most of the popular -existing coding assistants (e.g. IDE extensions) and AI-enabled IDEs themselves support connections +Most of the popular existing coding assistants (e.g. IDE extensions) and AI-enabled IDEs themselves support connections to MCP Servers. Serena generally boosts performance by providing efficient tools for symbolic operations. We generally **recommend to use the `ide-assistant` context** for these integrations by adding the arguments `--context ide-assistant`