project.yml 4.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768
  1. # language of the project (csharp, python, rust, java, typescript, go, cpp, or ruby)
  2. # * For C, use cpp
  3. # * For JavaScript, use typescript
  4. # Special requirements:
  5. # * csharp: Requires the presence of a .sln file in the project folder.
  6. language: php
  7. # whether to use the project's gitignore file to ignore files
  8. # Added on 2025-04-07
  9. ignore_all_files_in_gitignore: true
  10. # list of additional paths to ignore
  11. # same syntax as gitignore, so you can use * and **
  12. # Was previously called `ignored_dirs`, please update your config if you are using that.
  13. # Added (renamed) on 2025-04-07
  14. ignored_paths: []
  15. # whether the project is in read-only mode
  16. # If set to true, all editing tools will be disabled and attempts to use them will result in an error
  17. # Added on 2025-04-18
  18. read_only: false
  19. # list of tool names to exclude. We recommend not excluding any tools, see the readme for more details.
  20. # Below is the complete list of tools for convenience.
  21. # To make sure you have the latest list of tools, and to view their descriptions,
  22. # execute `uv run scripts/print_tool_overview.py`.
  23. #
  24. # * `activate_project`: Activates a project by name.
  25. # * `check_onboarding_performed`: Checks whether project onboarding was already performed.
  26. # * `create_text_file`: Creates/overwrites a file in the project directory.
  27. # * `delete_lines`: Deletes a range of lines within a file.
  28. # * `delete_memory`: Deletes a memory from Serena's project-specific memory store.
  29. # * `execute_shell_command`: Executes a shell command.
  30. # * `find_referencing_code_snippets`: Finds code snippets in which the symbol at the given location is referenced.
  31. # * `find_referencing_symbols`: Finds symbols that reference the symbol at the given location (optionally filtered by type).
  32. # * `find_symbol`: Performs a global (or local) search for symbols with/containing a given name/substring (optionally filtered by type).
  33. # * `get_current_config`: Prints the current configuration of the agent, including the active and available projects, tools, contexts, and modes.
  34. # * `get_symbols_overview`: Gets an overview of the top-level symbols defined in a given file.
  35. # * `initial_instructions`: Gets the initial instructions for the current project.
  36. # Should only be used in settings where the system prompt cannot be set,
  37. # e.g. in clients you have no control over, like Claude Desktop.
  38. # * `insert_after_symbol`: Inserts content after the end of the definition of a given symbol.
  39. # * `insert_at_line`: Inserts content at a given line in a file.
  40. # * `insert_before_symbol`: Inserts content before the beginning of the definition of a given symbol.
  41. # * `list_dir`: Lists files and directories in the given directory (optionally with recursion).
  42. # * `list_memories`: Lists memories in Serena's project-specific memory store.
  43. # * `onboarding`: Performs onboarding (identifying the project structure and essential tasks, e.g. for testing or building).
  44. # * `prepare_for_new_conversation`: Provides instructions for preparing for a new conversation (in order to continue with the necessary context).
  45. # * `read_file`: Reads a file within the project directory.
  46. # * `read_memory`: Reads the memory with the given name from Serena's project-specific memory store.
  47. # * `remove_project`: Removes a project from the Serena configuration.
  48. # * `replace_lines`: Replaces a range of lines within a file with new content.
  49. # * `replace_symbol_body`: Replaces the full definition of a symbol.
  50. # * `restart_language_server`: Restarts the language server, may be necessary when edits not through Serena happen.
  51. # * `search_for_pattern`: Performs a search for a pattern in the project.
  52. # * `summarize_changes`: Provides instructions for summarizing the changes made to the codebase.
  53. # * `switch_modes`: Activates modes by providing a list of their names
  54. # * `think_about_collected_information`: Thinking tool for pondering the completeness of collected information.
  55. # * `think_about_task_adherence`: Thinking tool for determining whether the agent is still on track with the current task.
  56. # * `think_about_whether_you_are_done`: Thinking tool for determining whether the task is truly completed.
  57. # * `write_memory`: Writes a named memory (for future reference) to Serena's project-specific memory store.
  58. excluded_tools: []
  59. # initial prompt for the project. It will always be given to the LLM upon activating the project
  60. # (contrary to the memories, which are loaded on demand).
  61. initial_prompt: ""
  62. project_name: "merchant_admin"