Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
101 changes: 45 additions & 56 deletions .serena/project.yml
Original file line number Diff line number Diff line change
@@ -1,21 +1,26 @@


# list of languages for which language servers are started; choose from:
# al bash clojure cpp csharp
# csharp_omnisharp dart elixir elm erlang
# fortran fsharp go groovy haskell
# java julia kotlin lua markdown
# matlab nix pascal perl php
# php_phpactor powershell python python_jedi r
# rego ruby ruby_solargraph rust scala
# swift terraform toml typescript typescript_vts
# vue yaml zig
# al angular ansible bash clojure
# cpp cpp_ccls crystal csharp csharp_omnisharp
# dart elixir elm erlang fortran
# fsharp go groovy haskell haxe
# hlsl html java json julia
# kotlin lean4 lua luau markdown
# matlab msl nix ocaml pascal
# perl php php_phpactor powershell python
# python_jedi python_ty r rego ruby
# ruby_solargraph rust scala scss solidity
# swift systemverilog terraform toml typescript
# typescript_vts vue yaml zig
# (This list may be outdated. For the current list, see values of Language enum here:
# https://github.com/oraios/serena/blob/main/src/solidlsp/ls_config.py
# For some languages, there are alternative language servers, e.g. csharp_omnisharp, ruby_solargraph.)
# Note:
# - For C, use cpp
# - For JavaScript, use typescript
# - For Angular projects, use angular (subsumes typescript+html; requires `npm install` in the project root)
# - For SCSS / Sass / plain CSS, use scss (some-sass-language-server handles all three)
# - For Free Pascal/Lazarus, use pascal
# Special requirements:
# Some languages require additional setup/installations.
Expand Down Expand Up @@ -64,49 +69,12 @@ initial_prompt: |

# list of tool names to exclude.
# This extends the existing exclusions (e.g. from the global configuration)
#
# Below is the complete list of tools for convenience.
# To make sure you have the latest list of tools, and to view their descriptions,
# execute `uv run scripts/print_tool_overview.py`.
#
# * `activate_project`: Activates a project by name.
# * `check_onboarding_performed`: Checks whether project onboarding was already performed.
# * `create_text_file`: Creates/overwrites a file in the project directory.
# * `delete_lines`: Deletes a range of lines within a file.
# * `delete_memory`: Deletes a memory from Serena's project-specific memory store.
# * `execute_shell_command`: Executes a shell command.
# * `find_referencing_code_snippets`: Finds code snippets in which the symbol at the given location is referenced.
# * `find_referencing_symbols`: Finds symbols that reference the symbol at the given location (optionally filtered by type).
# * `find_symbol`: Performs a global (or local) search for symbols with/containing a given name/substring (optionally filtered by type).
# * `get_current_config`: Prints the current configuration of the agent, including the active and available projects, tools, contexts, and modes.
# * `get_symbols_overview`: Gets an overview of the top-level symbols defined in a given file.
# * `initial_instructions`: Gets the initial instructions for the current project.
# Should only be used in settings where the system prompt cannot be set,
# e.g. in clients you have no control over, like Claude Desktop.
# * `insert_after_symbol`: Inserts content after the end of the definition of a given symbol.
# * `insert_at_line`: Inserts content at a given line in a file.
# * `insert_before_symbol`: Inserts content before the beginning of the definition of a given symbol.
# * `list_dir`: Lists files and directories in the given directory (optionally with recursion).
# * `list_memories`: Lists memories in Serena's project-specific memory store.
# * `onboarding`: Performs onboarding (identifying the project structure and essential tasks, e.g. for testing or building).
# * `prepare_for_new_conversation`: Provides instructions for preparing for a new conversation (in order to continue with the necessary context).
# * `read_file`: Reads a file within the project directory.
# * `read_memory`: Reads the memory with the given name from Serena's project-specific memory store.
# * `remove_project`: Removes a project from the Serena configuration.
# * `replace_lines`: Replaces a range of lines within a file with new content.
# * `replace_symbol_body`: Replaces the full definition of a symbol.
# * `restart_language_server`: Restarts the language server, may be necessary when edits not through Serena happen.
# * `search_for_pattern`: Performs a search for a pattern in the project.
# * `summarize_changes`: Provides instructions for summarizing the changes made to the codebase.
# * `switch_modes`: Activates modes by providing a list of their names
# * `think_about_collected_information`: Thinking tool for pondering the completeness of collected information.
# * `think_about_task_adherence`: Thinking tool for determining whether the agent is still on track with the current task.
# * `think_about_whether_you_are_done`: Thinking tool for determining whether the task is truly completed.
# * `write_memory`: Writes a named memory (for future reference) to Serena's project-specific memory store.
# Find the list of tools here: https://oraios.github.io/serena/01-about/035_tools.html
excluded_tools: []

