1+
2+
13# list of languages for which language servers are started; choose from:
2- # al bash clojure cpp csharp csharp_omnisharp
3- # dart elixir elm erlang fortran go
4- # haskell java julia kotlin lua markdown
5- # nix perl php python python_jedi r
6- # rego ruby ruby_solargraph rust scala swift
7- # terraform typescript typescript_vts yaml zig
4+ # al ansible bash clojure cpp
5+ # cpp_ccls crystal csharp csharp_omnisharp dart
6+ # elixir elm erlang fortran fsharp
7+ # go groovy haskell haxe hlsl
8+ # java json julia kotlin lean4
9+ # lua luau markdown matlab msl
10+ # nix ocaml pascal perl php
11+ # php_phpactor powershell python python_jedi python_ty
12+ # r rego ruby ruby_solargraph rust
13+ # scala solidity swift systemverilog terraform
14+ # toml typescript typescript_vts vue yaml
15+ # zig
16+ # (This list may be outdated. For the current list, see values of Language enum here:
17+ # https://github.com/oraios/serena/blob/main/src/solidlsp/ls_config.py
18+ # For some languages, there are alternative language servers, e.g. csharp_omnisharp, ruby_solargraph.)
819# Note:
920# - For C, use cpp
1021# - For JavaScript, use typescript
22+ # - For Free Pascal/Lazarus, use pascal
1123# Special requirements:
12- # - csharp: Requires the presence of a .sln file in the project folder.
24+ # Some languages require additional setup/installations.
25+ # See here for details: https://oraios.github.io/serena/01-about/020_programming-languages.html#language-servers
1326# When using multiple languages, the first language server that supports a given file will be used for that file.
1427# The first language is the default language and the respective language server will be used as a fallback.
1528# Note that when using the JetBrains backend, language servers are not used and this list is correspondingly ignored.
@@ -20,14 +33,12 @@ languages:
2033# For a list of possible encodings, see https://docs.python.org/3.11/library/codecs.html#standard-encodings
2134encoding : " utf-8"
2235
23- # whether to use the project's gitignore file to ignore files
24- # Added on 2025-04-07
36+ # whether to use project's .gitignore files to ignore files
2537ignore_all_files_in_gitignore : true
2638
27- # list of additional paths to ignore
28- # same syntax as gitignore, so you can use * and **
29- # Was previously called `ignored_dirs`, please update your config if you are using that.
30- # Added (renamed) on 2025-04-07
39+ # list of additional paths to ignore in this project.
40+ # Same syntax as gitignore, so you can use * and **.
41+ # Note: global ignored_paths from serena_config.yml are also applied additively.
3142ignored_paths :
3243- .git
3344- .vs
@@ -43,45 +54,9 @@ ignored_paths:
4354# Added on 2025-04-18
4455read_only : false
4556
46- # list of tool names to exclude. We recommend not excluding any tools, see the readme for more details.
47- # Below is the complete list of tools for convenience.
48- # To make sure you have the latest list of tools, and to view their descriptions,
49- # execute `uv run scripts/print_tool_overview.py`.
50- #
51- # * `activate_project`: Activates a project by name.
52- # * `check_onboarding_performed`: Checks whether project onboarding was already performed.
53- # * `create_text_file`: Creates/overwrites a file in the project directory.
54- # * `delete_lines`: Deletes a range of lines within a file.
55- # * `delete_memory`: Deletes a memory from Serena's project-specific memory store.
56- # * `execute_shell_command`: Executes a shell command.
57- # * `find_referencing_code_snippets`: Finds code snippets in which the symbol at the given location is referenced.
58- # * `find_referencing_symbols`: Finds symbols that reference the symbol at the given location (optionally filtered by type).
59- # * `find_symbol`: Performs a global (or local) search for symbols with/containing a given name/substring (optionally filtered by type).
60- # * `get_current_config`: Prints the current configuration of the agent, including the active and available projects, tools, contexts, and modes.
61- # * `get_symbols_overview`: Gets an overview of the top-level symbols defined in a given file.
62- # * `initial_instructions`: Gets the initial instructions for the current project.
63- # Should only be used in settings where the system prompt cannot be set,
64- # e.g. in clients you have no control over, like Claude Desktop.
65- # * `insert_after_symbol`: Inserts content after the end of the definition of a given symbol.
66- # * `insert_at_line`: Inserts content at a given line in a file.
67- # * `insert_before_symbol`: Inserts content before the beginning of the definition of a given symbol.
68- # * `list_dir`: Lists files and directories in the given directory (optionally with recursion).
69- # * `list_memories`: Lists memories in Serena's project-specific memory store.
70- # * `onboarding`: Performs onboarding (identifying the project structure and essential tasks, e.g. for testing or building).
71- # * `prepare_for_new_conversation`: Provides instructions for preparing for a new conversation (in order to continue with the necessary context).
72- # * `read_file`: Reads a file within the project directory.
73- # * `read_memory`: Reads the memory with the given name from Serena's project-specific memory store.
74- # * `remove_project`: Removes a project from the Serena configuration.
75- # * `replace_lines`: Replaces a range of lines within a file with new content.
76- # * `replace_symbol_body`: Replaces the full definition of a symbol.
77- # * `restart_language_server`: Restarts the language server, may be necessary when edits not through Serena happen.
78- # * `search_for_pattern`: Performs a search for a pattern in the project.
79- # * `summarize_changes`: Provides instructions for summarizing the changes made to the codebase.
80- # * `switch_modes`: Activates modes by providing a list of their names
81- # * `think_about_collected_information`: Thinking tool for pondering the completeness of collected information.
82- # * `think_about_task_adherence`: Thinking tool for determining whether the agent is still on track with the current task.
83- # * `think_about_whether_you_are_done`: Thinking tool for determining whether the task is truly completed.
84- # * `write_memory`: Writes a named memory (for future reference) to Serena's project-specific memory store.
57+ # list of tool names to exclude.
58+ # This extends the existing exclusions (e.g. from the global configuration)
59+ # Find the list of tools here: https://oraios.github.io/serena/01-about/035_tools.html
8560excluded_tools : []
8661
8762# initial prompt for the project. It will always be given to the LLM upon activating the project
@@ -90,7 +65,9 @@ initial_prompt: ""
9065# the name by which the project can be referenced within Serena
9166project_name : " MetaHookSv"
9267
93- # list of tools to include that would otherwise be disabled (particularly optional tools that are disabled by default)
68+ # list of tools to include that would otherwise be disabled (particularly optional tools that are disabled by default).
69+ # This extends the existing inclusions (e.g. from the global configuration).
70+ # Find the list of tools here: https://oraios.github.io/serena/01-about/035_tools.html
9471included_optional_tools : []
9572
9673# list of mode names to that are always to be included in the set of active modes
@@ -101,19 +78,25 @@ included_optional_tools: []
10178# Set this to a list of mode names to always include the respective modes for this project.
10279base_modes :
10380
104- # list of mode names that are to be activated by default.
105- # The full set of modes to be activated is base_modes + default_modes.
106- # If the setting is undefined, the default_modes from the global configuration (serena_config.yml) apply.
81+ # list of mode names that are to be activated by default, overriding the setting in the global configuration .
82+ # The full set of modes to be activated is base_modes (from global config) + default_modes + added_modes .
83+ # If the setting is undefined/empty , the default_modes from the global configuration (serena_config.yml) apply.
10784# Otherwise, this overrides the setting from the global configuration (serena_config.yml).
85+ # Therefore, you can set this to [] if you do not want the default modes defined in the global config to apply
86+ # for this project.
10887# This setting can, in turn, be overridden by CLI parameters (--mode).
88+ # See https://oraios.github.io/serena/02-usage/050_configuration.html#modes
10989default_modes :
11090
11191# fixed set of tools to use as the base tool set (if non-empty), replacing Serena's default set of tools.
11292# This cannot be combined with non-empty excluded_tools or included_optional_tools.
93+ # Find the list of tools here: https://oraios.github.io/serena/01-about/035_tools.html
11394fixed_tools : []
11495
115- # override of the corresponding setting in serena_config.yml, see the documentation there.
116- # If null or missing, the value from the global config is used.
96+ # time budget (seconds) per tool call for the retrieval of additional symbol information
97+ # such as docstrings or parameter information.
98+ # This overrides the corresponding setting in the global configuration; see the documentation there.
99+ # If null or missing, use the setting from the global configuration.
117100symbol_info_budget :
118101
119102# The language backend to use for this project.
@@ -131,3 +114,22 @@ read_only_memory_patterns: []
131114# Possible values: unset (use global setting), "lf", "crlf", or "native" (platform default)
132115# This does not affect Serena's own files (e.g. memories and configuration files), which always use native line endings.
133116line_ending :
117+
118+ # list of regex patterns for memories to completely ignore.
119+ # Matching memories will not appear in list_memories or activate_project output
120+ # and cannot be accessed via read_memory or write_memory.
121+ # To access ignored memory files, use the read_file tool on the raw file path.
122+ # Extends the list from the global configuration, merging the two lists.
123+ # Example: ["_archive/.*", "_episodes/.*"]
124+ ignored_memory_patterns : []
125+
126+ # advanced configuration option allowing to configure language server-specific options.
127+ # Maps the language key to the options.
128+ # 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.
129+ # No documentation on options means no options are available.
130+ ls_specific_settings : {}
131+
132+ # list of mode names to be activated additionally for this project, e.g. ["query-projects"]
133+ # The full set of modes to be activated is base_modes (from global config) + default_modes + added_modes.
134+ # See https://oraios.github.io/serena/02-usage/050_configuration.html#modes
135+ added_modes :
0 commit comments