Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| LOG_LEVEL | No | Logging level (default: INFO) | INFO |
| MAX_DEPTH | No | Maximum directory traversal depth (default: 4) | 4 |
| PROJECT_ROOT | Yes | Default project root directory | |
| MAX_FILE_SIZE | No | Maximum file size in bytes (default: 1MB) | 1048576 |
| OPENAI_API_KEY | No | Your OpenAI API key (required for CLI agent) | |
| ALLOW_EXTERNAL_PATHS | No | Enable access to files outside project root (default: true) | true |
Capabilities
Features and capabilities supported by this server
| Capability | Details |
|---|---|
| tools | {
"listChanged": false
} |
| prompts | {
"listChanged": false
} |
| resources | {
"subscribe": false,
"listChanged": false
} |
| experimental | {} |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| read_file | Reads the content of a text file at the specified path |
| write_file | Writes content to a text file at the specified path |
| edit_file | Edit a file by replacing specific content |
| delete_file | Deletes a file at the specified path |
| move_file | Moves a file from one path to another |
| copy_file | Copies a file from one path to another |
| create_directory | Creates a directory at the specified path (can be absolute or relative to project). |
| list_directory | Lists files and directories at the specified path within the project. |
| delete_directory | Deletes a directory at the specified path within the project. |
| get_directory_tree | Gets the directory tree structure starting from the specified path within the project. |
| search_in_files | Search for text or pattern across project files |
| find_replace | Find and replace text in a single file |
| find_replace_all | Find and replace text across multiple files |
| run_command | Run a shell command in the project directory |
| run_python | Run a Python script or code |
| git | Run git commands |
| git_status | Get git status of the project |
| git_diff | Show git diff |
| git_log | Show git commit history |
| analyze_code | Analyze code file and provide statistics |
| get_functions | Extract function and class definitions from a Python file |
| format_code | Format a Python file using black |
| lint_code | Lint a Python file using ruff or flake8 |
| docker_tool | Run docker commands |
| docker_build_tool | Build Docker image |
| docker_compose_tool | run docker-compose commands |
| http_request_tool | Make HTTP requests to specified URLs |
| curl_tool | Make HTTP requests using curl command |
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
| code_review | Review code and provide detailed feedback |
| quick_code_review | Provide a quick review of the given code snippet |
| debug_error | Help debug an error |
| explain_code | Explain how code works |
| fix_bug | Fix a bug in the code |
| generate_docstring | Generate docstring for a function or class |
| generate_readme | Generate README documentation |
| generate_tests | Generate unit tests for code |
| generate_api_docs | Generate API documentation |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
| Project Structure | Tree view of the project directory structure |
| Project Summary | Summary statistics of the project |
| Project Files List | List of all project files |
| Directory: root | Contents of project root |
| Environment Variables | Environment variables template |
| pyproject | Configuration: pyproject.toml |
| gitignore | Configuration: .gitignore |
| env-example | Configuration: .env.example |
| readme | Configuration: README.md |
| run_cli.py | File: run_cli.py |
| src/client/__init__.py | File: src/client/__init__.py |
| src/client/agents/__init__.py | File: src/client/agents/__init__.py |
| src/client/agents/base_agent.py | File: src/client/agents/base_agent.py |
| src/client/agents/coding_agent.py | File: src/client/agents/coding_agent.py |
| src/client/agents/tool_executor.py | File: src/client/agents/tool_executor.py |
| src/client/llm/__init__.py | File: src/client/llm/__init__.py |
| src/client/llm/base.py | File: src/client/llm/base.py |
| src/client/llm/factory.py | File: src/client/llm/factory.py |
| src/client/llm/openai_llm.py | File: src/client/llm/openai_llm.py |
| src/client/main.py | File: src/client/main.py |
| src/client/session.py | File: src/client/session.py |
| src/client/ui/__init__.py | File: src/client/ui/__init__.py |
| src/client/ui/cli.py | File: src/client/ui/cli.py |
| src/server/__init__.py | File: src/server/__init__.py |
| src/server/config.py | File: src/server/config.py |
| src/server/main.py | File: src/server/main.py |
| src/server/prompts/__init__.py | File: src/server/prompts/__init__.py |
| src/server/prompts/base.py | File: src/server/prompts/base.py |
| src/server/prompts/code_review.py | File: src/server/prompts/code_review.py |
| src/server/prompts/debug.py | File: src/server/prompts/debug.py |
| src/server/prompts/documentation.py | File: src/server/prompts/documentation.py |
| src/server/prompts/refactor.py | File: src/server/prompts/refactor.py |
| src/server/resources/__init__.py | File: src/server/resources/__init__.py |
| src/server/resources/base.py | File: src/server/resources/base.py |
| src/server/resources/config_resources.py | File: src/server/resources/config_resources.py |
| src/server/resources/file_resources.py | File: src/server/resources/file_resources.py |
| src/server/resources/project_resources.py | File: src/server/resources/project_resources.py |
| src/server/tools/__init__.py | File: src/server/tools/__init__.py |
| src/server/tools/base.py | File: src/server/tools/base.py |
| src/server/tools/code_tools.py | File: src/server/tools/code_tools.py |
| src/server/tools/command_tools.py | File: src/server/tools/command_tools.py |
| src/server/tools/directory_tools.py | File: src/server/tools/directory_tools.py |
| src/server/tools/docker_tool.py | File: src/server/tools/docker_tool.py |
| src/server/tools/file_tools.py | File: src/server/tools/file_tools.py |
| src/server/tools/git_tools.py | File: src/server/tools/git_tools.py |
| src/server/tools/http_tools.py | File: src/server/tools/http_tools.py |
| src/server/tools/search_tools.py | File: src/server/tools/search_tools.py |
| src/server/utils/__init__.py | File: src/server/utils/__init__.py |
| src/server/utils/file_utils.py | File: src/server/utils/file_utils.py |
| src/server/utils/mime_types.py | File: src/server/utils/mime_types.py |
| src/server/utils/path_utils.py | File: src/server/utils/path_utils.py |
| src/server/utils/patterns.py | File: src/server/utils/patterns.py |
| src/shared/__init__.py | File: src/shared/__init__.py |
| src/shared/constants.py | File: src/shared/constants.py |
| src/shared/exceptions.py | File: src/shared/exceptions.py |
| src/shared/logger.py | File: src/shared/logger.py |
| src/shared/models.py | File: src/shared/models.py |