Download tools/server/server-tools.cpp from Brunobkr/llama.cpp_AlgMor24_github: direct link, hf CLI and curl.
- Browser
- Download file 88.4 kB
-
https://huggingface.co/datasets/Brunobkr/llama.cpp_AlgMor24_github/resolve/9f63da05cd17e144eb118af61a784286378961ba/tools/server/server-tools.cpp
- Command line
-
hf download hf://datasets/Brunobkr/llama.cpp_AlgMor24_github@9f63da05cd17e144eb118af61a784286378961ba/tools/server/server-tools.cpp
-
curl -L -o server-tools.cpp https://huggingface.co/datasets/Brunobkr/llama.cpp_AlgMor24_github/resolve/9f63da05cd17e144eb118af61a784286378961ba/tools/server/server-tools.cpp
88.4 kB
| namespace fs = std::filesystem; | |
| // | |
| // internal helpers | |
| // | |
| // a child process writes in the OEM code page, so accented output would reach | |
| // the JSON layer as invalid bytes. run() spawns without a console, so the | |
| // console code page never applies | |
| static std::string console_output_to_utf8(const std::string & text) { | |
| // a chunk can end mid sequence, so the incomplete tail is dropped first | |
| if (text.empty() || is_valid_utf8(text.substr(0, validate_utf8(text)))) { | |
| // never decode twice a child that already emits UTF-8 | |
| return text; | |
| } | |
| const UINT cp = GetOEMCP(); | |
| // fail rather than emit replacement characters when the code page is wrong | |
| const int wide_len = MultiByteToWideChar(cp, MB_ERR_INVALID_CHARS, text.data(), (int) text.size(), nullptr, 0); | |
| if (wide_len <= 0) { | |
| return text; | |
| } | |
| std::wstring wide(wide_len, L'\0'); | |
| MultiByteToWideChar(cp, MB_ERR_INVALID_CHARS, text.data(), (int) text.size(), wide.data(), wide_len); | |
| const int utf8_len = WideCharToMultiByte(CP_UTF8, 0, wide.data(), wide_len, nullptr, 0, nullptr, nullptr); | |
| if (utf8_len <= 0) { | |
| return text; | |
| } | |
| std::string utf8(utf8_len, '\0'); | |
| WideCharToMultiByte(CP_UTF8, 0, wide.data(), wide_len, utf8.data(), utf8_len, nullptr, nullptr); | |
| return utf8; | |
| return text; | |
| } | |
| json server_tool::to_json() const { | |
| return { | |
| {"display_name", display_name}, | |
| {"tool", name}, | |
| {"type", type()}, | |
| {"permissions", json{ | |
| {"write", permission_write} | |
| }}, | |
| {"uses_cwd", uses_cwd}, | |
| {"definition", get_definition()}, | |
| }; | |
| } | |
| static constexpr size_t SERVER_TOOL_GIT_LS_FILES_MAX_OUTPUT = 8 * 1024 * 1024; // 8 MB | |
| // budget for one listing call, shared by the git and walker paths | |
| static constexpr int SERVER_TOOL_LIST_ENTRIES_TIMEOUT = 15; // seconds | |
| // entry kinds a directory listing may return | |
| enum class list_kind { | |
| files, // regular files only | |
| dirs, // directories only | |
| all, // both | |
| }; | |
| // a narrow path uses the active code page on Windows, so every crossing between | |
| // a std::string (always UTF-8 here) and fs::path is converted explicitly | |
| static fs::path path_from_utf8(const std::string & s) { | |
| return fs::u8path(s); | |
| } | |
| // '/' separators on every platform: Windows accepts them, the web UI needs them | |
| static std::string path_to_utf8(const fs::path & p) { | |
| const auto s = p.generic_u8string(); | |
| return std::string(s.begin(), s.end()); | |
| } | |
| // home directory, read once at first use (getenv is not thread safe against setenv) | |
| static const std::string & home_dir() { | |
| static const std::string home = [] { | |
| // the narrow getenv would return the profile path in the active code page | |
| const wchar_t * w = _wgetenv(L"HOME"); | |
| if (w == nullptr) w = _wgetenv(L"USERPROFILE"); | |
| return w ? path_to_utf8(fs::path(w)) : std::string(); | |
| const char * h = getenv("HOME"); | |
| return h ? std::string(h) : std::string(); | |
| }(); | |
| return home; | |
| } | |
| static std::string expand_home(const std::string & path) { | |
| if (path.empty() || path[0] != '~') return path; | |
| if (path.size() > 1 && path[1] != '/' && path[1] != '\\') return path; | |
| const std::string & home = home_dir(); | |
| if (home.empty()) return path; | |
| return home + path.substr(1); | |
| } | |
| // depth of a '/'-separated relative path: "a/b/c" is 3 | |
| static int entry_depth(const std::string & rel) { | |
| return 1 + (int) std::count(rel.begin(), rel.end(), '/'); | |
| } | |
| // directories that a listing reports but never descends into: they can be enormous | |
| // lowercase only, the local walker case-folds a name before the lookup | |
| static const char * const SERVER_TOOL_JUNK_DIR_NAMES[] = { | |
| ".git", ".svn", ".hg", "node_modules", "__pycache__", | |
| ".venv", "venv", "dist", "build", "target", ".cache", ".idea", ".vscode", | |
| }; | |
| class tools_io { | |
| public: | |
| struct exec_result { | |
| std::string output; | |
| int exit_code = -1; | |
| bool timed_out = false; | |
| }; | |
| virtual ~tools_io() = default; | |
| virtual bool is_directory(const std::string & path) const = 0; | |
| virtual bool is_regular_file(const std::string & path) const = 0; | |
| virtual bool file_size(const std::string & path, uintmax_t & out_size) const = 0; | |
| virtual bool read_file(const std::string & path, std::string & out) const = 0; | |
| virtual bool write_file(const std::string & path, const std::string & content) const = 0; | |
| // resolve `path` against the IO's working directory; absolute paths are returned unchanged | |
| virtual std::string resolve(const std::string & path) const = 0; | |
| struct list_entry { | |
| std::string rel; // '/'-separated, relative to `base` | |
| bool is_dir = false; | |
| }; | |
| struct list_result { | |
| std::vector<list_entry> entries; | |
| std::string err; // set when `base` is not a directory | |
| bool truncated = false; // set when the walk could not see everything | |
| }; | |
| // entries relative to `base`, which must already be resolved (absolute) | |
| // max_depth == 0 means unlimited, 1 means direct children of `base` only | |
| virtual list_result list_entries(const std::string & base, int max_depth, list_kind kind) const = 0; | |
| // on_chunk, if set, is called with each chunk of output as it is read (before truncation cuts in); | |
| // returning false terminates the process early (e.g. the client disconnected) | |
| virtual exec_result run( | |
| const std::vector<std::string> & args, | |
| size_t max_output, | |
| int timeout_secs, | |
| const std::function<bool(const std::string &)> & on_chunk = nullptr) const = 0; | |
| }; | |
| // shared subprocess execution helper, used by both the local and the isolate-backed tools_io implementations. | |
| // combine_stderr=false when the raw stdout bytes must not be tainted by stderr, e.g. reading file contents. | |
| static tools_io::exec_result run_subprocess( | |
| const std::vector<std::string> & args, | |
| size_t max_output, | |
| int timeout_secs, | |
| const std::function<bool(const std::string &)> & on_chunk, | |
| bool combine_stderr, | |
| const std::string & cwd = "", | |
| const std::string * stdin_data = nullptr) { | |
| tools_io::exec_result res; | |
| common_subproc proc; | |
| int options = subprocess_option_no_window | |
| | subprocess_option_inherit_environment | |
| | subprocess_option_search_user_path; | |
| if (combine_stderr) { | |
| options |= subprocess_option_combined_stdout_stderr; | |
| } | |
| if (!proc.create(args, options, {}, cwd.empty() ? nullptr : cwd.c_str())) { | |
| res.output = "failed to spawn process"; | |
| return res; | |
| } | |
| std::atomic<bool> done{false}; | |
| std::atomic<bool> timed_out{false}; | |
| std::thread timeout_thread([&]() { | |
| auto deadline = std::chrono::steady_clock::now() + std::chrono::seconds(timeout_secs); | |
| while (!done.load()) { | |
| if (std::chrono::steady_clock::now() >= deadline) { | |
| timed_out.store(true); | |
| proc.terminate(); | |
| return; | |
| } | |
| std::this_thread::sleep_for(std::chrono::milliseconds(100)); | |
| } | |
| }); | |
| // write stdin before reading stdout, the child drains stdin as it goes | |
| // always close stdin, a transport client waits forever if its stdin pipe stays open | |
| if (FILE * in = proc.stdin_file()) { | |
| if (stdin_data != nullptr && !stdin_data->empty()) { | |
| // pipe fds default to CRT text mode: binary keeps the bytes untranslated | |
| _setmode(_fileno(in), _O_BINARY); | |
| // a short write is not an error by itself, the exit code below decides | |
| fwrite(stdin_data->data(), 1, stdin_data->size(), in); | |
| } | |
| fflush(in); | |
| } | |
| proc.close_stdin(); | |
| FILE * f = proc.stdout_file(); | |
| std::string output; | |
| bool truncated = false; | |
| if (f) { | |
| // pipe fds default to CRT text mode: binary keeps the bytes untranslated | |
| _setmode(_fileno(f), _O_BINARY); | |
| // read raw bytes, not lines: the output can hold NUL and must arrive as soon as it is ready | |
| // keep draining past the size cap, else the child blocks on a full pipe | |
| char buf[4096]; | |
| for (;;) { | |
| const int n = _read(_fileno(f), buf, (unsigned) sizeof(buf)); | |
| ssize_t n = read(fileno(f), buf, sizeof(buf)); | |
| while (n < 0 && errno == EINTR) { | |
| n = read(fileno(f), buf, sizeof(buf)); | |
| } | |
| if (n <= 0) { | |
| break; | |
| } | |
| if (truncated) { | |
| continue; | |
| } | |
| const size_t len = (size_t) n; | |
| if (output.size() + len <= max_output) { | |
| output.append(buf, len); | |
| if (on_chunk && !on_chunk(console_output_to_utf8(std::string(buf, len)))) { | |
| proc.terminate(); | |
| break; | |
| } | |
| } else { | |
| size_t remaining = max_output - output.size(); | |
| output.append(buf, remaining); | |
| if (on_chunk && remaining > 0) on_chunk(console_output_to_utf8(std::string(buf, remaining))); | |
| truncated = true; | |
| } | |
| } | |
| } | |
| done.store(true); | |
| if (timeout_thread.joinable()) { | |
| timeout_thread.join(); | |
| } | |
| res.exit_code = proc.join(); | |
| res.output = console_output_to_utf8(output); | |
| res.timed_out = timed_out.load(); | |
| if (truncated) { | |
| res.output += "\n[output truncated]"; | |
| } | |
| return res; | |
| } | |
| class tools_io_basic : public tools_io { | |
| public: | |
| // cwd, if non-empty, is used to resolve relative paths and as the working directory for run() | |
| explicit tools_io_basic(std::string cwd = "") : cwd(std::move(cwd)) {} | |
| // expands a leading `~`, then resolves `path` against `cwd` (or the server | |
| // working directory when `cwd` is unset); the result is always absolute | |
| std::string resolve(const std::string & path) const override { | |
| const std::string p = expand_home(path); | |
| fs::path full = path_from_utf8(p); | |
| if (!full.is_absolute()) { | |
| if (cwd.empty()) { | |
| std::error_code ec; | |
| const fs::path cur = fs::current_path(ec); | |
| if (ec) return p; | |
| full = cur / full; | |
| } else { | |
| full = path_from_utf8(cwd) / full; | |
| } | |
| } | |
| // drop "." and ".." so they never reach git or the client | |
| full = full.lexically_normal(); | |
| // a trailing ".." normalizes to a path that ends with a separator | |
| if (!full.has_filename() && full != full.root_path()) { | |
| full = full.parent_path(); | |
| } | |
| return path_to_utf8(full); | |
| } | |
| bool is_directory(const std::string & path) const override { | |
| std::error_code ec; | |
| return fs::is_directory(path_from_utf8(resolve(path)), ec) && !ec; | |
| } | |
| bool is_regular_file(const std::string & path) const override { | |
| std::error_code ec; | |
| return fs::is_regular_file(path_from_utf8(resolve(path)), ec) && !ec; | |
| } | |
| bool file_size(const std::string & path, uintmax_t & out_size) const override { | |
| std::error_code ec; | |
| out_size = fs::file_size(path_from_utf8(resolve(path)), ec); | |
| return !ec; | |
| } | |
| bool read_file(const std::string & path, std::string & out) const override { | |
| std::ifstream f(path_from_utf8(resolve(path)), std::ios::binary); | |
| if (!f) return false; | |
| std::ostringstream ss; | |
| ss << f.rdbuf(); | |
| out = ss.str(); | |
| return true; | |
| } | |
| bool write_file(const std::string & path, const std::string & content) const override { | |
| std::error_code ec; | |
| fs::path fpath = path_from_utf8(resolve(path)); | |
| if (fpath.has_parent_path()) { | |
| fs::create_directories(fpath.parent_path(), ec); | |
| if (ec) return false; | |
| } | |
| std::ofstream f(fpath, std::ios::binary); | |
| if (!f) return false; | |
| f << content; | |
| return (bool) f; | |
| } | |
| list_result list_entries(const std::string & base, int max_depth, list_kind kind) const override { | |
| list_result out; | |
| std::error_code ec; | |
| if (!fs::is_directory(base, ec) || ec) { | |
| out.err = "path does not exist or is not a directory"; | |
| return out; | |
| } | |
| const auto deadline = std::chrono::steady_clock::now() + std::chrono::seconds(SERVER_TOOL_LIST_ENTRIES_TIMEOUT); | |
| // git ls-files cannot list directories; use the walker when they are requested | |
| if (kind == list_kind::files) { | |
| auto res = run( | |
| {"git", "-C", base, "ls-files", "--cached", "--others", "--exclude-standard"}, | |
| SERVER_TOOL_GIT_LS_FILES_MAX_OUTPUT, SERVER_TOOL_LIST_ENTRIES_TIMEOUT); | |
| if (res.exit_code == 0 && !res.timed_out) { | |
| std::istringstream iss(res.output); | |
| std::string line; | |
| while (std::getline(iss, line)) { | |
| if (!line.empty() && line.back() == '\r') line.pop_back(); | |
| if (line.empty()) continue; | |
| std::replace(line.begin(), line.end(), '\\', '/'); | |
| if (max_depth > 0 && entry_depth(line) > max_depth) continue; | |
| if (is_regular_file(path_to_utf8(path_from_utf8(base) / path_from_utf8(line)))) { | |
| out.entries.push_back({line, false}); | |
| } | |
| } | |
| return out; | |
| } | |
| } | |
| out.entries = list_entries_fallback(base, max_depth, kind, deadline, out.truncated); | |
| return out; | |
| } | |
| exec_result run( | |
| const std::vector<std::string> & args, | |
| size_t max_output, | |
| int timeout_secs, | |
| const std::function<bool(const std::string &)> & on_chunk = nullptr) const override { | |
| return run_subprocess(args, max_output, timeout_secs, on_chunk, /*combine_stderr=*/true, cwd); | |
| } | |
| private: | |
| std::string cwd; | |
| // a link can point back to an ancestor and loop forever, so it is never walked | |
| static bool is_link(const fs::directory_entry & entry) { | |
| std::error_code ec; | |
| if (entry.is_symlink(ec) || ec) { | |
| return true; | |
| } | |
| // a junction looks like a plain directory to std::filesystem, so read the reparse tag | |
| WIN32_FIND_DATAW data; | |
| const HANDLE h = FindFirstFileW(entry.path().c_str(), &data); | |
| if (h == INVALID_HANDLE_VALUE) { | |
| return false; | |
| } | |
| FindClose(h); | |
| if ((data.dwFileAttributes & FILE_ATTRIBUTE_REPARSE_POINT) == 0) { | |
| return false; | |
| } | |
| // other reparse points (cloud placeholder, dedup stub) are real directories | |
| return data.dwReserved0 == IO_REPARSE_TAG_SYMLINK || data.dwReserved0 == IO_REPARSE_TAG_MOUNT_POINT; | |
| return false; | |
| } | |
| // NTFS is case insensitive, so Build and build are the same directory | |
| static std::string get_effective_name(const std::string & fname) { | |
| std::string lowered = fname; | |
| std::transform(lowered.begin(), lowered.end(), lowered.begin(), | |
| [](unsigned char c) { return (char) std::tolower(c); }); | |
| return lowered; | |
| return fname; | |
| } | |
| static const std::unordered_set<std::string> & junk_dir_names() { | |
| static const std::unordered_set<std::string> names( | |
| std::begin(SERVER_TOOL_JUNK_DIR_NAMES), std::end(SERVER_TOOL_JUNK_DIR_NAMES)); | |
| return names; | |
| } | |
| std::vector<list_entry> list_entries_fallback(const std::string & base, int max_depth, list_kind kind, | |
| std::chrono::steady_clock::time_point deadline, bool & truncated) const { | |
| std::vector<list_entry> result; | |
| std::vector<std::tuple<fs::path, fs::path, int>> stack; | |
| stack.emplace_back(path_from_utf8(base), fs::path(), 0); | |
| while (!stack.empty()) { | |
| if (std::chrono::steady_clock::now() >= deadline) { | |
| truncated = true; | |
| return result; | |
| } | |
| auto [dir, rel_dir, depth] = std::move(stack.back()); | |
| stack.pop_back(); | |
| std::error_code ec; | |
| // step the iterator by hand: the throwing increment escapes on a directory that goes away | |
| fs::directory_iterator it(dir, fs::directory_options::skip_permission_denied, ec); | |
| // permission errors are skipped above, so this is a subtree the caller never sees | |
| if (ec) { | |
| truncated = true; | |
| continue; | |
| } | |
| for (const fs::directory_iterator end; it != end; it.increment(ec)) { | |
| if (ec) { | |
| truncated = true; | |
| break; | |
| } | |
| if (std::chrono::steady_clock::now() >= deadline) { | |
| truncated = true; | |
| return result; | |
| } | |
| const fs::directory_entry & entry = *it; | |
| const fs::path fname = entry.path().filename(); | |
| std::error_code tec; | |
| const bool is_dir = entry.is_directory(tec); | |
| if (tec) continue; | |
| if (is_dir) { | |
| if (kind == list_kind::dirs || kind == list_kind::all) { | |
| result.push_back({path_to_utf8(rel_dir / fname), true}); | |
| } | |
| // junk directories stay selectable but are never walked: they can be enormous | |
| if (junk_dir_names().count(get_effective_name(path_to_utf8(fname))) > 0) continue; | |
| if (!is_link(entry) && (max_depth == 0 || depth + 1 < max_depth)) { | |
| stack.emplace_back(entry.path(), rel_dir / fname, depth + 1); | |
| } | |
| } else if (entry.is_regular_file(tec)) { | |
| if (kind == list_kind::files || kind == list_kind::all) { | |
| result.push_back({path_to_utf8(rel_dir / fname), false}); | |
| } | |
| } | |
| } | |
| } | |
| return result; | |
| } | |
| }; | |
| // timeout for auxiliary isolate calls (stat/mkdir/ls helpers); exec_shell_command uses its own | |
| // caller-controlled timeout instead, enforced separately in run() | |
| static constexpr int SERVER_TOOL_ISOLATE_EXEC_TIMEOUT = 15; // seconds | |
| static constexpr size_t SERVER_TOOL_ISOLATE_READ_FILE_MAX_SIZE = 64 * 1024 * 1024; // 64 MB | |
| // runs every tools_io operation as a command inside an isolate: a container, a remote host, ... | |
| // the isolate is created, mounted, and torn down externally by the caller | |
| // it must provide a POSIX environment: sh, cat, wc, mkdir, dirname, find, timeout | |
| class tools_io_isolate : public tools_io { | |
| public: | |
| // cwd, if non-empty, is used to resolve relative paths and as the working directory for run() | |
| explicit tools_io_isolate(std::string cwd = "") : cwd(std::move(cwd)) {} | |
| // resolves `path` against `cwd` if `path` is relative and `cwd` is set; otherwise returns `path` unchanged. | |
| // isolate paths are always POSIX-style ('/'), regardless of host OS. | |
| std::string resolve(const std::string & path) const override { | |
| if (cwd.empty() || (!path.empty() && path[0] == '/')) { | |
| return path; | |
| } | |
| return cwd + "/" + path; | |
| } | |
| bool is_directory(const std::string & path) const override { | |
| return shell_test("-d", resolve(path)); | |
| } | |
| bool is_regular_file(const std::string & path) const override { | |
| return shell_test("-f", resolve(path)); | |
| } | |
| bool file_size(const std::string & path, uintmax_t & out_size) const override { | |
| auto res = exec({"sh", "-c", "wc -c < \"$1\"", "_", resolve(path)}, 64, true); | |
| if (res.exit_code != 0 || res.timed_out) return false; | |
| try { | |
| size_t pos; | |
| out_size = (uintmax_t) std::stoull(res.output, &pos); | |
| } catch (...) { | |
| return false; | |
| } | |
| return true; | |
| } | |
| bool read_file(const std::string & path, std::string & out) const override { | |
| // combine_stderr=false: stderr must not be spliced into raw file bytes | |
| auto res = exec({"cat", "--", resolve(path)}, SERVER_TOOL_ISOLATE_READ_FILE_MAX_SIZE, false); | |
| if (res.exit_code != 0 || res.timed_out) return false; | |
| out = res.output; | |
| return true; | |
| } | |
| bool write_file(const std::string & path, const std::string & content) const override { | |
| // the content travels on stdin: no argv for the far side to re-parse, no temp file on the host | |
| auto res = run_subprocess( | |
| build_argv({"sh", "-c", "mkdir -p \"$(dirname \"$1\")\" && cat > \"$1\"", "_", resolve(path)}, | |
| /*needs_stdin=*/true), | |
| 4096, SERVER_TOOL_ISOLATE_EXEC_TIMEOUT, nullptr, true, "", &content); | |
| return res.exit_code == 0 && !res.timed_out; | |
| } | |
| list_result list_entries(const std::string & base, int max_depth, list_kind kind) const override { | |
| list_result out; | |
| const std::string abs_base = resolve(base); | |
| if (!is_directory(base)) { | |
| out.err = "path does not exist or is not a directory"; | |
| return out; | |
| } | |
| // git ls-files cannot list directories; use the walker when they are requested | |
| if (kind == list_kind::files) { | |
| auto res = exec( | |
| {"sh", "-c", "cd \"$1\" && git ls-files --cached --others --exclude-standard", "_", abs_base}, | |
| SERVER_TOOL_GIT_LS_FILES_MAX_OUTPUT, true); | |
| if (res.exit_code == 0 && !res.timed_out) { | |
| for (const auto & rel : split_lines(res.output, /*strip_dot_slash=*/false)) { | |
| if (max_depth > 0 && entry_depth(rel) > max_depth) continue; | |
| out.entries.push_back({rel, false}); | |
| } | |
| return out; | |
| } | |
| } | |
| if (kind == list_kind::dirs || kind == list_kind::all) { | |
| for (auto & rel : find_entries(abs_base, max_depth, /*dirs=*/true, out.truncated)) { | |
| out.entries.push_back({std::move(rel), true}); | |
| } | |
| } | |
| if (kind == list_kind::files || kind == list_kind::all) { | |
| for (auto & rel : find_entries(abs_base, max_depth, /*dirs=*/false, out.truncated)) { | |
| out.entries.push_back({std::move(rel), false}); | |
| } | |
| } | |
| return out; | |
| } | |
| // wraps the command with an in-isolate `timeout`, since killing the host-side client | |
| // does not kill the process tree running inside the isolate | |
| exec_result run( | |
| const std::vector<std::string> & args, | |
| size_t max_output, | |
| int timeout_secs, | |
| const std::function<bool(const std::string &)> & on_chunk = nullptr) const override { | |
| std::vector<std::string> inner = {"timeout", std::to_string(timeout_secs) + "s"}; | |
| inner.insert(inner.end(), args.begin(), args.end()); | |
| // small buffer over timeout_secs so the in-isolate `timeout` has a chance to exit cleanly | |
| // before the host-side supervisory timeout forcibly kills the client | |
| return run_subprocess( | |
| build_argv(with_cwd(inner), /*needs_stdin=*/true), | |
| max_output, timeout_secs + 5, on_chunk, true); | |
| } | |
| protected: | |
| // wrap `inner` (a complete POSIX argv) into the host-side argv that runs it in the isolate | |
| // a transport that re-parses its args in a remote shell (ssh) must join `inner` with shell_quote_join() | |
| virtual std::vector<std::string> build_argv(const std::vector<std::string> & inner, bool needs_stdin) const = 0; | |
| // quote `argv` into a single string that a POSIX shell re-parses into exactly `argv` | |
| static std::string shell_quote_join(const std::vector<std::string> & argv) { | |
| std::string out; | |
| for (const auto & arg : argv) { | |
| if (!out.empty()) out += ' '; | |
| out += '\''; | |
| for (const char c : arg) { | |
| // a single quote cannot be escaped inside single quotes: close, escape, reopen | |
| if (c == '\'') out += "'\\''"; | |
| else out += c; | |
| } | |
| out += '\''; | |
| } | |
| return out; | |
| } | |
| private: | |
| std::string cwd; | |
| // set the working directory in the command itself, no `-w` equivalent exists on every transport | |
| // auxiliary calls do not need this, they use the absolute paths from resolve() | |
| std::vector<std::string> with_cwd(const std::vector<std::string> & inner) const { | |
| if (cwd.empty()) { | |
| return inner; | |
| } | |
| // 127 is what a shell reports for a command it could not run | |
| std::vector<std::string> out = {"sh", "-c", "cd \"$1\" || exit 127; shift; exec \"$@\"", "_", cwd}; | |
| out.insert(out.end(), inner.begin(), inner.end()); | |
| return out; | |
| } | |
| exec_result exec(const std::vector<std::string> & inner, size_t max_output, bool combine_stderr) const { | |
| return run_subprocess( | |
| build_argv(inner, /*needs_stdin=*/false), | |
| max_output, SERVER_TOOL_ISOLATE_EXEC_TIMEOUT, nullptr, combine_stderr); | |
| } | |
| bool shell_run(const std::vector<std::string> & inner) const { | |
| auto res = exec(inner, 4096, true); | |
| return res.exit_code == 0 && !res.timed_out; | |
| } | |
| bool shell_test(const char * flag, const std::string & path) const { | |
| return shell_run({"sh", "-c", std::string("[ ") + flag + " \"$1\" ]", "_", path}); | |
| } | |
| static std::vector<std::string> split_lines(const std::string & text, bool strip_dot_slash) { | |
| std::vector<std::string> result; | |
| std::istringstream iss(text); | |
| std::string line; | |
| while (std::getline(iss, line)) { | |
| if (!line.empty() && line.back() == '\r') line.pop_back(); | |
| if (line.empty()) continue; | |
| if (strip_dot_slash && line.rfind("./", 0) == 0) line = line.substr(2); | |
| std::replace(line.begin(), line.end(), '\\', '/'); | |
| result.push_back(line); | |
| } | |
| return result; | |
| } | |
| // one `find` pass in the isolate. junk directories stay selectable but are never descended into, | |
| // and -mindepth/-maxdepth keep a busybox image working as well as a GNU one | |
| std::vector<std::string> find_entries(const std::string & abs_base, int max_depth, bool dirs, bool & truncated) const { | |
| std::string prune_expr; | |
| for (const char * n : SERVER_TOOL_JUNK_DIR_NAMES) { | |
| if (!prune_expr.empty()) prune_expr += " -o "; | |
| prune_expr += std::string("-name ") + n; | |
| } | |
| std::string cmd = "cd \"$1\" && find . -mindepth 1"; | |
| if (max_depth > 0) { | |
| cmd += " -maxdepth " + std::to_string(max_depth); | |
| } | |
| cmd += " \\( " + prune_expr + " \\) -prune"; | |
| cmd += dirs ? " -print -o -type d -print" : " -o -type f -print"; | |
| auto res = exec({"sh", "-c", cmd, "_", abs_base}, SERVER_TOOL_GIT_LS_FILES_MAX_OUTPUT, true); | |
| truncated = truncated || res.timed_out; | |
| return split_lines(res.output, /*strip_dot_slash=*/true); | |
| } | |
| }; | |
| // an already-running container, driven through `<engine> exec` | |
| // docker and podman take the same verbs and the same argument order, so one class drives both | |
| class tools_io_container : public tools_io_isolate { | |
| public: | |
| tools_io_container(std::string bin, std::string container_id, std::string cwd = "") | |
| : tools_io_isolate(std::move(cwd)), bin(std::move(bin)), container_id(std::move(container_id)) {} | |
| protected: | |
| std::vector<std::string> build_argv(const std::vector<std::string> & inner, bool needs_stdin) const override { | |
| std::vector<std::string> argv = {bin, "exec"}; | |
| if (needs_stdin) { | |
| argv.push_back("-i"); | |
| } | |
| argv.push_back(container_id); | |
| argv.insert(argv.end(), inner.begin(), inner.end()); | |
| return argv; | |
| } | |
| private: | |
| std::string bin; | |
| std::string container_id; | |
| }; | |
| // a remote host reached over ssh | |
| // this is remoting, not isolation: the tools can do anything the target account can do | |
| class tools_io_ssh : public tools_io_isolate { | |
| public: | |
| tools_io_ssh(std::string target, std::string cwd = "") | |
| : tools_io_isolate(std::move(cwd)), target(std::move(target)) {} | |
| // the target can come from a client header, and ssh reads options from its argv | |
| // a target starting with '-' would become one, e.g. -oProxyCommand=<anything> runs on the host | |
| static bool is_valid_target(const std::string & target) { | |
| if (target.empty() || target[0] == '-') { | |
| return false; | |
| } | |
| return std::all_of(target.begin(), target.end(), [](unsigned char c) { | |
| return std::isalnum(c) || c == '.' || c == '-' || c == '_' || c == '@'; | |
| }); | |
| } | |
| protected: | |
| std::vector<std::string> build_argv(const std::vector<std::string> & inner, bool needs_stdin) const override { | |
| // the remote shell re-parses the command line, so `inner` travels as one quoted word | |
| std::vector<std::string> argv = ssh_argv(); | |
| if (!needs_stdin) { | |
| argv.push_back("-n"); | |
| } | |
| argv.push_back(target); | |
| argv.push_back(shell_quote_join(inner)); | |
| return argv; | |
| } | |
| private: | |
| std::string target; | |
| // there is no console here, so a prompt would hang the tool call | |
| // key-based auth only, and the admin must trust the host key beforehand | |
| static std::vector<std::string> ssh_argv() { | |
| return { | |
| "ssh", | |
| "-o", "BatchMode=yes", | |
| "-o", "PasswordAuthentication=no", | |
| "-o", "KbdInteractiveAuthentication=no", | |
| "-o", "StrictHostKeyChecking=yes", | |
| }; | |
| } | |
| }; | |
| // "<engine>:<image>" spawns a container and owns it, "<engine>-container:<id>" attaches to one | |
| struct container_runtime_spec { | |
| std::string bin; | |
| std::string arg; // image name when spawning, container id when attaching | |
| bool attach = false; | |
| static bool parse(const std::string & spec, container_runtime_spec & out) { | |
| // docker and podman take the same verbs, hence a single implementation | |
| static const char * engines[] = {"docker", "podman"}; | |
| for (const char * bin : engines) { | |
| const std::string attach_prefix = std::string(bin) + "-container:"; | |
| if (spec.rfind(attach_prefix, 0) == 0) { | |
| out = {bin, spec.substr(attach_prefix.size()), true}; | |
| return true; | |
| } | |
| const std::string spawn_prefix = std::string(bin) + ":"; | |
| if (spec.rfind(spawn_prefix, 0) == 0) { | |
| out = {bin, spec.substr(spawn_prefix.size()), false}; | |
| return true; | |
| } | |
| } | |
| return false; | |
| } | |
| // same risk as the ssh target: an id starting with '-' would become an engine option, | |
| // e.g. --privileged | |
| static bool is_valid_id(const std::string & id) { | |
| if (id.empty() || !std::isalnum((unsigned char) id[0])) { | |
| return false; | |
| } | |
| return std::all_of(id.begin(), id.end(), [](unsigned char c) { | |
| return std::isalnum(c) || c == '.' || c == '-' || c == '_'; | |
| }); | |
| } | |
| }; | |
| static std::unique_ptr<tools_io> make_tools_io(const json & params) { | |
| std::string cwd = json_value(params, "cwd", std::string()); | |
| std::string runtime = json_value(params, "runtime", std::string()); | |
| if (runtime.empty()) { | |
| // an empty runtime runs the tools on the host | |
| return std::make_unique<tools_io_basic>(cwd); | |
| } | |
| container_runtime_spec container; | |
| if (container_runtime_spec::parse(runtime, container)) { | |
| // spawning belongs to the runtime that owns the container, a tool call only attaches | |
| if (!container.attach) { | |
| throw std::runtime_error("tool runtime must name a running container: " + runtime); | |
| } | |
| if (!container_runtime_spec::is_valid_id(container.arg)) { | |
| throw std::runtime_error("invalid container id: " + container.arg); | |
| } | |
| return std::make_unique<tools_io_container>(container.bin, container.arg, cwd); | |
| } | |
| const std::string ssh_prefix = "ssh:"; | |
| if (runtime.rfind(ssh_prefix, 0) == 0) { | |
| std::string target = runtime.substr(ssh_prefix.size()); | |
| if (!tools_io_ssh::is_valid_target(target)) { | |
| throw std::runtime_error("invalid ssh target: " + target); | |
| } | |
| return std::make_unique<tools_io_ssh>(target, cwd); | |
| } | |
| // do not fall back to the host, the caller asked for an isolate | |
| throw std::runtime_error("unknown tool runtime: " + runtime); | |
| } | |
| // no '/' in pattern -> match basename at any depth; else match full relative path | |
| static bool path_glob_match(const std::string & pattern, const std::string & rel_path) { | |
| if (pattern.find('/') == std::string::npos) { | |
| return glob_match(pattern, path_to_utf8(path_from_utf8(rel_path).filename())); | |
| } | |
| if (pattern == "**" || pattern.rfind("**/", 0) == 0 || pattern.rfind('/', 0) == 0) { | |
| return glob_match(pattern, rel_path); | |
| } | |
| return glob_match("**/" + pattern, rel_path); | |
| } | |
| // | |
| // read_file: read a file with optional line range and line-number prefix | |
| // | |
| static constexpr size_t SERVER_TOOL_READ_FILE_MAX_SIZE = 16 * 1024; // 16 KB | |
| struct server_tool_read_file : server_tool { | |
| server_tool_read_file() { | |
| name = "read_file"; | |
| display_name = "Read file"; | |
| uses_cwd = true; | |
| permission_write = false; | |
| } | |
| json get_definition() const override { | |
| return { | |
| {"type", "function"}, | |
| {"function", { | |
| {"name", name}, | |
| {"description", "Read the contents of a file. Optionally specify a 1-based line range. " | |
| "If append_loc is true, each line is prefixed with its line number (e.g. \"1\u2192...\")."}, | |
| {"parameters", { | |
| {"type", "object"}, | |
| {"properties", { | |
| {"path", {{"type", "string"}, {"description", "Path to the file"}}}, | |
| {"start_line", {{"type", "integer"}, {"description", "First line to read, 1-based (default: 1)"}}}, | |
| {"end_line", {{"type", "integer"}, {"description", "Last line to read, 1-based inclusive (default: end of file)"}}}, | |
| {"append_loc", {{"type", "boolean"}, {"description", "Prefix each line with its line number"}}}, | |
| }}, | |
| {"required", json::array({"path"})}, | |
| }}, | |
| }}, | |
| }; | |
| } | |
| json invoke(json params, server_tool::stream *) const override { | |
| std::string path = params.at("path").get<std::string>(); | |
| int start_line = json_value(params, "start_line", 1); | |
| int end_line = json_value(params, "end_line", -1); // -1 = no limit | |
| bool append_loc = json_value(params, "append_loc", false); | |
| auto io = make_tools_io(params); | |
| uintmax_t file_size = 0; | |
| if (!io->file_size(path, file_size)) { | |
| return {{"error", "cannot stat file: " + path}}; | |
| } | |
| if (file_size > SERVER_TOOL_READ_FILE_MAX_SIZE && end_line == -1) { | |
| return {{"error", string_format( | |
| "file too large (%zu bytes, max %zu). Use start_line/end_line to read a portion.", | |
| (size_t)file_size, SERVER_TOOL_READ_FILE_MAX_SIZE)}}; | |
| } | |
| std::string content; | |
| if (!io->read_file(path, content)) { | |
| return {{"error", "failed to open file: " + path}}; | |
| } | |
| std::istringstream f(content); | |
| std::string result; | |
| std::string line; | |
| int lineno = 0; | |
| while (std::getline(f, line)) { | |
| lineno++; | |
| if (lineno < start_line) continue; | |
| if (end_line != -1 && lineno > end_line) break; | |
| std::string out_line; | |
| if (append_loc) { | |
| out_line = std::to_string(lineno) + "\u2192" + line + "\n"; | |
| } else { | |
| out_line = line + "\n"; | |
| } | |
| if (result.size() + out_line.size() > SERVER_TOOL_READ_FILE_MAX_SIZE) { | |
| result += "[output truncated]"; | |
| break; | |
| } | |
| result += out_line; | |
| } | |
| return {{"plain_text_response", result}}; | |
| } | |
| }; | |
| // | |
| // file_glob_search: find files matching a glob pattern under a base directory | |
| // | |
| static constexpr int SERVER_TOOL_FILE_SEARCH_MAX_RESULTS = 100; | |
| static constexpr const char * SERVER_TOOL_FILE_SEARCH_TYPE_FILE = "file"; | |
| static constexpr const char * SERVER_TOOL_FILE_SEARCH_TYPE_DIR = "dir"; | |
| static constexpr const char * SERVER_TOOL_FILE_SEARCH_TYPE_ALL = "all"; | |
| struct server_tool_file_glob_search : server_tool { | |
| server_tool_file_glob_search() { | |
| name = "file_glob_search"; | |
| display_name = "File search"; | |
| uses_cwd = true; | |
| permission_write = false; | |
| } | |
| json get_definition() const override { | |
| return { | |
| {"type", "function"}, | |
| {"function", { | |
| {"name", name}, | |
| {"description", | |
| "Recursively search for files matching a glob pattern under a directory. " | |
| "Automatically skips files ignored by .gitignore (when the directory is inside a git repo) " | |
| "and common junk directories (.git, node_modules, build, dist, etc.) otherwise. " | |
| "A pattern with no '/' (e.g. \"*.cpp\") matches the file's basename at any depth. " | |
| "A pattern containing '/' matches the full relative path; unless already anchored with " | |
| "\"**/\" or a leading '/', it is automatically prefixed with \"**/\". " | |
| "Use type=\"dir\" or \"all\" to also list directories; directory entries are suffixed with '/' in the output. " | |
| "Note: directory listings do not apply .gitignore filtering."}, | |
| {"parameters", { | |
| {"type", "object"}, | |
| {"properties", { | |
| {"path", {{"type", "string"}, {"description", "Base directory to search in"}}}, | |
| {"include", {{"type", "string"}, {"description", "Glob pattern for files to include (e.g. \"*.cpp\" or \"src/**/*.cpp\"). Default: **"}}}, | |
| {"exclude", {{"type", "string"}, {"description", "Glob pattern for files to exclude"}}}, | |
| {"type", {{"type", "string"}, {"description", "Entry type to return: \"file\" (default), \"dir\" or \"all\""}}}, | |
| {"max_depth", {{"type", "integer"}, {"description", "Maximum depth to descend into subdirectories (default: 0 = unlimited; 1 = direct children only)"}}}, | |
| {"limit", {{"type", "integer"}, {"description", string_format("Maximum number of results to return, capped at %d (default %d)", SERVER_TOOL_FILE_SEARCH_MAX_RESULTS, SERVER_TOOL_FILE_SEARCH_MAX_RESULTS)}}}, | |
| }}, | |
| {"required", json::array({"path"})}, | |
| }}, | |
| }}, | |
| }; | |
| } | |
| json invoke(json params, server_tool::stream *) const override { | |
| auto io = make_tools_io(params); | |
| const std::string path = params.at("path").get<std::string>(); | |
| std::string base = io->resolve(path); | |
| std::string include = json_value(params, "include", std::string("**")); | |
| std::string exclude = json_value(params, "exclude", std::string("")); | |
| std::string type = json_value(params, "type", std::string("file")); | |
| int max_depth = std::max(0, json_value(params, "max_depth", 0)); | |
| const int limit_req = json_value(params, "limit", SERVER_TOOL_FILE_SEARCH_MAX_RESULTS); | |
| if (limit_req < 1) { | |
| return {{"error", "invalid limit: " + std::to_string(limit_req) + " (expected 1 or more)"}}; | |
| } | |
| const int limit = std::min(limit_req, SERVER_TOOL_FILE_SEARCH_MAX_RESULTS); | |
| list_kind kind; | |
| if (type == SERVER_TOOL_FILE_SEARCH_TYPE_FILE) { | |
| kind = list_kind::files; | |
| } else if (type == SERVER_TOOL_FILE_SEARCH_TYPE_DIR) { | |
| kind = list_kind::dirs; | |
| } else if (type == SERVER_TOOL_FILE_SEARCH_TYPE_ALL) { | |
| kind = list_kind::all; | |
| } else { | |
| return {{"error", "invalid type: " + type + " (expected \"file\", \"dir\" or \"all\")"}}; | |
| } | |
| const auto listing = io->list_entries(base, max_depth, kind); | |
| if (!listing.err.empty()) { | |
| return {{"error", listing.err + ": " + path}}; | |
| } | |
| std::vector<tools_io::list_entry> matches; | |
| for (const auto & entry : listing.entries) { | |
| if (!path_glob_match(include, entry.rel)) continue; | |
| if (!exclude.empty() && path_glob_match(exclude, entry.rel)) continue; | |
| matches.push_back(entry); | |
| } | |
| size_t total = matches.size(); | |
| size_t shown = std::min(total, (size_t) limit); | |
| std::ostringstream output_text; | |
| json entries_json = json::array(); | |
| for (size_t i = 0; i < shown; i++) { | |
| output_text << matches[i].rel << (matches[i].is_dir ? "/" : "") << "\n"; | |
| entries_json.push_back({ | |
| {"path", matches[i].rel}, | |
| {"type", matches[i].is_dir ? "dir" : "file"}, | |
| }); | |
| } | |
| output_text << "\n---\nTotal matches: " << total << "\n"; | |
| if (total > shown) { | |
| output_text << string_format( | |
| "[%zu results limit reached (%zu total matches). Refine the glob pattern to narrow the search.]\n", | |
| shown, total); | |
| } | |
| if (listing.truncated) { | |
| output_text << "[results truncated: time budget or unreadable directory]\n"; | |
| } | |
| // `base` is always absolute (resolve falls back to the server cwd), so | |
| // API clients (e.g. the web UI picker) can join the relative entries | |
| // into absolute paths. `plain_text_response` is what the model sees; | |
| // `entries` is the same data as structured JSON for the UI picker, | |
| // which reads `entries`/`base` instead of re-parsing the text. | |
| return {{"plain_text_response", output_text.str()}, {"entries", entries_json}, {"base", base}}; | |
| } | |
| }; | |
| // | |
| // grep_search: search for a regex pattern in files | |
| // | |
| static constexpr size_t SERVER_TOOL_GREP_SEARCH_MAX_RESULTS = 100; | |
| struct server_tool_grep_search : server_tool { | |
| server_tool_grep_search() { | |
| name = "grep_search"; | |
| display_name = "Grep search"; | |
| uses_cwd = true; | |
| permission_write = false; | |
| } | |
| json get_definition() const override { | |
| return { | |
| {"type", "function"}, | |
| {"function", { | |
| {"name", name}, | |
| {"description", | |
| "Search for a pattern in files under a path. Returns matching lines with file paths " | |
| "(and, unless searching a single file, paths relative to the given directory). " | |
| "Automatically skips files ignored by .gitignore (when the directory is inside a git repo) " | |
| "and common junk directories (.git, node_modules, build, dist, etc.) otherwise. " | |
| "include/exclude: a pattern with no '/' matches the basename at any depth; a pattern " | |
| "containing '/' matches the full relative path (auto-anchored with \"**/\" unless already anchored)."}, | |
| {"parameters", { | |
| {"type", "object"}, | |
| {"properties", { | |
| {"path", {{"type", "string"}, {"description", "File or directory to search in"}}}, | |
| {"pattern", {{"type", "string"}, {"description", "Pattern to search for (regular expression unless literal is true)"}}}, | |
| {"include", {{"type", "string"}, {"description", "Glob pattern to filter files (default: **)"}}}, | |
| {"exclude", {{"type", "string"}, {"description", "Glob pattern to exclude files"}}}, | |
| {"return_line_numbers", {{"type", "boolean"}, {"description", "If true, include line numbers in results"}}}, | |
| {"literal", {{"type", "boolean"}, {"description", "Treat pattern as a literal string instead of a regular expression (default: false)"}}}, | |
| {"ignore_case", {{"type", "boolean"}, {"description", "Case-insensitive search (default: false)"}}}, | |
| {"context_lines", {{"type", "integer"}, {"description", "Number of lines of context to show before and after each match (default: 0)"}}}, | |
| }}, | |
| {"required", json::array({"path", "pattern"})}, | |
| }}, | |
| }}, | |
| }; | |
| } | |
| json invoke(json params, server_tool::stream *) const override { | |
| std::string path = params.at("path").get<std::string>(); | |
| std::string pat_str = params.at("pattern").get<std::string>(); | |
| std::string include = json_value(params, "include", std::string("**")); | |
| std::string exclude = json_value(params, "exclude", std::string("")); | |
| bool show_lineno = json_value(params, "return_line_numbers", false); | |
| bool literal = json_value(params, "literal", false); | |
| bool ignore_case = json_value(params, "ignore_case", false); | |
| int ctx_lines = std::max(0, json_value(params, "context_lines", 0)); | |
| std::string pattern_src = pat_str; | |
| if (literal) { | |
| static const std::string specials = "\\^$.|?*+()[]{}"; | |
| std::string escaped; | |
| escaped.reserve(pat_str.size() * 2); | |
| for (char c : pat_str) { | |
| if (specials.find(c) != std::string::npos) escaped += '\\'; | |
| escaped += c; | |
| } | |
| pattern_src = escaped; | |
| } | |
| std::regex pattern; | |
| try { | |
| auto flags = std::regex::ECMAScript; | |
| if (ignore_case) flags |= std::regex::icase; | |
| pattern = std::regex(pattern_src, flags); | |
| } catch (const std::regex_error & e) { | |
| return {{"error", std::string("invalid regex: ") + e.what()}}; | |
| } | |
| auto io = make_tools_io(params); | |
| // collect (absolute_path, display_path) pairs to search | |
| std::vector<std::pair<std::string, std::string>> files; | |
| const std::string abs_path = io->resolve(path); | |
| if (io->is_regular_file(abs_path)) { | |
| files.emplace_back(abs_path, path); | |
| } else if (io->is_directory(abs_path)) { | |
| const auto listing = io->list_entries(abs_path, 0, list_kind::files); | |
| if (!listing.err.empty()) { | |
| return {{"error", listing.err + ": " + path}}; | |
| } | |
| for (const auto & entry : listing.entries) { | |
| if (!path_glob_match(include, entry.rel)) continue; | |
| if (!exclude.empty() && path_glob_match(exclude, entry.rel)) continue; | |
| files.emplace_back(path_to_utf8(path_from_utf8(abs_path) / path_from_utf8(entry.rel)), entry.rel); | |
| } | |
| } else { | |
| return {{"error", "path does not exist: " + path}}; | |
| } | |
| std::ostringstream output_text; | |
| size_t total = 0; | |
| bool limit_reached = false; | |
| bool show_num = show_lineno || ctx_lines > 0; | |
| for (const auto & file_entry : files) { | |
| if (limit_reached) break; | |
| const std::string & fpath = file_entry.first; | |
| const std::string & display_path = file_entry.second; | |
| std::string content; | |
| if (!io->read_file(fpath, content)) continue; | |
| std::vector<std::string> lines; | |
| { | |
| std::istringstream f(content); | |
| std::string line; | |
| while (std::getline(f, line)) lines.push_back(line); | |
| } | |
| for (size_t i = 0; i < lines.size(); i++) { | |
| if (total >= SERVER_TOOL_GREP_SEARCH_MAX_RESULTS) { | |
| limit_reached = true; | |
| break; | |
| } | |
| if (!std::regex_search(lines[i], pattern)) continue; | |
| long ctx_start = ctx_lines > 0 ? std::max<long>(0, (long) i - ctx_lines) : (long) i; | |
| long ctx_end = ctx_lines > 0 ? std::min<long>((long) lines.size() - 1, (long) i + ctx_lines) : (long) i; | |
| for (long j = ctx_start; j <= ctx_end; j++) { | |
| bool is_match = (j == (long) i); | |
| output_text << display_path << (is_match ? ':' : '-'); | |
| if (show_num) { | |
| output_text << (j + 1) << (is_match ? ':' : '-'); | |
| } | |
| output_text << lines[j] << "\n"; | |
| } | |
| if (ctx_lines > 0) { | |
| output_text << "--\n"; | |
| } | |
| total++; | |
| } | |
| } | |
| output_text << "\n---\nTotal matches: " << total << "\n"; | |
| if (limit_reached) { | |
| output_text << string_format( | |
| "[%zu matches limit reached. Narrow the path/pattern/include to see more.]\n", | |
| SERVER_TOOL_GREP_SEARCH_MAX_RESULTS); | |
| } | |
| return {{"plain_text_response", output_text.str()}}; | |
| } | |
| }; | |
| // | |
| // exec_shell_command: run an arbitrary shell command | |
| // | |
| static constexpr size_t SERVER_TOOL_EXEC_SHELL_COMMAND_MAX_OUTPUT_SIZE = 16 * 1024; // 16 KB | |
| static constexpr int SERVER_TOOL_EXEC_SHELL_COMMAND_MAX_TIMEOUT = 60; // seconds | |
| struct server_tool_exec_shell_command : server_tool { | |
| server_tool_exec_shell_command() { | |
| name = "exec_shell_command"; | |
| display_name = "Execute shell command"; | |
| uses_cwd = true; | |
| permission_write = true; | |
| support_stream = true; | |
| } | |
| json get_definition() const override { | |
| return { | |
| {"type", "function"}, | |
| {"function", { | |
| {"name", name}, | |
| {"description", "Execute a shell command and return its output (stdout and stderr combined)."}, | |
| {"parameters", { | |
| {"type", "object"}, | |
| {"properties", { | |
| {"command", {{"type", "string"}, {"description", "Shell command to execute"}}}, | |
| {"timeout", {{"type", "integer"}, {"description", string_format("Timeout in seconds (default 10, max %d)", SERVER_TOOL_EXEC_SHELL_COMMAND_MAX_TIMEOUT)}}}, | |
| {"max_output_size", {{"type", "integer"}, {"description", string_format("Maximum output size in bytes (default %zu)", SERVER_TOOL_EXEC_SHELL_COMMAND_MAX_OUTPUT_SIZE)}}}, | |
| }}, | |
| {"required", json::array({"command"})}, | |
| }}, | |
| }}, | |
| }; | |
| } | |
| json invoke(json params, server_tool::stream * st) const override { | |
| std::string command = params.at("command").get<std::string>(); | |
| int timeout = json_value(params, "timeout", 10); | |
| size_t max_output = (size_t) json_value(params, "max_output_size", (int) SERVER_TOOL_EXEC_SHELL_COMMAND_MAX_OUTPUT_SIZE); | |
| timeout = std::min(timeout, SERVER_TOOL_EXEC_SHELL_COMMAND_MAX_TIMEOUT); | |
| max_output = std::min(max_output, SERVER_TOOL_EXEC_SHELL_COMMAND_MAX_OUTPUT_SIZE); | |
| // an isolate is always POSIX regardless of host OS, so it always gets `sh -c` | |
| std::vector<std::string> args = !json_value(params, "runtime", std::string()).empty() | |
| ? std::vector<std::string>{"sh", "-c", command} | |
| : std::vector<std::string>{"cmd", "/c", command}; | |
| std::vector<std::string> args = {"sh", "-c", command}; | |
| auto io = make_tools_io(params); | |
| if (st) { | |
| auto res = io->run(args, max_output, timeout, [st](const std::string & chunk) { | |
| st->push(chunk); | |
| return !st->alive || st->alive(); | |
| }); | |
| if (st->alive && !st->alive()) { | |
| return json(); | |
| } | |
| std::string tail = string_format("\n[exit code: %d]", res.exit_code); | |
| if (res.timed_out) { | |
| tail += " [exit due to timed out]"; | |
| } | |
| st->push(tail); | |
| return json(); | |
| } | |
| auto res = io->run(args, max_output, timeout); | |
| std::string text_output = res.output; | |
| text_output += string_format("\n[exit code: %d]", res.exit_code); | |
| if (res.timed_out) { | |
| text_output += " [exit due to timed out]"; | |
| } | |
| return {{"plain_text_response", text_output}}; | |
| } | |
| }; | |
| // | |
| // write_file: create or overwrite a file | |
| // | |
| struct server_tool_write_file : server_tool { | |
| server_tool_write_file() { | |
| name = "write_file"; | |
| display_name = "Write file"; | |
| uses_cwd = true; | |
| permission_write = true; | |
| } | |
| json get_definition() const override { | |
| return { | |
| {"type", "function"}, | |
| {"function", { | |
| {"name", name}, | |
| {"description", "Write content to a file, creating it (including parent directories) if it does not exist. May use with edit_file for more complex edits."}, | |
| {"parameters", { | |
| {"type", "object"}, | |
| {"properties", { | |
| {"path", {{"type", "string"}, {"description", "Path of the file to write"}}}, | |
| {"content", {{"type", "string"}, {"description", "Content to write"}}}, | |
| }}, | |
| {"required", json::array({"path", "content"})}, | |
| }}, | |
| }}, | |
| }; | |
| } | |
| json invoke(json params, server_tool::stream *) const override { | |
| std::string path = params.at("path").get<std::string>(); | |
| std::string content = params.at("content").get<std::string>(); | |
| auto io = make_tools_io(params); | |
| if (!io->write_file(path, content)) { | |
| return {{"error", "failed to write file: " + path}}; | |
| } | |
| return {{"result", "file written successfully"}, {"path", path}, {"bytes", content.size()}}; | |
| } | |
| }; | |
| // | |
| // edit_file: exact text replacement, one or more edits per call | |
| // | |
| struct server_tool_edit_file : server_tool { | |
| server_tool_edit_file() { | |
| name = "edit_file"; | |
| display_name = "Edit file"; | |
| uses_cwd = true; | |
| permission_write = true; | |
| } | |
| json get_definition() const override { | |
| return { | |
| {"type", "function"}, | |
| {"function", { | |
| {"name", name}, | |
| {"description", | |
| "Edit a file using exact text replacement. Each edits[].old_text must be unique in the file " | |
| "and is matched against the original content, not incrementally. Merge nearby changes into " | |
| "one edit instead of overlapping edits. Use write_file to replace the whole file."}, | |
| {"parameters", { | |
| {"type", "object"}, | |
| {"properties", { | |
| {"path", {{"type", "string"}, {"description", "Path to the file to edit"}}}, | |
| {"edits", { | |
| {"type", "array"}, | |
| {"description", "One or more exact text replacements to apply"}, | |
| {"items", { | |
| {"type", "object"}, | |
| {"properties", { | |
| {"old_text", {{"type", "string"}, {"description", "Exact text to find; must be unique in the file and must not overlap with other edits"}}}, | |
| {"new_text", {{"type", "string"}, {"description", "Text to replace old_text with"}}}, | |
| }}, | |
| {"required", json::array({"old_text", "new_text"})}, | |
| }}, | |
| }}, | |
| }}, | |
| {"required", json::array({"path", "edits"})}, | |
| }}, | |
| }}, | |
| }; | |
| } | |
| json invoke(json params, server_tool::stream *) const override { | |
| std::string path = params.at("path").get<std::string>(); | |
| const json & edits_json = params.at("edits"); | |
| if (!edits_json.is_array() || edits_json.empty()) { | |
| return {{"error", "\"edits\" must be a non-empty array"}}; | |
| } | |
| struct edit_req { | |
| std::string old_text; | |
| std::string new_text; | |
| }; | |
| std::vector<edit_req> edits; | |
| edits.reserve(edits_json.size()); | |
| for (const auto & e : edits_json) { | |
| edit_req er; | |
| er.old_text = e.at("old_text").get<std::string>(); | |
| er.new_text = e.at("new_text").get<std::string>(); | |
| if (er.old_text.empty()) { | |
| return {{"error", string_format("edits[%zu].old_text must not be empty", edits.size())}}; | |
| } | |
| edits.push_back(std::move(er)); | |
| } | |
| auto io = make_tools_io(params); | |
| std::string original_content; | |
| if (!io->read_file(path, original_content)) { | |
| return {{"error", "failed to open file: " + path}}; | |
| } | |
| // does any old_text need fuzzy matching (no exact match found)? | |
| bool any_fuzzy = false; | |
| for (size_t i = 0; i < edits.size(); i++) { | |
| if (original_content.find(edits[i].old_text) != std::string::npos) continue; | |
| std::string fuzzy_content = normalize_for_fuzzy_match(original_content); | |
| std::string fuzzy_old = normalize_for_fuzzy_match(edits[i].old_text); | |
| if (fuzzy_content.find(fuzzy_old) == std::string::npos) { | |
| return {{"error", string_format( | |
| "could not find edits[%zu].old_text in %s, it must match the file's current content exactly", | |
| i, path.c_str())}}; | |
| } | |
| any_fuzzy = true; | |
| } | |
| std::string base_content = any_fuzzy ? normalize_for_fuzzy_match(original_content) : original_content; | |
| // uniqueness check always uses fuzzy-normalized text, so a whitespace-only duplicate still counts | |
| std::vector<matched_edit> matched; | |
| matched.reserve(edits.size()); | |
| for (size_t i = 0; i < edits.size(); i++) { | |
| std::string needle = any_fuzzy ? normalize_for_fuzzy_match(edits[i].old_text) : edits[i].old_text; | |
| size_t occurrences = count_occurrences( | |
| normalize_for_fuzzy_match(original_content), | |
| normalize_for_fuzzy_match(edits[i].old_text)); | |
| if (occurrences > 1) { | |
| return {{"error", string_format( | |
| "found %zu occurrences of edits[%zu].old_text in %s, it must be unique", | |
| occurrences, i, path.c_str())}}; | |
| } | |
| size_t idx = base_content.find(needle); | |
| matched.push_back({i, idx, needle.size(), edits[i].new_text}); | |
| } | |
| std::sort(matched.begin(), matched.end(), [](const matched_edit & a, const matched_edit & b) { | |
| return a.match_index < b.match_index; | |
| }); | |
| for (size_t i = 1; i < matched.size(); i++) { | |
| if (matched[i - 1].match_index + matched[i - 1].match_length > matched[i].match_index) { | |
| return {{"error", string_format( | |
| "edits[%zu] and edits[%zu] overlap in %s; merge them into one edit or target disjoint regions", | |
| matched[i - 1].edit_index, matched[i].edit_index, path.c_str())}}; | |
| } | |
| } | |
| std::string new_content = any_fuzzy | |
| ? apply_replacements_preserving_unchanged_lines(original_content, base_content, matched) | |
| : apply_replacements(base_content, matched, 0); | |
| if (new_content == original_content) { | |
| return {{"error", "no changes made: the replacement(s) produced identical content"}}; | |
| } | |
| if (!io->write_file(path, new_content)) { | |
| return {{"error", "failed to write file: " + path}}; | |
| } | |
| return {{"result", "file edited successfully"}, {"path", path}, {"edits_applied", (int) matched.size()}}; | |
| } | |
| private: | |
| // strip trailing whitespace, normalize smart quotes/dashes/spaces to ASCII | |
| static std::string normalize_line_for_fuzzy_match(const std::string & line) { | |
| size_t end = line.size(); | |
| while (end > 0 && (line[end - 1] == ' ' || line[end - 1] == '\t' || line[end - 1] == '\r')) { | |
| end--; | |
| } | |
| std::string s = line.substr(0, end); | |
| auto replace_all = [](std::string & str, const std::string & from, const std::string & to) { | |
| if (from.empty()) return; | |
| size_t pos = 0; | |
| while ((pos = str.find(from, pos)) != std::string::npos) { | |
| str.replace(pos, from.size(), to); | |
| pos += to.size(); | |
| } | |
| }; | |
| // smart single quotes -> ' | |
| for (unsigned char b : {0x98, 0x99, 0x9A, 0x9B}) { | |
| replace_all(s, std::string("\xE2\x80") + (char) b, "'"); | |
| } | |
| // smart double quotes -> " | |
| for (unsigned char b : {0x9C, 0x9D, 0x9E, 0x9F}) { | |
| replace_all(s, std::string("\xE2\x80") + (char) b, "\""); | |
| } | |
| // various dashes -> - | |
| for (unsigned char b = 0x90; b <= 0x95; b++) { | |
| replace_all(s, std::string("\xE2\x80") + (char) b, "-"); | |
| } | |
| replace_all(s, "\xE2\x88\x92", "-"); // minus sign | |
| // special spaces -> ' ' | |
| replace_all(s, "\xC2\xA0", " "); // no-break space | |
| for (unsigned char b = 0x82; b <= 0x8A; b++) { | |
| replace_all(s, std::string("\xE2\x80") + (char) b, " "); | |
| } | |
| replace_all(s, "\xE2\x80\xAF", " "); // narrow no-break space | |
| replace_all(s, "\xE2\x81\x9F", " "); // medium mathematical space | |
| replace_all(s, "\xE3\x80\x80", " "); // ideographic space | |
| return s; | |
| } | |
| // applies the per-line transform above to every line; preserves line count/positions | |
| static std::string normalize_for_fuzzy_match(const std::string & content) { | |
| std::string result; | |
| result.reserve(content.size()); | |
| size_t start = 0; | |
| while (true) { | |
| size_t nl = content.find('\n', start); | |
| bool is_last = nl == std::string::npos; | |
| std::string line = is_last ? content.substr(start) : content.substr(start, nl - start); | |
| result += normalize_line_for_fuzzy_match(line); | |
| if (is_last) break; | |
| result += '\n'; | |
| start = nl + 1; | |
| } | |
| return result; | |
| } | |
| // lines with trailing '\n' kept, so untouched ones can be reconstructed verbatim | |
| static std::vector<std::string> split_lines_with_endings(const std::string & content) { | |
| std::vector<std::string> lines; | |
| size_t start = 0; | |
| while (start < content.size()) { | |
| size_t nl = content.find('\n', start); | |
| if (nl == std::string::npos) { | |
| lines.push_back(content.substr(start)); | |
| break; | |
| } | |
| lines.push_back(content.substr(start, nl - start + 1)); | |
| start = nl + 1; | |
| } | |
| return lines; | |
| } | |
| struct line_span { | |
| size_t start; | |
| size_t end; | |
| }; | |
| static std::vector<line_span> get_line_spans(const std::string & content) { | |
| std::vector<line_span> spans; | |
| size_t offset = 0; | |
| for (const auto & line : split_lines_with_endings(content)) { | |
| spans.push_back({offset, offset + line.size()}); | |
| offset += line.size(); | |
| } | |
| return spans; | |
| } | |
| // count non-overlapping occurrences of `needle` in `content` | |
| static size_t count_occurrences(const std::string & content, const std::string & needle) { | |
| if (needle.empty()) return 0; | |
| size_t count = 0, pos = 0; | |
| while ((pos = content.find(needle, pos)) != std::string::npos) { | |
| count++; | |
| pos += needle.size(); | |
| } | |
| return count; | |
| } | |
| struct matched_edit { | |
| size_t edit_index; | |
| size_t match_index; // offset into the "base content" (see below) | |
| size_t match_length; | |
| std::string new_text; | |
| }; | |
| // replacements must be sorted ascending by match_index and non-overlapping | |
| static std::string apply_replacements( | |
| const std::string & content, | |
| const std::vector<matched_edit> & replacements, | |
| size_t offset) { | |
| std::string result = content; | |
| for (auto it = replacements.rbegin(); it != replacements.rend(); ++it) { | |
| size_t local_index = it->match_index - offset; | |
| result = result.substr(0, local_index) + it->new_text + result.substr(local_index + it->match_length); | |
| } | |
| return result; | |
| } | |
| // widen a replacement's byte range to the line(s) of `lines` it touches | |
| static bool get_replacement_line_range( | |
| const std::vector<line_span> & lines, | |
| size_t match_index, size_t match_length, | |
| size_t & out_start_line, size_t & out_end_line /* exclusive */) { | |
| size_t replacement_start = match_index; | |
| size_t replacement_end = match_index + match_length; | |
| size_t start_line = (size_t) -1; | |
| for (size_t i = 0; i < lines.size(); i++) { | |
| if (replacement_start >= lines[i].start && replacement_start < lines[i].end) { | |
| start_line = i; | |
| break; | |
| } | |
| } | |
| if (start_line == (size_t) -1) return false; | |
| size_t end_line = start_line; | |
| while (end_line < lines.size() && lines[end_line].end < replacement_end) { | |
| end_line++; | |
| } | |
| if (end_line >= lines.size()) return false; | |
| out_start_line = start_line; | |
| out_end_line = end_line + 1; | |
| return true; | |
| } | |
| // like apply_replacements, but untouched lines come from `original_content` | |
| static std::string apply_replacements_preserving_unchanged_lines( | |
| const std::string & original_content, | |
| const std::string & base_content, | |
| const std::vector<matched_edit> & replacements /* ascending, non-overlapping */) { | |
| auto original_lines = split_lines_with_endings(original_content); | |
| auto base_lines = get_line_spans(base_content); | |
| struct group { | |
| size_t start_line; | |
| size_t end_line; // exclusive | |
| std::vector<matched_edit> reps; | |
| }; | |
| std::vector<group> groups; | |
| for (const auto & rep : replacements) { | |
| size_t start_line = 0, end_line = 0; | |
| get_replacement_line_range(base_lines, rep.match_index, rep.match_length, start_line, end_line); | |
| if (!groups.empty() && start_line < groups.back().end_line) { | |
| groups.back().end_line = std::max(groups.back().end_line, end_line); | |
| groups.back().reps.push_back(rep); | |
| } else { | |
| groups.push_back({start_line, end_line, {rep}}); | |
| } | |
| } | |
| size_t original_line_index = 0; | |
| std::string result; | |
| for (auto & g : groups) { | |
| for (size_t i = original_line_index; i < g.start_line; i++) { | |
| result += original_lines[i]; | |
| } | |
| size_t group_start_offset = base_lines[g.start_line].start; | |
| size_t group_end_offset = base_lines[g.end_line - 1].end; | |
| std::string slice = base_content.substr(group_start_offset, group_end_offset - group_start_offset); | |
| result += apply_replacements(slice, g.reps, group_start_offset); | |
| original_line_index = g.end_line; | |
| } | |
| for (size_t i = original_line_index; i < original_lines.size(); i++) { | |
| result += original_lines[i]; | |
| } | |
| return result; | |
| } | |
| }; | |
| // | |
| // get_datetime: returns the current date and time | |
| // | |
| struct server_tool_get_datetime : server_tool { | |
| server_tool_get_datetime() { | |
| name = "get_datetime"; | |
| display_name = "Get Date & Time"; | |
| permission_write = false; | |
| } | |
| json get_definition() const override { | |
| return { | |
| {"type", "function"}, | |
| {"function", { | |
| {"name", name}, | |
| {"description", "Returns the current date and time in UTC"}, | |
| {"parameters", { | |
| {"type", "object"}, | |
| {"properties", { | |
| {"format", { | |
| {"type", "string"}, | |
| {"description", | |
| "strftime()-style format string for the output (default: \"%Y-%m-%dT%H:%M:%SZ\", " | |
| "e.g. ISO 8601). Choose your own format if you need something else, " | |
| "e.g. \"%A, %B %d %Y\" for a human-readable date."}, | |
| }}, | |
| }}, | |
| }}, | |
| }}, | |
| }; | |
| } | |
| json invoke(json params, server_tool::stream *) const override { | |
| std::string format = json_value(params, "format", std::string("%Y-%m-%dT%H:%M:%SZ")); | |
| auto now = std::chrono::system_clock::now(); | |
| auto time = std::chrono::system_clock::to_time_t(now); | |
| std::tm tm_utc; | |
| gmtime_s(&tm_utc, &time); | |
| gmtime_r(&time, &tm_utc); | |
| char buf[256]; | |
| size_t len = std::strftime(buf, sizeof(buf), format.c_str(), &tm_utc); | |
| if (len == 0) { | |
| return {{"error", "invalid format string"}}; | |
| } | |
| return {{"result", std::string(buf, len)}}; | |
| } | |
| }; | |
| // | |
| // get_info: returns runtime info (OS name/version and cwd) | |
| // | |
| static constexpr size_t SERVER_TOOL_GET_INFO_MAX_OUTPUT = 4096; | |
| static constexpr int SERVER_TOOL_GET_INFO_TIMEOUT = 5; // seconds | |
| struct server_tool_get_info : server_tool { | |
| server_tool_get_info() { | |
| name = "get_info"; | |
| display_name = "Get Runtime Info"; | |
| uses_cwd = true; | |
| permission_write = false; | |
| } | |
| json get_definition() const override { | |
| return { | |
| {"type", "function"}, | |
| {"function", { | |
| {"name", name}, | |
| {"description", "Returns runtime info: the OS name/version and the current working directory"}, | |
| {"parameters", { | |
| {"type", "object"}, | |
| {"properties", json::object()}, | |
| }}, | |
| }}, | |
| }; | |
| } | |
| json invoke(json params, server_tool::stream *) const override { | |
| auto io = make_tools_io(params); | |
| // inside an isolate, we always use the linux command | |
| std::vector<std::string> args = !json_value(params, "runtime", std::string()).empty() | |
| ? std::vector<std::string>{"uname", "-a"} | |
| : std::vector<std::string>{"cmd", "/c", "ver"}; | |
| std::vector<std::string> args = {"uname", "-a"}; | |
| auto res = io->run(args, SERVER_TOOL_GET_INFO_MAX_OUTPUT, SERVER_TOOL_GET_INFO_TIMEOUT); | |
| // "ver" prints a blank line before the version, so the output is stripped on both ends; | |
| // a failed spawn or a timeout leaves a diagnostic in res.output, which is not an OS name | |
| std::string os_info = res.exit_code == 0 && !res.timed_out ? string_strip(res.output) : "unknown"; | |
| std::string cwd = json_value(params, "cwd", std::string()); | |
| if (cwd.empty()) { | |
| if (json_value(params, "runtime", std::string()).empty()) { | |
| std::error_code ec; | |
| cwd = path_to_utf8(fs::current_path(ec)); | |
| } else { | |
| auto pwd = io->run({"pwd"}, SERVER_TOOL_GET_INFO_MAX_OUTPUT, SERVER_TOOL_GET_INFO_TIMEOUT); | |
| cwd = pwd.exit_code == 0 && !pwd.timed_out ? string_strip(pwd.output) : "unknown"; | |
| } | |
| } | |
| return { | |
| {"os", os_info}, | |
| {"cwd", cwd}, | |
| }; | |
| } | |
| }; | |
| struct server_tool_stream_result : server_task_result { | |
| std::string chunk; | |
| bool done = false; | |
| std::string error_msg; | |
| json to_json() override { | |
| if (!done) { | |
| return {{"chunk", chunk}}; | |
| } else { | |
| json result = {{"done", true}}; | |
| if (!error_msg.empty()) { | |
| result["error"] = error_msg; | |
| } | |
| return result; | |
| } | |
| } | |
| }; | |
| void server_tool::stream::push(const std::string & chunk) { | |
| if (chunk.empty()) return; | |
| auto r = std::make_unique<server_tool_stream_result>(); | |
| r->id = id; | |
| r->chunk = chunk; | |
| qr.send(std::move(r)); | |
| } | |
| struct server_tools_res : server_http_res { | |
| std::thread worker; | |
| server_response * qr = nullptr; // set only for streaming responses | |
| int id = -1; | |
| ~server_tools_res() override { | |
| if (worker.joinable()) { | |
| worker.join(); | |
| } | |
| if (qr) { | |
| qr->remove_waiting_task_id(id); | |
| } | |
| } | |
| }; | |
| // | |
| // server_mcp_tool: exposes one tool from a running MCP server as a server_tool. | |
| // | |
| struct server_mcp_tool : server_tool { | |
| std::string server_name; | |
| std::string tool_name; | |
| server_mcp_tool_def def; | |
| server_mcp & mcp_mgr; | |
| server_mcp_tool(server_mcp_tool_def d, server_mcp & mgr) | |
| : server_name(d.server_name) | |
| , tool_name(d.name) | |
| , def(std::move(d)) | |
| , mcp_mgr(mgr) | |
| { | |
| name = server_name + "_" + tool_name; | |
| display_name = name; | |
| permission_write = false; | |
| support_stream = false; | |
| } | |
| std::string type() const override { return "mcp"; } | |
| json get_definition() const override { | |
| json schema = def.input_schema; | |
| if (schema.is_null() || !schema.is_object()) { | |
| schema = json::object(); | |
| } | |
| return { | |
| {"type", "function"}, | |
| {"function", { | |
| {"name", name}, | |
| {"description", def.description}, | |
| {"parameters", schema}, | |
| }}, | |
| }; | |
| } | |
| json invoke(json params, server_tool::stream *) const override { | |
| return mcp_mgr.call_tool(server_name, tool_name, params); | |
| } | |
| }; | |
| // resolves --tools-runtime into the isolate that every tool call runs through | |
| // spec() returns the runtime string make_tools_io() takes, and runs once per tool call | |
| struct server_tools_runtime { | |
| virtual ~server_tools_runtime() = default; | |
| virtual std::string spec() = 0; | |
| }; | |
| // a target that already exists and needs no lifecycle | |
| // the spec is validated once at startup, then passed straight through | |
| struct server_tools_static_runtime : server_tools_runtime { | |
| explicit server_tools_static_runtime(std::string spec) : runtime_spec(std::move(spec)) {} | |
| std::string spec() override { return runtime_spec; } | |
| private: | |
| std::string runtime_spec; | |
| }; | |
| // owns the container the tools run in, as set by --tools-runtime "<engine>:<image>" | |
| // it is spawned here and stopped when the server exits | |
| struct server_tools_container_runtime : server_tools_runtime { | |
| server_tools_container_runtime(const server_tools_container_runtime &) = delete; | |
| explicit server_tools_container_runtime(const std::string & spec) { | |
| container_runtime_spec parsed; | |
| if (!container_runtime_spec::parse(spec, parsed)) { | |
| throw std::runtime_error("unknown --tools-runtime option: " + spec); | |
| } | |
| bin = parsed.bin; | |
| image = parsed.arg; | |
| if (image.empty()) { | |
| throw std::runtime_error("--tools-runtime " + bin + ":<image> requires an image name"); | |
| } | |
| spawn(); | |
| } | |
| ~server_tools_container_runtime() override { | |
| // closing stdin signals the container's shell (its pid 1) to exit; --rm then removes it | |
| proc.close_stdin(); | |
| proc.join(); | |
| } | |
| // respawns a container that died on its own, so the returned spec always names a running one | |
| std::string spec() override { | |
| std::lock_guard<std::mutex> lock(mutex); | |
| if (!proc.alive()) { | |
| SRV_WRN("%s tools runtime container \"%s\" died, respawning\n", bin.c_str(), container_id.c_str()); | |
| spawn(); | |
| } | |
| return bin + "-container:" + container_id; | |
| } | |
| private: | |
| std::string bin; | |
| std::string image; | |
| std::string container_id; | |
| common_subproc proc; // `<engine> run` client that keeps the container alive | |
| std::mutex mutex; | |
| // spawns "<engine> run --rm -i <image> sh" and keeps its stdin open; the shell blocks reading stdin, | |
| // so the container stays alive until we close it (see destructor) or it is killed from the outside | |
| void spawn() { | |
| // create() writes over the handle it is given, so the previous one is released first | |
| proc.join(); | |
| std::error_code ec; | |
| fs::path cidfile = fs::temp_directory_path(ec) / string_format( | |
| "llama-tools-runtime-cid-%zu.tmp", std::hash<std::thread::id>{}(std::this_thread::get_id())); | |
| fs::remove(cidfile, ec); | |
| std::vector<std::string> args = {bin, "run", "--rm", "-i", "--cidfile", path_to_utf8(cidfile), image, "sh"}; | |
| int options = subprocess_option_no_window | |
| | subprocess_option_inherit_environment | |
| | subprocess_option_search_user_path; | |
| if (!proc.create(args, options)) { | |
| throw std::runtime_error("failed to spawn " + bin + " container for tools runtime (image: " + image + ")"); | |
| } | |
| std::string cid; | |
| for (int i = 0; i < 100 && cid.empty(); i++) { | |
| std::ifstream f(cidfile); | |
| if (f) std::getline(f, cid); | |
| if (cid.empty()) std::this_thread::sleep_for(std::chrono::milliseconds(100)); | |
| } | |
| fs::remove(cidfile, ec); | |
| if (cid.empty()) { | |
| proc.terminate(); | |
| throw std::runtime_error("timed out waiting for " + bin + " container to start (image: " + image + ")"); | |
| } | |
| container_id = cid; | |
| } | |
| }; | |
| static server_tool & find_tool(std::vector<std::unique_ptr<server_tool>> & tools, const std::string & name, bool require_stream) { | |
| for (auto & t : tools) { | |
| if (t->name == name) { | |
| if (require_stream && !t->support_stream) { | |
| throw std::invalid_argument(string_format("tool \"%s\" does not support stream = true", name.c_str())); | |
| } | |
| return *t; | |
| } | |
| } | |
| throw std::invalid_argument(string_format("unknown tool \"%s\"", name.c_str())); | |
| } | |
| // | |
| // public API | |
| // | |
| static std::vector<std::unique_ptr<server_tool>> build_tools() { | |
| std::vector<std::unique_ptr<server_tool>> tools; | |
| tools.push_back(std::make_unique<server_tool_read_file>()); | |
| tools.push_back(std::make_unique<server_tool_file_glob_search>()); | |
| tools.push_back(std::make_unique<server_tool_grep_search>()); | |
| tools.push_back(std::make_unique<server_tool_exec_shell_command>()); | |
| tools.push_back(std::make_unique<server_tool_write_file>()); | |
| tools.push_back(std::make_unique<server_tool_edit_file>()); | |
| tools.push_back(std::make_unique<server_tool_get_datetime>()); | |
| tools.push_back(std::make_unique<server_tool_get_info>()); | |
| return tools; | |
| } | |
| static std::string str_to_lower(const std::string & value) { | |
| std::string lowered(value.size(), '\0'); | |
| std::transform(value.begin(), value.end(), lowered.begin(), [](unsigned char c) { return std::tolower(c); }); | |
| return lowered; | |
| } | |
| static std::string get_header(const std::map<std::string, std::string> & headers, const std::string & key, std::string default_value = "") { | |
| const auto lowered_key = str_to_lower(key); | |
| for (const auto & h : headers) { | |
| if (str_to_lower(h.first) == lowered_key) { | |
| return h.second; | |
| } | |
| } | |
| return default_value; | |
| } | |
| server_tools::server_tools() = default; | |
| server_tools::~server_tools() = default; | |
| // the "<engine>:<image>" form owns a container lifecycle | |
| // anything else names an existing target, so only its spec is validated here at startup | |
| static std::unique_ptr<server_tools_runtime> make_tools_runtime(const std::string & spec) { | |
| container_runtime_spec parsed; | |
| if (container_runtime_spec::parse(spec, parsed) && !parsed.attach) { | |
| return std::make_unique<server_tools_container_runtime>(spec); | |
| } | |
| make_tools_io({{"runtime", spec}}); // nothing to own, just reject a bad spec now | |
| return std::make_unique<server_tools_static_runtime>(spec); | |
| } | |
| void server_tools::setup(const std::vector<std::string> & enabled_tools, | |
| server_mcp & mcp_mgr, | |
| const std::string & tools_runtime) { | |
| if (!tools_runtime.empty()) { | |
| runtime = make_tools_runtime(tools_runtime); | |
| } | |
| if (!enabled_tools.empty()) { | |
| if (!common_subproc::is_supported()) { | |
| throw std::runtime_error("subprocess is not enabled on this build"); | |
| } | |
| std::unordered_set<std::string> enabled_set(enabled_tools.begin(), enabled_tools.end()); | |
| auto all_tools = build_tools(); | |
| // collect all known tool names for validation | |
| std::vector<std::string> known_names; | |
| known_names.reserve(all_tools.size()); | |
| for (const auto & t : all_tools) { | |
| known_names.push_back(t->name); | |
| } | |
| // validate that every requested tool is known | |
| for (const auto & name : enabled_tools) { | |
| if (name == "all") continue; | |
| if (std::find(known_names.begin(), known_names.end(), name) == known_names.end()) { | |
| throw std::runtime_error(string_format( | |
| "unknown tool \"%s\". available tools: %s", | |
| name.c_str(), | |
| string_join(known_names, ", ").c_str())); | |
| } | |
| } | |
| tools.clear(); | |
| for (auto & t : all_tools) { | |
| if (enabled_set.count(t->name) > 0 || enabled_set.count("all") > 0) { | |
| tools.push_back(std::move(t)); | |
| } | |
| } | |
| } | |
| // append MCP tools, skipping any that collide with a built-in or another MCP tool of the same "<server>_<tool>" name | |
| if (!mcp_mgr.empty()) { | |
| std::unordered_set<std::string> seen_names; | |
| for (auto & t : tools) { | |
| seen_names.insert(t->name); | |
| } | |
| size_t n_added = 0; | |
| for (const auto & def : mcp_mgr.list_tools()) { | |
| std::string mcp_name = def.server_name + "_" + def.name; | |
| if (seen_names.count(mcp_name)) { | |
| SRV_WRN("MCP tool \"%s\" from server \"%s\" collides with an existing tool, skipping\n", | |
| mcp_name.c_str(), def.server_name.c_str()); | |
| continue; | |
| } | |
| seen_names.insert(mcp_name); | |
| tools.push_back(std::make_unique<server_mcp_tool>(def, mcp_mgr)); | |
| n_added++; | |
| } | |
| if (n_added > 0) { | |
| SRV_INF("Added %zu MCP tools\n", n_added); | |
| } | |
| } | |
| handle_get = [this](const server_http_req &) -> server_http_res_ptr { | |
| auto res = std::make_unique<server_http_res>(); | |
| try { | |
| json result = json::array(); | |
| for (const auto & t : tools) { | |
| result.push_back(t->to_json()); | |
| } | |
| res->data = safe_json_to_str(result); | |
| } catch (const std::exception & e) { | |
| SRV_ERR("got exception: %s\n", e.what()); | |
| res->status = 500; | |
| res->data = safe_json_to_str(format_error_response(e.what(), ERROR_TYPE_SERVER)); | |
| } | |
| return res; | |
| }; | |
| handle_post = [this](const server_http_req & req) -> server_http_res_ptr { | |
| auto res = std::make_unique<server_tools_res>(); | |
| try { | |
| json body = json::parse(req.body); | |
| std::string tool_name = body.at("tool").get<std::string>(); | |
| json params = body.value("params", json::object()); | |
| bool stream = body.value("stream", false); | |
| // accept x-tool-cwd header to override of the process | |
| if (params.contains("cwd")) { | |
| params.erase("cwd"); | |
| } | |
| auto cwd = get_header(req.headers, "x-tool-cwd"); | |
| if (!cwd.empty()) { | |
| params["cwd"] = cwd; | |
| } | |
| // accept x-tool-runtime header to route tool I/O through an isolate, e.g. "docker-container:<id>"; | |
| // falls back to the --tools-runtime isolate, if configured | |
| if (params.contains("runtime")) { | |
| params.erase("runtime"); | |
| } | |
| auto runtime_header = get_header(req.headers, "x-tool-runtime"); | |
| if (!runtime_header.empty()) { | |
| params["runtime"] = runtime_header; | |
| } else if (runtime) { | |
| params["runtime"] = runtime->spec(); | |
| } | |
| server_tool & tool = find_tool(tools, tool_name, stream); | |
| if (stream) { | |
| int id = res_id.fetch_add(1); | |
| queue_res.add_waiting_task_id(id); | |
| res->qr = &queue_res; | |
| res->id = id; | |
| res->worker = std::thread([this, id, &req, &tool, params]() mutable { | |
| server_tool::stream st{queue_res, id, [&req]() { | |
| return !req.should_stop(); | |
| }}; | |
| auto done = std::make_unique<server_tool_stream_result>(); | |
| try { | |
| tool.invoke(params, &st); | |
| } catch (const std::exception & e) { | |
| done->error_msg = e.what(); | |
| } catch (...) { | |
| done->error_msg = "An unknown error occurred"; | |
| } | |
| done->id = st.id; | |
| done->done = true; | |
| st.qr.send(std::move(done)); | |
| }); | |
| res->content_type = "text/event-stream"; | |
| res->status = 200; | |
| res->next = [this, id](std::string & output) -> bool { | |
| auto result = queue_res.recv(id); | |
| auto * r = dynamic_cast<server_tool_stream_result *>(result.get()); | |
| GGML_ASSERT(r != nullptr); | |
| output = "data: " + safe_json_to_str(r->to_json()) + "\n\n"; | |
| if (r->done) { | |
| queue_res.remove_waiting_task_id(id); | |
| return false; | |
| } | |
| return true; | |
| }; | |
| } else { | |
| json result = tool.invoke(params, nullptr); | |
| res->status = 200; | |
| res->data = safe_json_to_str(result); | |
| } | |
| } catch (const json::exception & e) { | |
| res->status = 400; | |
| res->data = safe_json_to_str(format_error_response(e.what(), ERROR_TYPE_INVALID_REQUEST)); | |
| } catch (const std::invalid_argument & e) { | |
| res->status = 404; | |
| res->data = safe_json_to_str(format_error_response(e.what(), ERROR_TYPE_INVALID_REQUEST)); | |
| } catch (const std::exception & e) { | |
| SRV_ERR("got exception: %s\n", e.what()); | |
| res->status = 500; | |
| res->data = safe_json_to_str(format_error_response(e.what(), ERROR_TYPE_SERVER)); | |
| } | |
| return res; | |
| }; | |
| } | |