From b5a3bb84f90d01701d12791d4860177a3699b3a3 Mon Sep 17 00:00:00 2001 From: Luxferre Date: Mon, 23 Mar 2026 08:44:06 +0200 Subject: [PATCH] upd readme --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index de5f044..77552bf 100644 --- a/README.md +++ b/README.md @@ -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. * **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. -### File Tools +### File tools - `read_file`: Read a file with optional line windowing. - `write_file`: Overwrite a file with new content. - `grep_file`: Regex search with surrounding context. - `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. @@ -163,7 +163,7 @@ user's request and delegate tasks accordingly. * Mouse wheel is also supported. * **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. @@ -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. -### Using the Framework Programmatically +### Using the framework programmatically ```go package main