mirror of
https://github.com/tiennm99/serena.git
synced 2026-10-14 08:18:36 +00:00
Merge branch 'main' into prepare-v1
This commit is contained in:
commit
619131cb22
4 files changed
+21
-21
No files matched your search
@@ -3,6 +3,13 @@
|
||||
In the following, we provide general instructions on how to connect Serena to your MCP-enabled client,
|
||||
as well as specific instructions for popular clients.
|
||||
|
||||
:::{note}
|
||||
The configurations we provide for particular clients below will run the latest version of Serena
|
||||
using the `stdio` protocol with `uvx`.
|
||||
Adapt the commands to your preferred way of [running Serena](020_running), adding any additional
|
||||
command-line arguments as needed.
|
||||
:::
|
||||
|
||||
(clients-general-instructions)=
|
||||
## General Instructions
|
||||
|
||||
@@ -14,6 +21,8 @@ To connect Serena to your favourite client, simply
|
||||
* 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.
|
||||
|
||||
Find concrete examples for popular clients below.
|
||||
|
||||
Depending on your needs, you might want to further customize Serena's behaviour by
|
||||
* [adding command-line arguments](mcp-args)
|
||||
* [adjusting configuration](050_configuration).
|
||||
@@ -62,16 +71,7 @@ object, e.g.
|
||||
}
|
||||
```
|
||||
|
||||
## Specific Clients
|
||||
|
||||
:::{note}
|
||||
In this section, we present example configurations that run the latest version of Serena
|
||||
using the `stdio` protocol with `uvx`.
|
||||
Adapt the commands to your preferred way of [running Serena](020_running), adding any additional
|
||||
command-line arguments as needed.
|
||||
:::
|
||||
|
||||
### Claude Code
|
||||
## Claude Code
|
||||
|
||||
Serena is a great way to make Claude Code both cheaper and more powerful!
|
||||
|
||||
@@ -101,7 +101,7 @@ single global MCP configuration. The `--project-from-cwd` option is intended for
|
||||
|
||||
Be sure to use at least `v1.0.52` of Claude Code (as earlier versions do not read MCP server system prompts upon startup).
|
||||
|
||||
### VSCode
|
||||
## VSCode
|
||||
|
||||
While serena can be directly installed from the GitHub MCP server registry, we recommend to set it up manually
|
||||
(at least for now, until the configuration there has been improved). Just paste the following into
|
||||
@@ -129,7 +129,7 @@ While serena can be directly installed from the GitHub MCP server registry, we r
|
||||
}
|
||||
```
|
||||
|
||||
### Codex
|
||||
## Codex
|
||||
|
||||
Serena works with OpenAI's Codex CLI out of the box, but you have to use the `codex` context for it to work properly. (The technical reason is that Codex doesn't fully support the MCP specifications, so some massaging of tools is required.).
|
||||
|
||||
@@ -157,7 +157,7 @@ that was already taken).
|
||||
|
||||
> Codex will often show the tools as `failed` even though they are successfully executed. This is not a problem, seems to be a bug in Codex. Despite the error message, everything works as expected.
|
||||
|
||||
### Claude Desktop
|
||||
## Claude Desktop
|
||||
|
||||
On Windows and macOS, there are official [Claude Desktop applications by Anthropic](https://claude.ai/download); for Linux, there is an [open-source
|
||||
community version](https://github.com/aaddrick/claude-desktop-debian).
|
||||
@@ -198,7 +198,7 @@ After restarting, you should see Serena's tools in your chat interface (notice t
|
||||
For more information on MCP servers with Claude Desktop,
|
||||
see [the official quick start guide](https://modelcontextprotocol.io/quickstart/user).
|
||||
|
||||
### JetBrains Junie
|
||||
## JetBrains Junie
|
||||
|
||||
Open Junie, go to the three dots in the top right corner, then Settings / MCP Settings and add Serena to Junie's global
|
||||
MCP server configuration:
|
||||
@@ -224,7 +224,7 @@ MCP server configuration:
|
||||
You will have to prompt Junie to "Activate the current project using serena's activation tool" at the
|
||||
start of each session.
|
||||
|
||||
### JetBrains AI Assistant
|
||||
## JetBrains AI Assistant
|
||||
|
||||
Here you can set up the more convenient per-project MCP server configuration, as the AI assistant supports specifying
|
||||
the launch working directory.
|
||||
@@ -253,7 +253,7 @@ Go to Settings / Tools / AI Assistant / MCP and add a new **local** configuratio
|
||||
|
||||
Then make sure to configure the working directory to be the project root.
|
||||
|
||||
### Antigravity
|
||||
## Antigravity
|
||||
|
||||
:::{warning}
|
||||
At the time of writing (12/2025), Antigravity does not seem to work with Serena due to schema validation issues
|
||||
@@ -282,11 +282,11 @@ Add this configuration:
|
||||
}
|
||||
```
|
||||
|
||||
### Other Clients
|
||||
## Other Clients
|
||||
|
||||
For other clients, follow the [general instructions](#clients-general-instructions) above to set up Serena as an MCP server.
|
||||
|
||||
#### Terminal-Based Clients
|
||||
### Terminal-Based Clients
|
||||
|
||||
There are many terminal-based coding assistants that support MCP servers, such as
|
||||
|
||||
@@ -302,7 +302,7 @@ by writing your own context, modes or prompts to adjust it to the client's respe
|
||||
In most cases, the `ide` context is likely to be appropriate for such clients, i.e. add the arguments `--context ide`
|
||||
in order to reduce tool duplication.
|
||||
|
||||
#### MCP-Enabled IDEs and Coding Clients (Cline, Roo-Code, Cursor, Windsurf, etc.)
|
||||
### MCP-Enabled IDEs and Coding Clients (Cline, Roo-Code, Cursor, Windsurf, etc.)
|
||||
|
||||
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.
|
||||
@@ -310,7 +310,7 @@ to MCP Servers. Serena generally boosts performance by providing efficient tools
|
||||
We generally recommend to use the `ide` context for these integrations by adding the arguments `--context ide`
|
||||
in order to reduce tool duplication.
|
||||
|
||||
#### Local GUIs and Agent Frameworks
|
||||
### Local GUIs and Agent Frameworks
|
||||
|
||||
Over the last months, several technologies have emerged that allow you to run a local GUI client
|
||||
and connect it to an MCP server. The respective applications will typically work with Serena out of the box.
|
||||
|
||||
+1
-1
@@ -53,7 +53,7 @@ parse:
|
||||
#######################################################################################
|
||||
# HTML-specific settings
|
||||
html:
|
||||
#favicon : # A path to a favicon image
|
||||
favicon : "../src/serena/resources/dashboard/serena-icon-32.png"
|
||||
use_edit_page_button : false # Whether to add an "edit this page" button to pages. If `true`, repository information in repository: must be filled in
|
||||
use_repository_button : false # Whether to add a link to your repository button
|
||||
use_issues_button : false # Whether to add an "open an issue" button
|
||||
|
||||
Whitespace-only changes.
Binary file not shown.
|
Before Width: | Height: | Size: 4.7 KiB After Width: | Height: | Size: 3.7 KiB |
Reference in new issue
Block a user