luxferre/Sidekick
1
0
Fork 0
Code Actions Activity

upd readme

Browse Source
This commit is contained in:
Luxferre
2026-03-23 08:44:06 +02:00
parent f9171e7158
commit b5a3bb84f9
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+5 -5
View File
@@ -20,17 +20,17 @@ Sidekick is a simple but versatile agentic framework written in Go 1.25. It prov
* **Internal Tools:** Built-in tools for file I/O (`read_file`, `write_file`, `grep_file`, `edit_file`) and an optional, secure `shell_exec` tool for running POSIX shell commands. * **Internal Tools:** Built-in tools for file I/O (`read_file`, `write_file`, `grep_file`, `edit_file`) and an optional, secure `shell_exec` tool for running POSIX shell commands.
* **Configuration Driven:** Easily configure models, agents, tools, and MCP servers via a declarative `config.toml` file. * **Configuration Driven:** Easily configure models, agents, tools, and MCP servers via a declarative `config.toml` file.
## Internal Tools ## Internal tools
Sidekick includes a set of internal tools that are always available to agents. These tools provide common file operations and system access. Sidekick includes a set of internal tools that are always available to agents. These tools provide common file operations and system access.
### File Tools ### File tools
- `read_file`: Read a file with optional line windowing. - `read_file`: Read a file with optional line windowing.
- `write_file`: Overwrite a file with new content. - `write_file`: Overwrite a file with new content.
- `grep_file`: Regex search with surrounding context. - `grep_file`: Regex search with surrounding context.
- `edit_file`: Replace a string or block of lines in a file. - `edit_file`: Replace a string or block of lines in a file.
### shell_exec Tool ### shell_exec tool
The `shell_exec` tool allows an agent to run arbitrary POSIX shell commands and receive combined stdout/stderr output. The `shell_exec` tool allows an agent to run arbitrary POSIX shell commands and receive combined stdout/stderr output.
@@ -163,7 +163,7 @@ user's request and delegate tasks accordingly.
* Mouse wheel is also supported. * Mouse wheel is also supported.
* **Quit:** Press `Ctrl+C` or `Esc` to exit. * **Quit:** Press `Ctrl+C` or `Esc` to exit.
### Running the Sidekick MCP Server ### Running the Sidekick MCP server
Sidekick can also act as an MCP server, allowing other LLM-powered applications to leverage its agentic capabilities. Sidekick can also act as an MCP server, allowing other LLM-powered applications to leverage its agentic capabilities.
@@ -183,7 +183,7 @@ port = 8080 # for sse/http
The server provides a `query` tool that routes requests to your coordinator agent, maintaining conversation history if provided. The server provides a `query` tool that routes requests to your coordinator agent, maintaining conversation history if provided.
### Using the Framework Programmatically ### Using the framework programmatically
```go ```go
package main package main