# list of tools to include that would otherwise be disabled (particularly optional tools that are disabled by default).
# This extends the existing inclusions (e.g. from the global configuration).
# Find the list of tools here: https://oraios.github.io/serena/01-about/035_tools.html
included_optional_tools: []

# list of mode names to that are always to be included in the set of active modes
Expand All @@ -117,21 +85,21 @@ included_optional_tools: []
# Set this to a list of mode names to always include the respective modes for this project.
base_modes:

# list of mode names that are to be activated by default.
# The full set of modes to be activated is base_modes + default_modes.
# If the setting is undefined, the default_modes from the global configuration (serena_config.yml) apply.
# list of mode names that are to be activated by default, overriding the setting in the global configuration.
# The full set of modes to be activated is base_modes (from global config) + default_modes + added_modes.
# If the setting is undefined/empty, the default_modes from the global configuration (serena_config.yml) apply.
# Otherwise, this overrides the setting from the global configuration (serena_config.yml).
# Therefore, you can set this to [] if you do not want the default modes defined in the global config to apply
# for this project.
# This setting can, in turn, be overridden by CLI parameters (--mode).
# See https://oraios.github.io/serena/02-usage/050_configuration.html#modes
default_modes:

# fixed set of tools to use as the base tool set (if non-empty), replacing Serena's default set of tools.
# This cannot be combined with non-empty excluded_tools or included_optional_tools.
# Find the list of tools here: https://oraios.github.io/serena/01-about/035_tools.html
fixed_tools: []

# project_name is intentionally omitted in shared config so Serena falls back to the
# worktree folder name and multiple FieldWorks worktrees stay distinct.
# If you need an explicit local override, put it in .serena/project.local.yml.

# time budget (seconds) per tool call for the retrieval of additional symbol information
# such as docstrings or parameter information.
# This overrides the corresponding setting in the global configuration; see the documentation there.
Expand All @@ -150,7 +118,7 @@ language_backend:
# This does not affect Serena's own files (e.g. memories and configuration files), which always use native line endings.
line_ending:

# list of regex patterns which, when matched, mark a memory entry as read-only.
# list of regex patterns which, when matched, mark a memory entry as readonly.
# Extends the list from the global configuration, merging the two lists.
read_only_memory_patterns: []

Expand All @@ -167,3 +135,24 @@ ignored_memory_patterns: []
# Have a look at the docstring of the constructors of the LS implementations within solidlsp (e.g., for C# or PHP) to see which options are available.
# No documentation on options means no options are available.
ls_specific_settings: {}

# list of mode names to be activated additionally for this project, e.g. ["query-projects"]
# The full set of modes to be activated is base_modes (from global config) + default_modes + added_modes.
# See https://oraios.github.io/serena/02-usage/050_configuration.html#modes
added_modes:

