Skip to content

Commit 4eb368e

Browse files
ericdalloericdallo
committed
docs: improve features.md
1 parent 8b97018 commit 4eb368e

File tree

3 files changed

+38
-35
lines changed

3 files changed

+38
-35
lines changed

‎docs/features.md‎

Lines changed: 30 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -6,65 +6,67 @@ Chat is the main feature of ECA, allowing user to talk with LLM to behave like a
66

77
### Behaviors
88

9-
![](./images/features/chat-behaviors.png)
9+
![behaviors](./images/features/chat-behaviors.png){ align=right }
1010

1111
Behavior affect the prompt passed to LLM and the tools to include, ECA allow to override or __create your owns behaviors__, the built-in provider behaviors are:
1212

13-
- `plan`: Useful to plan changes and define better LLM plan before changing code via agent mode, has ability to preview changes (Check picture). [Prompt here](https://github.com/editor-code-assistant/eca/blob/master/resources/prompts/plan_behavior.md)
1413
- `agent`: Make changes to code via file changing tools. (Default) [Prompt here](https://github.com/editor-code-assistant/eca/blob/master/resources/prompts/agent_behavior.md)
14+
- `plan`: Useful to plan changes and define better LLM plan before changing code via agent mode, has ability to preview changes (Check below). [Prompt here](https://github.com/editor-code-assistant/eca/blob/master/resources/prompts/plan_behavior.md)
1515

1616
![](./images/features/plan_preview_change.png)
1717

18-
To create and customize your own behaviors, check [config](./configuration.md#).
18+
!!! info "Custom behaviors"
19+
20+
To create and customize your own behaviors, check the [config](./configuration.md#).
1921

2022
### Tools
2123

22-
![](./images/features/tools.png)
24+
![](./images/features/tools.png){ align=right }
2325

2426
ECA leverage tools to give more power to the LLM, this is the best way to make LLMs have more context about your codebase and behave like an agent.
2527
It supports both MCP server tools + ECA native tools.
2628

2729
!!! info "Approval / permissions"
2830

29-
By default, ECA ask to approve any tool, you can easily configure that, check `toolCall approval` [config](./configuration.md) or try the `plan` behavior.
31+
By default, ECA ask to approve all non-read only tools or mcp tools, you can easily configure that, check `toolCall approval` [config](./configuration.md) or try the `plan` behavior.
3032

3133
#### Native tools
3234

3335
ECA support built-in tools to avoid user extra installation and configuration, these tools are always included on models requests that support tools and can be [disabled via config](./configuration.md) `disabledTools`.
3436

35-
##### Filesystem
37+
=== "Filesystem"
3638

37-
Provides access to filesystem under workspace root, listing, reading and writing files, important for agentic operations.
39+
Provides access to filesystem under workspace root, listing, reading and writing files, important for agentic operations.
3840

39-
- `eca_directory_tree`: list a directory as a tree (can be recursive).
40-
- `eca_read_file`: read a file content.
41-
- `eca_write_file`: write content to a new file.
42-
- `eca_edit_file`: replace lines of a file with a new content.
43-
- `eca_preview_edit_file`: Only used in plan mode, showing what changes will happen after user decides to execute the plan.
44-
- `eca_move_file`: move/rename a file.
45-
- `eca_grep`: ripgrep/grep for paths with specified content.
41+
- `eca_directory_tree`: list a directory as a tree (can be recursive).
42+
- `eca_read_file`: read a file content.
43+
- `eca_write_file`: write content to a new file.
44+
- `eca_edit_file`: replace lines of a file with a new content.
45+
- `eca_preview_edit_file`: Only used in plan mode, showing what changes will happen after user decides to execute the plan.
46+
- `eca_move_file`: move/rename a file.
47+
- `eca_grep`: ripgrep/grep for paths with specified content.
4648

47-
##### Shell
49+
=== "Shell"
4850

49-
Provides access to run shell commands, useful to run build tools, tests, and other common commands, supports exclude/include commands.
51+
Provides access to run shell commands, useful to run build tools, tests, and other common commands, supports exclude/include commands.
5052

51-
- `eca_shell_command`: run shell command. Command exclusion can be configured using toolCall approval configuration with regex patterns.
53+
- `eca_shell_command`: run shell command. Command exclusion can be configured using toolCall approval configuration with regex patterns.
5254

53-
##### Editor
55+
=== "Editor"
5456

55-
Provides access to get information from editor workspaces.
57+
Provides access to get information from editor workspaces.
5658

57-
- `eca_editor_diagnostics`: Ask client about the diagnostics (like LSP diagnostics).
59+
- `eca_editor_diagnostics`: Ask client about the diagnostics (like LSP diagnostics).
5860

59-
#### Custom Tools
61+
!!! info "Custom Tools"
6062

61-
Besides the built-in native tools, ECA allows you to define your own tools by wrapping any command-line executable. This feature enables you to extend ECA's capabilities to match your specific workflows, such as running custom scripts, interacting with internal services, or using your favorite CLI tools.
63+
Besides the built-in native tools, ECA allows you to define your own tools by wrapping any command-line executable. This feature enables you to extend ECA's capabilities to match your specific workflows, such as running custom scripts, interacting with internal services, or using your favorite CLI tools.
6264

63-
Custom tools are configured in your `config.json` file. For a detailed guide on how to set them up, check the [Custom Tools configuration documentation](./configuration.md#custom-tools).
65+
Custom tools are configured in your `config.json` file. For a detailed guide on how to set them up, check the [Custom Tools configuration documentation](./configuration.md#custom-tools).
6466

6567
### Contexts
6668

67-
![](./images/features/contexts.png)
69+
![](./images/features/contexts.png){ align=right }
6870

6971
ECA supports contexts (`@`) and files (`#`), including images and MCP resources, which can help LLM generate output with better quality.
7072
Here are the current supported contexts types:
@@ -107,9 +109,9 @@ The built-in commands are:
107109
- `/repo-map-show`: Show the current repoMap context of the session.
108110
- `/prompt-show`: Show the final prompt sent to LLM with all contexts and ECA details.
109111

110-
#### Custom commands
112+
!!! info "Custom commands"
111113

112-
It's possible to configure custom command prompts, for more details check [its configuration](./configuration.md#custom-command-prompts)
114+
It's possible to configure custom command prompts, for more details check [its configuration](./configuration.md#custom-command-prompts)
113115

114116
#### Login
115117

@@ -126,13 +128,13 @@ Hooks are actions that can run before or after an specific event, useful to noti
126128

127129
![](./images/features/hooks.png)
128130

129-
For more details, check [hooks configuration](./configuration.md#hooks)
131+
For more details, check [hooks configuration](./configuration.md#hooks).
130132

131133
## OpenTelemetry integration
132134

133135
ECA has support for [OpenTelemetry](https://opentelemetry.io/)(otlp), if configured, server tasks, tool calls, and more will be metrified via otlp API.
134136

135-
For more details check [its configuration](./configuration.md#opentelemetry-integration)
137+
For more details check [its configuration](./configuration.md#opentelemetry-integration).
136138

137139
## Completion
138140

‎docs/models.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,13 @@ ECA will return to clients the models configured, either via config or login.
1010

1111
## Built-in providers and capabilities
1212

13-
| model | tools (MCP) | reasoning / thinking | prompt caching | web_search | image_input |
14-
|-------------------------------|-------------|----------------------|----------------|------------|-------------|
15-
| OpenAI | √ | √ | √ | √ | √ |
16-
| Anthropic (Also subscription) | √ | √ | √ | √ | √ |
17-
| Github Copilot | √ | √ | √ | X | √ |
18-
| Google | √ | √ | √ | X | √ |
19-
| Ollama local models | √ | √ | X | X | |
13+
| model | tools (MCP) | reasoning / thinking | prompt caching | web_search | image_input |
14+
|--------------------------------------------------|-------------|----------------------|----------------|------------|-------------|
15+
| :simple-openai: OpenAI | √ | √ | √ | √ | √ |
16+
| :simple-anthropic: Anthropic (Also subscription) | √ | √ | √ | √ | √ |
17+
| :simple-githubcopilot: Github Copilot | √ | √ | √ | X | √ |
18+
| :simple-googlegemini: Google | √ | √ | √ | X | √ |
19+
| :simple-ollama: Ollama local models | √ | √ | X | X | |
2020

2121
### Config
2222

‎mkdocs.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ markdown_extensions:
5252
- toc:
5353
permalink: '#'
5454
- admonition
55+
- attr_list
5556
- pymdownx.details
5657
- pymdownx.emoji:
5758
emoji_index: !!python/name:materialx.emoji.twemoji

0 commit comments

Comments
 (0)