# list of additional workspace folder paths for cross-package reference support (e.g. in monorepos).
# Paths can be absolute or relative to the project root.
# Each folder is registered as an LSP workspace folder, enabling language servers to discover
# symbols and references across package boundaries.
# Currently supported for: TypeScript.
# Example:
# additional_workspace_folders:
# - ../sibling-package
# - ../shared-lib
additional_workspace_folders: []
# Keep a stable shared project_name here because current Serena rewrites incomplete
# project.yml files and auto-adds this field if it is missing.
# If you need a per-worktree name, override project_name in ignored
# .serena/project.local.yml instead of editing the shared file.
project_name: FieldWorks
6 changes: 5 additions & 1 deletion .vscode/tasks.json
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@
"label": "Setup: Colorize Worktree",
"type": "shell",
"command": "./scripts/Setup-WorktreeColor.ps1 -VSCodeWorkspaceFile \"${workspaceFile}\"",
"detail": "Sets a unique window color from a deterministic palette slot",
"detail": "Sets a unique window color from a rotating palette slot",
"runOptions": {
"runOn": "folderOpen"
},
Expand Down Expand Up @@ -435,6 +435,10 @@
"args": ["-NoProfile", "-ExecutionPolicy", "Bypass", "-Command"]
}
},
"presentation": {
"reveal": "never",
"panel": "shared"
},
"problemMatcher": []
},
{
Expand Down
2 changes: 1 addition & 1 deletion Build/Agent/Setup-Serena.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ if (Test-Path $serenaConfig) {
Write-Status "No languages found in .serena/project.yml" -Status "WARN"
}

if ($configContent -match '^\s*project_name:\s*' -and $projectName) {
if ($configContent -match '(?m)^\s*project_name:\s*' -and $projectName) {
Write-Status "Configured project name: $projectName"
}
else {
Expand Down
21 changes: 14 additions & 7 deletions Docs/mcp.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,9 +62,13 @@ VS Code's user-level MCP config (`%APPDATA%\Code\User\mcp.json`) may have a Sere
server that auto-discovers projects by scanning for `.serena` folders. Combined with
workspace-level `mcp.json`, this creates duplicate project registrations.

This repo's shared `.serena/project.yml` intentionally leaves `project_name` unset so
Serena falls back to the worktree folder name by default. That keeps worktrees easier
to distinguish when multiple registrations exist.
Current Serena releases normalize incomplete `project.yml` files and will write
`project_name` back into the shared config if it is missing. To avoid that churn,
this repo keeps a stable shared `project_name` in `.serena/project.yml`.

For worktree-specific naming, use the ignored `.serena/project.local.yml` file in
each worktree to override `project_name` locally. That keeps Serena names distinct
without causing repeated edits to the versioned config.

### Solution
**Use only workspace-level Serena, and keep project names local to the worktree**
Expand All @@ -77,9 +81,12 @@ code "$env:APPDATA\Code\User\mcp.json"
Remove the `"oraios/serena"` entry. The workspace `.vscode/mcp.json` provides Serena
with explicit project targeting.

If you want a friendlier project name than the folder name, set it in
`.serena/project.local.yml` for that worktree instead of committing a shared
`project_name` in `.serena/project.yml`.
If you want a worktree-specific Serena project name, set it in
`.serena/project.local.yml` for that worktree. For example:

```yaml
project_name: 010-advanced-entry-view
```

## Best-practice profile for this repo

Expand All @@ -93,7 +100,7 @@ If you want a friendlier project name than the folder name, set it in
- Open one VS Code window per worktree; let that window use its own workspace `.vscode/mcp.json`.
- Keep only one Serena server definition active (workspace-level), and remove user-level Serena.
- Keep Serena pinned to the active workspace via `--project ${workspaceFolder}` (already configured).
- If you want an explicit Serena project name, set it in `.serena/project.local.yml`; do not commit a shared `project_name` in `.serena/project.yml`.
- If you want a worktree-specific Serena project name, set it in `.serena/project.local.yml`; keep the shared `.serena/project.yml` complete so Serena does not rewrite it.
- After switching worktrees, run **MCP: Reset Cached Tools** if tool lists or capabilities look stale.
- No extra GitHub MCP worktree settings are required beyond OAuth sign-in.

Expand Down
Loading
Loading