330 Commits

Author SHA1 Message Date
Dark-Alex-17 7ea3044a37 docs: Documentation for the RESTful API POC 2026-05-01 14:45:13 -06:00
Dark-Alex-17 ca03f6f9d7 test: added integration tests for inter-feature interactions like RAG + Agents, function calling/MCP servers, etc. 2026-05-01 14:06:41 -06:00
Dark-Alex-17 34967f0d97 test: Added unit tests for the rag, completions and prompt, macros, vault, and functions/tool usage 2026-05-01 13:24:58 -06:00
Dark-Alex-17 a4365928d7 test: Added integration tests for the sub-agent spawning system and inter-agent communication mechanisms 2026-05-01 12:53:26 -06:00
Dark-Alex-17 d442dff423 test: unit tests for the sub agent spawning system 2026-05-01 12:20:00 -06:00
Dark-Alex-17 9bb35c82a8 test: REPL command tests and CLI flag tests 2026-05-01 11:57:17 -06:00
Dark-Alex-17 ee16ada962 test: request_context tests 2026-05-01 11:12:30 -06:00
Dark-Alex-17 2a58d8398a test: added tests for input 2026-05-01 11:06:35 -06:00
Dark-Alex-17 a4fe1ee956 test: implemented tests for tool call dispatch and tracking 2026-05-01 10:52:56 -06:00
Dark-Alex-17 f74808c796 test: Implemented tests for the MCP server lifecycle 2026-05-01 10:27:49 -06:00
Dark-Alex-17 98983be609 fix: Accidental shadow of temp_file function for Windows function calling 2026-04-28 08:53:57 -06:00
Dark-Alex-17 1bb281b2a0 style: Addressed style issues 2026-04-28 08:08:23 -06:00
Dark-Alex-17 6c5f696f99 build: updated crossterm version for MacOS 2026-04-23 08:49:26 -06:00
Dark-Alex-17 344bb51c9e feat: legacy SSE support for MCP server configurations 2026-04-20 14:10:26 -06:00
Dark-Alex-17 371329ec9a fix: upgraded to newer rmcp version to get native-tls support 2026-04-20 13:50:34 -06:00
Dark-Alex-17 6dfb9f0601 feat: support http/sse transport types for MCP server configurations so it fully supports claude desktop-style MCP configs 2026-04-20 13:08:20 -06:00
Dark-Alex-17 c64494043f Merge remote-tracking branch 'gitea/restful-api' into restful-api
# Conflicts:
#	docs/PHASE-1-IMPLEMENTATION-PLAN.md
#	src/cli/completer.rs
#	src/client/common.rs
#	src/config/agent.rs
#	src/config/input.rs
#	src/config/macros.rs
#	src/config/mod.rs
#	src/config/session.rs
#	src/function/mod.rs
#	src/function/supervisor.rs
#	src/function/todo.rs
#	src/function/user_interaction.rs
#	src/main.rs
#	src/mcp/mod.rs
#	src/rag/mod.rs
#	src/repl/mod.rs
2026-04-20 09:02:30 -06:00
Dark-Alex-17 30d2ade7a9 refactor: fully complete state re-architecting 2026-04-19 19:21:24 -06:00
Dark-Alex-17 6c2c6f9908 refactor: Fully ripped out the god Config struct 2026-04-19 19:14:25 -06:00
Dark-Alex-17 dc86aaa835 refactor: Deprecated old Config struct initialization logic 2026-04-19 18:27:33 -06:00
Dark-Alex-17 ddabba2dde refactor: migrate functions and MCP servers to AppConfig 2026-04-19 18:14:16 -06:00
Dark-Alex-17 0bb3da091b refactor: Migrate the vault/bare_init logic 2026-04-19 18:00:14 -06:00
Dark-Alex-17 a2b283783a refactor: created a single install_builtins free function to remove from Config::init 2026-04-19 17:54:50 -06:00
Dark-Alex-17 1dc68ca875 refactor: partial migration to init in AppConfig 2026-04-19 17:46:20 -06:00
Dark-Alex-17 227969f3cf fix: RagCache was not being used for agent and sub-agent instantiation 2026-04-19 17:39:49 -06:00
Dark-Alex-17 b32bcf8fbc feat: 99% complete migration to new state structs to get away from God-Config struct; i.e. AppConfig, AppState, and RequestContext 2026-04-19 17:05:27 -06:00
Dark-Alex-17 07bd03625b testing 2026-04-16 10:17:03 -06:00
Dark-Alex-17 c85adfd00e Merge branch 'tree-sitter-tools' into 'develop' 2026-04-09 14:48:22 -06:00
Dark-Alex-17 5b1ddf1848 feat: Automatic runtime customization using shebangs 2026-04-09 14:16:02 -06:00
Dark-Alex-17 473ec251e0 test: Updated client stream tests to use the thread_rng from rand 2026-04-09 13:53:52 -06:00
Dark-Alex-17 402c5a1ec7 build: Pulled additional features for rand dependency 2026-04-09 13:45:08 -06:00
Dark-Alex-17 4f5ead8545 fix: TypeScript function args were being passed as objects rather than direct parameters 2026-04-09 13:32:16 -06:00
Dark-Alex-17 36cced560a build: upgraded dependencies to latest 2026-04-09 13:28:19 -06:00
Dark-Alex-17 0d6efbf1f3 docs: Updated docs to talk about the new TypeScript-based tool support 2026-04-09 13:19:15 -06:00
Dark-Alex-17 bbfb489a67 feat: Created a demo TypeScript tool and a get_current_weather function in TypeScript 2026-04-09 13:18:41 -06:00
Dark-Alex-17 0f7548685c feat: Updated the Python demo tool to show all possible parameter types and variations 2026-04-09 13:18:18 -06:00
Dark-Alex-17 fab266f7b9 fix: Added in forgotten wrapper scripts for TypeScript tools 2026-04-09 13:17:53 -06:00
Dark-Alex-17 48bb2fce87 feat: Added TypeScript tool support using the refactored common ScriptedLanguage trait 2026-04-09 13:17:28 -06:00
Dark-Alex-17 ad2ab6ed49 refactor: Extracted common Python parser logic into a common.rs module 2026-04-09 13:16:35 -06:00
Dark-Alex-17 bb2cad0526 refactor: python tools now use tree-sitter queries instead of AST 2026-04-09 10:20:49 -06:00
Dark-Alex-17 0db5f634a4 fix: don't shadow variables in binary path handling for Windows 2026-04-09 07:53:18 -06:00
Dark-Alex-17 dbda5abdab build: Upgraded crossterm and reedline dependencies 2026-04-08 14:54:53 -06:00
Dark-Alex-17 3a040ae3bb fix: Tool call improvements for Windows systems 2026-04-08 12:49:43 -06:00
github-actions[bot] deb25f639f chore: bump Cargo.toml to 0.3.0 2026-04-02 20:17:47 +00:00
github-actions[bot] 10c38fa612 bump: version 0.2.0 → 0.3.0 [skip ci] 2026-04-02 20:17:45 +00:00
Dark-Alex-17 3a734e27dc feat: Added todo__clear function to the todo system and updated REPL commands to have a .clear todo as well for significant changes in agent direction 2026-04-02 13:13:44 -06:00
Dark-Alex-17 41200a71f6 fix: Clarified user text input interaction 2026-03-30 16:27:22 -06:00
Dark-Alex-17 b19655087e fix: recursion bug with similarly named Bash search functions in the explore agent 2026-03-30 13:32:13 -06:00
Dark-Alex-17 c13cb18d93 feat: Added available tools to prompts for sisyphus and code-reviewer agent families 2026-03-30 13:13:30 -06:00
Dark-Alex-17 0925acf86a feat: Added available tools to coder prompt 2026-03-30 11:11:43 -06:00
Dark-Alex-17 f8cbb1549e Merge branch 'main' of github.com:Dark-Alex-17/loki 2026-03-30 10:15:51 -06:00
Dark-Alex-17 a46f6da0d8 fix: updated the error for unauthenticated oauth to include the REPL .authenticated command 2026-03-28 11:57:01 -06:00
Dark-Alex-17 7c9fb8eb71 feat: Improved token efficiency when delegating from sisyphus -> coder 2026-03-18 15:07:29 -06:00
Dark-Alex-17 223e7ca4c5 build: Removed deprecated agent functions from the .shared/utils.sh script 2026-03-18 15:04:14 -06:00
Dark-Alex-17 0fdb1bbc42 fix: Corrected a bug in the coder agent that wasn't outputting a summary of the changes made, so the parent Sisyphus agent has no idea if the agent worked or not 2026-03-17 14:57:07 -06:00
Dark-Alex-17 16cdf47101 feat: modified sisyphus agents to use the new ddg-search MCP server for web searches instead of built-in model searches 2026-03-17 14:55:33 -06:00
Dark-Alex-17 6555ecfafc fix: Claude code system prompt injected into claude requests to make them valid once again 2026-03-17 10:44:50 -06:00
Dark-Alex-17 a586ca40e2 fix: Do not inject tools when models don't support them; detect this conflict before API calls happen 2026-03-17 09:35:51 -06:00
Dark-Alex-17 435667fac8 style: Applied formatting across new inquire files 2026-03-16 12:39:20 -06:00
Dark-Alex-17 fd3385bad8 feat: Added support for specifying a custom response to multiple-choice prompts when nothing suits the user's needs 2026-03-16 12:37:47 -06:00
Dark-Alex-17 16adae7bc3 feat: Supported theming in the inquire prompts in the REPL 2026-03-16 12:36:20 -06:00
Dark-Alex-17 639f6e2a1a build: upgraded to the most recent version of the inquire crate 2026-03-16 12:31:28 -06:00
Dark-Alex-17 cc4d2f6256 docs: Fixed a spacing issue in the example agent configuration 2026-03-13 14:19:39 -06:00
Dark-Alex-17 d8d757b060 docs: Added the file-reviewer agent to the AGENTS docs 2026-03-13 14:07:13 -06:00
Dark-Alex-17 32a9861369 docs: Updated the MCP-SERVERS docs to mention the ddg-search MCP server 2026-03-13 13:32:58 -06:00
Dark-Alex-17 922fa05b06 feat: Added the duckduckgo-search MCP server for searching the web (in addition to the built-in tools for web searches) 2026-03-13 13:29:56 -06:00
Dark-Alex-17 4cc6bccf87 Merge branch 'main' of github.com:Dark-Alex-17/loki 2026-03-12 15:17:54 -06:00
Dark-Alex-17 de3012e664 fix: Implemented the path normalization fix for the oracle and explore agents 2026-03-12 13:38:15 -06:00
Dark-Alex-17 3daac0b1cf chore: Added GPT-5.2 to models.yaml 2026-03-12 13:30:23 -06:00
Dark-Alex-17 4260088ed1 docs: Updated the docs to now explicitly mention Gemini OAuth support 2026-03-12 13:30:10 -06:00
Dark-Alex-17 cb24c7ac91 feat: Support for Gemini OAuth 2026-03-12 13:29:47 -06:00
Dark-Alex-17 5fcba4c5ab refactor: Made the oauth module more generic so it can support loopback OAuth (not just manual) 2026-03-12 13:28:09 -06:00
Dark-Alex-17 024dd5ff59 fix: Updated the atlassian MCP server endpoint to account for future deprecation 2026-03-12 12:49:26 -06:00
Dark-Alex-17 0e931a472e fix: Fixed a bug in the coder agent that was causing the agent to create absolute paths from the current directory 2026-03-12 12:39:49 -06:00
Dark-Alex-17 3ff6e3cca9 fix: The REPL .authenticate command works from within sessions, agents, and roles with pre-configured models 2026-03-12 09:08:17 -06:00
Dark-Alex-17 2e30b19479 feat: Support authenticating or refreshing OAuth for supported clients from within the REPL 2026-03-11 13:07:27 -06:00
Dark-Alex-17 208ed838e6 fix: the updated regex for secrets injection broke MCP server secrets interpolation because the regex greedily matched on new lines, replacing too much content. This fix just ignores commented out lines in YAML files by skipping commented out lines. 2026-03-11 12:55:28 -06:00
Dark-Alex-17 8380ae5d7a feat: Allow first-runs to select OAuth for supported providers 2026-03-11 12:01:17 -06:00
Dark-Alex-17 97b902441e fix: Don't try to inject secrets into commented-out lines in the config 2026-03-11 11:11:09 -06:00
Dark-Alex-17 15df5be307 feat: Support OAuth authentication flows for Claude 2026-03-11 11:10:48 -06:00
Dark-Alex-17 658f8f32dd chore: Added support for Claude 4.6 gen models 2026-03-10 14:55:30 -06:00
Dark-Alex-17 f3ee71d3f2 fix: Removed top_p parameter from some agents so they can work across model providers 2026-03-10 10:18:38 -06:00
Dark-Alex-17 719b482be9 Merge branch 'main' of github.com:Dark-Alex-17/loki 2026-03-09 14:58:23 -06:00
Dark-Alex-17 f7b589ac2b chore: Added the new gemini-3.1-pro-preview model to gemini and vertex models 2026-03-09 14:57:39 -06:00
Dark-Alex-17 cea08d804e docs: created an authorship policy and PR template that requires disclosure of AI assistance in contributions 2026-02-24 17:46:07 -07:00
Dark-Alex-17 53cc3a27fe style: Applied formatting to MCP module 2026-02-20 15:28:21 -07:00
Dark-Alex-17 0f3cf511e0 docs: Updated sisyphus README to always include the execute_command.sh tool 2026-02-20 15:06:57 -07:00
Dark-Alex-17 f8b965d801 docs: Updated the sisyphus system docs to have a pro-tip of configuring an IDE MCP server to improve performance 2026-02-20 15:01:08 -07:00
Dark-Alex-17 2cb68846b6 docs: Created README docs for the CodeRabbit-style Code reviewer agents 2026-02-20 15:00:32 -07:00
Dark-Alex-17 1e18c7a7e2 feat: Improved MCP server spinup and spindown when switching contexts or settings in the REPL: Modify existing config rather than stopping all servers always and re-initializing if unnecessary 2026-02-20 14:36:34 -07:00
Dark-Alex-17 caeed16d36 fix: Improved sub-agent stdout and stderr output for users to follow 2026-02-20 13:47:28 -07:00
Dark-Alex-17 7ab36dce90 Update models.yaml with latest OpenRouter data 2026-02-20 12:08:00 -07:00
Dark-Alex-17 f8a72f819e Add script to update models.yaml from OpenRouter 2026-02-20 12:07:59 -07:00
Dark-Alex-17 306a880257 fix: Inject agent variables into environment variables for global tool calls when invoked from agents to modify global tool behavior 2026-02-20 11:38:24 -07:00
Dark-Alex-17 59cca849a8 feat: Allow the explore agent to run search queries for understanding docs or API specs 2026-02-19 14:29:02 -07:00
Dark-Alex-17 42a1665960 feat: Allow the oracle to perform web searches for deeper research 2026-02-19 14:26:07 -07:00
Dark-Alex-17 687a4ea3bc fix: Removed the unnecessary execute_commands tool from the oracle agent 2026-02-19 14:18:16 -07:00
Dark-Alex-17 77c1c2aa6f fix: Added auto_confirm to the coder agent so sub-agent spawning doesn't freeze 2026-02-19 14:15:42 -07:00
Dark-Alex-17 3d0bbd59d1 feat: Added web search support to the main sisyphus agent to answer user queries 2026-02-19 12:29:07 -07:00
Dark-Alex-17 39f1511fea refactor: Changed the default session name for Sisyphus to temp (to require users to explicitly name sessions they wish to save) 2026-02-19 10:26:52 -07:00
Dark-Alex-17 b5b3dc5ba8 fix: Fixed a bug in the new supervisor and todo built-ins that was causing errors with OpenAI models 2026-02-18 14:52:57 -07:00
Dark-Alex-17 ad8be61a3b fix: Added condition to sisyphus to always output a summary to clearly indicate completion 2026-02-18 13:57:51 -07:00
Dark-Alex-17 4f4db10c8d fix: Updated the sisyphus prompt to explicitly tell it to delegate to the coder agent when it wants to write any code at all except for trivial changes 2026-02-18 13:51:43 -07:00
Dark-Alex-17 a430d59e9c fix: Added back in the auto_confirm variable into sisyphus 2026-02-18 13:42:39 -07:00
Dark-Alex-17 5f1734d69a fix: Removed the now unnecessary is_stale_response that was breaking auto-continuing with parallel agents 2026-02-18 13:36:25 -07:00
Dark-Alex-17 a34adc5adf style: Applied formatting to the function module 2026-02-18 13:20:18 -07:00
Dark-Alex-17 96c1d47d7f build: Upgraded to the most recent version of rmcp 2026-02-18 12:28:52 -07:00
Dark-Alex-17 7701a02b16 refactor: Updated the sisyphus agent to use the built-in user interaction tools instead of custom bash-based tools 2026-02-18 12:17:35 -07:00
Dark-Alex-17 ece9cadad5 feat: Created a CodeRabbit-style code-reviewer agent 2026-02-18 12:16:59 -07:00
Dark-Alex-17 738f39917d docs: Updated the docs to include details on the new agent spawning system and built-in user interaction tools 2026-02-18 12:16:29 -07:00
Dark-Alex-17 b95649177d fix: Bypassed enabled_tools for user interaction tools so if function calling is enabled at all, the LLM has access to the user interaction tools when in REPL mode 2026-02-18 11:25:25 -07:00
Dark-Alex-17 6f977307e6 feat: Added configuration option in agents to indicate the timeout for user input before proceeding (defaults to 5 minutes) 2026-02-18 11:24:47 -07:00
Dark-Alex-17 9a715b2fb2 feat: Added support for sub-agents to escalate user interaction requests from any depth to the parent agents for user interactions 2026-02-18 11:06:15 -07:00
Dark-Alex-17 930861d49b feat: built-in user interaction tools to remove the need for the list/confirm/etc prompts in prompt tools and to enhance user interactions in Loki 2026-02-18 11:05:43 -07:00
Dark-Alex-17 31987c9f94 fix: When parallel agents run, only write to stdout from the parent and only display the parent's throbber 2026-02-18 09:59:24 -07:00
Dark-Alex-17 fe7401c935 refactor: Cleaned up some left-over implementation stubs 2026-02-18 09:13:39 -07:00
Dark-Alex-17 543e62fe7d fix: Forgot to implement support for failing a task and keep all dependents blocked 2026-02-18 09:13:11 -07:00
Dark-Alex-17 0ec8cd4d00 fix: Clean up orphaned sub-agents when the parent agent 2026-02-18 09:12:32 -07:00
Dark-Alex-17 a469a6cf06 fix: Fixed the bash prompt utils so that they correctly show output when being run by a tool invocation 2026-02-17 17:19:42 -07:00
Dark-Alex-17 0e67e0f85a feat: Experimental update to sisyphus to use the new parallel agent spawning system 2026-02-17 16:33:08 -07:00
Dark-Alex-17 bf862d8021 fix: Forgot to automatically add the bidirectional communication back up to parent agents from sub-agents (i.e. need to be able to check inbox and send messages) 2026-02-17 16:11:35 -07:00
Dark-Alex-17 c070d151fa feat: Added an agent configuration property that allows auto-injecting sub-agent spawning instructions (when using the built-in sub-agent spawning system) 2026-02-17 15:49:40 -07:00
Dark-Alex-17 3147ad59f3 feat: Auto-dispatch support of sub-agents and support for the teammate pattern between subagents 2026-02-17 15:18:27 -07:00
Dark-Alex-17 f9d2adf33a docs: Initial documentation cleanup of parallel agent MVP 2026-02-17 14:30:28 -07:00
Dark-Alex-17 eaa224aeb9 fix: Agent delegation tools were not being passed into the {{__tools__}} placeholder so agents weren't delegating to subagents 2026-02-17 14:19:22 -07:00
Dark-Alex-17 81a81d035e feat: Full passive task queue integration for parallelization of subagents 2026-02-17 13:42:53 -07:00
Dark-Alex-17 5c5d70e4d0 feat: Implemented initial scaffolding for built-in sub-agent spawning tool call operations 2026-02-17 11:48:31 -07:00
Dark-Alex-17 ad563d4263 feat: Initial models for agent parallelization 2026-02-17 11:27:55 -07:00
Dark-Alex-17 016501ef4f docs: Fixed typos in the Sisyphus documentation 2026-02-16 14:05:51 -07:00
Dark-Alex-17 0b36d17ea0 feat: Added interactive prompting between the LLM and the user in Sisyphus using the built-in Bash utils scripts 2026-02-16 13:57:04 -07:00
github-actions[bot] faf92f9fe8 chore: bump Cargo.toml to 0.2.0 2026-02-14 01:41:41 +00:00
github-actions[bot] 2c7abace37 bump: version 0.1.3 → 0.2.0 [skip ci] 2026-02-14 01:41:29 +00:00
Dark-Alex-17 3a7128f3de feat: Simplified sisyphus prompt to improve functionality 2026-02-13 18:36:10 -07:00
Dark-Alex-17 0b8bae64d1 feat: Supported the injection of RAG sources into the prompt, not just via the .sources rag command in the REPL so models can directly reference the documents that supported their responses 2026-02-13 17:45:56 -07:00
Dark-Alex-17 9c4543ceb5 docs: updated the tools documentation to mention the new fs_read, fs_grep, and fs_glob tools 2026-02-13 16:53:00 -07:00
Dark-Alex-17 0b7bb7a816 docs: updated the default configuration example to have the new fs_read, fs_glob, fs_grep global functions 2026-02-13 16:23:49 -07:00
Dark-Alex-17 ee496e5792 docs: Updated the docs to mention the new agents 2026-02-13 15:42:28 -07:00
Dark-Alex-17 05cb8548cf feat: Created the Sisyphus agent to make Loki function like Claude Code, Gemini, Codex, etc. 2026-02-13 15:42:10 -07:00
Dark-Alex-17 57d62087f5 feat: Created the Oracle agent to handle high-level architectural decisions and design questions about a given codebase 2026-02-13 15:41:44 -07:00
Dark-Alex-17 a1f8250f58 feat: Updated the coder agent to be much more task-focused and to be delegated to by Sisyphus 2026-02-13 15:41:11 -07:00
Dark-Alex-17 194849eaab feat: Created the explore agent for exploring codebases to help answer questions 2026-02-13 15:40:46 -07:00
Dark-Alex-17 f8330523db docs: Updated todo-system docs 2026-02-13 15:13:37 -07:00
Dark-Alex-17 2a7af1531d feat: Use the official atlassian MCP server for the jira-helper agent 2026-02-13 14:56:42 -07:00
Dark-Alex-17 8f858a3d3c feat: Created fs_glob to enable more targeted file exploration utilities 2026-02-13 13:31:50 -07:00
Dark-Alex-17 51211ab1a6 feat: Created a new tool 'fs_grep' to search a given file's contents for relevant lines to reduce token usage for smaller models 2026-02-13 13:31:20 -07:00
Dark-Alex-17 4dad7d6c78 feat: Created the new fs_read tool to enable controlled reading of a file 2026-02-13 13:30:53 -07:00
Dark-Alex-17 1fa9886e7a feat: Let agent level variables be defined to bypass guard protections for tool invocations 2026-02-09 16:45:11 -07:00
Dark-Alex-17 2370525f38 fix: Improved continuation prompt to not make broad todo-items 2026-02-09 15:36:57 -07:00
Dark-Alex-17 3a131f19ee fix: Allow auto-continuation to work in agents after a session is compressed and if there's still unfinish items in the to-do list 2026-02-09 15:21:39 -07:00
Dark-Alex-17 f59286e7a7 fix: fs_ls and fs_cat outputs should always redirect to "$LLM_OUTPUT" including on errors. 2026-02-09 14:56:55 -07:00
Dark-Alex-17 79b0d044a8 feat: Implemented a built-in task management system to help smaller LLMs complete larger multistep tasks and minimize context drift 2026-02-09 12:49:06 -07:00
Dark-Alex-17 423921276d feat: Improved tool and MCP invocation error handling by returning stderr to the model when it is available 2026-02-04 12:00:21 -07:00
Dark-Alex-17 b0799e7fc6 feat: Added variable interpolation for conversation starters in agents 2026-02-04 10:51:59 -07:00
Dark-Alex-17 1b4adec4c3 build: Upgraded to the most recent version of gman to fix vault vulnerabilities 2026-02-03 09:24:53 -07:00
Dark-Alex-17 de0d8114b3 feat: Implemented retry logic for failed tool invocations so the LLM can learn from the result and try again; Also implemented chain loop detection to prevent loops 2026-02-01 17:06:16 -07:00
Dark-Alex-17 113db42ff5 fix: Claude tool calls work incorrectly when tool doesn't require any arguments or flags; would provide an empty JSON object or error on no args 2026-02-01 17:05:36 -07:00
Dark-Alex-17 3715725cbb feat: Added gemini-3-pro to the supported vertexai models 2026-01-30 19:03:41 -07:00
Dark-Alex-17 f08d91936b Fixed some typos in tool call error messages 2026-01-30 12:25:57 -07:00
Dark-Alex-17 76c2dde2aa build: Created justfile to make life easier 2026-01-27 13:49:36 -07:00
Dark-Alex-17 e9a53afc88 docs: Created a CREDITS file to document the history and origins of Loki from the original AIChat project 2026-01-27 13:15:20 -07:00
Dark-Alex-17 2d4b576977 build: Support Claude Opus 4.5 2026-01-26 12:40:06 -07:00
Dark-Alex-17 9d70569878 feat: Added an environment variable that lets users bypass guard operations in bash scripts. This is useful for agent routing 2026-01-23 14:18:52 -07:00
Dark-Alex-17 e08220f059 fix: Fixed a bug where --agent-variable values were not being passed to the agents 2026-01-23 14:15:59 -07:00
Dark-Alex-17 a9179a53cc feat: Added support for thought-signatures for Gemini 3+ models 2026-01-21 15:11:55 -07:00
Dark-Alex-17 d1c3adc565 style: Cleaned up an anyhow error 2025-12-16 14:51:35 -07:00
github-actions[bot] 10d49c86c4 bump: version 0.1.2 → 0.1.3 [skip ci] 2025-12-13 20:57:37 +00:00
Dark-Alex-17 562caeaa16 ci: Prep for 0.1.3 release 2025-12-13 13:38:09 -07:00
Dark-Alex-17 1ea5003c0c style: Improved error message for un-fully configured MCP configuration 2025-12-13 13:37:01 -07:00
github-actions[bot] 7175f86906 chore: bump Cargo.toml to 0.1.3 2025-12-13 20:28:10 +00:00
github-actions[bot] 2541f574f6 bump: version 0.1.2 → 0.1.3 [skip ci] 2025-12-13 20:27:58 +00:00
Dark-Alex-17 b3c327914a chore: Updated the models 2025-12-11 09:05:41 -07:00
Dark-Alex-17 4bc7661efa docs: Removed the warning about MCP token usage since that has been fixed 2025-12-05 12:38:15 -07:00
Dark-Alex-17 f075a6f0a3 docs: Fixed an unclosed backtick typo in the Environment Variables docs 2025-12-05 12:37:59 -07:00
Dark-Alex-17 c2e8e85b32 docs: Fixed typo in vault readme 2025-12-05 11:05:14 -07:00
Dark-Alex-17 aff14c9b88 style: Applied formatting 2025-12-03 15:06:50 -07:00
Dark-Alex-17 72e99734e6 Merge branch 'main' of github.com:Dark-Alex-17/loki 2025-12-03 14:57:03 -07:00
Dark-Alex-17 1af148e767 feat: Improved MCP implementation to minimize the tokens needed to utilize it so it doesn't quickly overwhelm the token space for a given model 2025-12-03 12:12:51 -07:00
Alex Clarke da3c766cfa ci: Updated the README to be a bit more clear in some sections 2025-11-26 15:53:54 -07:00
github-actions[bot] 181acf61d2 bump: version 0.1.1 → 0.1.2 [skip ci] 2025-11-08 23:13:34 +00:00
Dark-Alex-17 ff472c61d9 refactor: Gave the GitHub MCP server a default placeholder value that doesn't require the vault 2025-11-08 16:09:32 -07:00
github-actions[bot] 83c13f32e8 bump: version 0.1.1 → 0.1.2 [skip ci] 2025-11-08 23:02:40 +00:00
Dark-Alex-17 108203f763 bug: Removed the github MCP server and slack MCP server from mcp.json so users can just use Loki without any other setup and add more later 2025-11-08 15:59:05 -07:00
Alex Clarke 970705377a build: Removed the remaining IDE metadata directories 2025-11-07 18:21:58 -07:00
Dark-Alex-17 35018c1462 build: Added forgotten IDE configuration directories into my .gitignore 2025-11-07 18:18:32 -07:00
github-actions[bot] 0f345a5042 bump: version 0.1.0 → 0.1.1 [skip ci] 2025-11-08 00:22:06 +00:00
Dark-Alex-17 68ec599793 docs: Fixed a typo in the CI badge path 2025-11-07 17:17:57 -07:00
Dark-Alex-17 a9d5f8a4d7 docs: Fixed some confusing wording in the global configuration example file 2025-11-07 16:57:49 -07:00
github-actions[bot] c9bc9952df bump: version 0.0.1 → 0.1.0 [skip ci] 2025-11-07 23:47:37 +00:00
Dark-Alex-17 80ae76b6ec ci: Final release checks before open sourcing the repo 2025-11-07 16:43:50 -07:00
Dark-Alex-17 57da3f43e8 Merge remote-tracking branch 'origin/main' 2025-11-07 16:24:47 -07:00
Dark-Alex-17 365d4510a5 docs: Fixed a typo in the Vault documentation 2025-11-07 16:24:42 -07:00
github-actions[bot] 565b37c14a bump: version 0.0.1 → 0.1.0 [skip ci] 2025-11-07 23:19:04 +00:00
Dark-Alex-17 190c15d214 ci: Prepare for release 2025-11-07 16:18:16 -07:00
Dark-Alex-17 faf8fdb213 bump: version 0.0.1 → 0.1.0 2025-11-07 16:11:14 -07:00
Dark-Alex-17 fdc38a0b18 refactor: Updated to the most recent Rust version with 2024 syntax 2025-11-07 15:50:55 -07:00
github-actions[bot] c7d72ac22d bump: version 0.1.0 → 0.2.0 [skip ci] 2025-11-07 22:04:11 +00:00
Dark-Alex-17 c1a4d021a1 ci: Bumped the patch version 2025-11-07 15:03:31 -07:00
Dark-Alex-17 9cb4e4d1bc build: bumped the crate version 2025-11-07 14:59:41 -07:00
Dark-Alex-17 62ce4f34f8 docs: Added badges for Loki 2025-11-07 14:24:25 -07:00
Dark-Alex-17 b914e90da5 ci: Fixed typo in commit message for homebrew tap 2025-11-07 14:24:13 -07:00
Dark-Alex-17 fdc312306d build: Renamed the crate to loki-ai since loki is taken 2025-11-07 14:16:02 -07:00
Dark-Alex-17 9852245469 ci: Created the homebrew installation steps 2025-11-07 13:53:28 -07:00
Dark-Alex-17 2cb099e378 ci: Created the release pipeline 2025-11-07 13:51:53 -07:00
Dark-Alex-17 fba8e26f5b docs: Updated the README to credit the AIChat team and to offer quick links to get around the docs 2025-11-07 13:49:26 -07:00
Dark-Alex-17 60dc712bdd docs: Wrote migration documentation for users coming from AIChat 2025-11-07 13:49:02 -07:00
Dark-Alex-17 ba6d8002e1 docs: Added a simple gif to show what the models table looks like for tab completions 2025-11-07 13:48:48 -07:00
Dark-Alex-17 c9781d0062 docs: Replaced the copy gif with one that better shows that the content is copied to your clipboard 2025-11-07 13:48:30 -07:00
Dark-Alex-17 48a9f84d6c docs: Updated the continue gif to use a prompt that makes more sense 2025-11-07 13:48:09 -07:00
Dark-Alex-17 b874be4b36 docs: Updated the set gif to show the up-to-date settings names 2025-11-07 13:47:57 -07:00
Dark-Alex-17 3d34d6e273 docs: Updated the regenerate gif to use the up-to-date settings names 2025-11-07 13:47:41 -07:00
Dark-Alex-17 040ce15b55 docs: Created docs for the REPL 2025-11-07 13:47:20 -07:00
Dark-Alex-17 411812875a docs: Documented all available environment variables 2025-11-07 13:47:10 -07:00
Dark-Alex-17 06bacd47ad docs: Added back in the conversation starters gif for the agent docs 2025-11-07 13:46:53 -07:00
Dark-Alex-17 7056818808 docs: Made an example agent gif to show how they work (and variables) 2025-11-07 13:46:35 -07:00
Dark-Alex-17 67b4510d94 docs: Created documentation for agents 2025-11-07 13:46:16 -07:00
Dark-Alex-17 2e74619b03 docs: Added a screenshot of the tools overrides settings 2025-11-07 13:46:00 -07:00
Dark-Alex-17 727ff52ff7 docs: Created docs about both built-in and custom tools for function calling capabilities 2025-11-07 13:45:45 -07:00
Dark-Alex-17 33cb6aaf1f docs: Documented how to create custom tools in Python, and how custom tools are created and used 2025-11-07 13:45:23 -07:00
Dark-Alex-17 2dfab3d399 docs: Documented how to create custom Bash-based tools 2025-11-07 13:45:01 -07:00
Dark-Alex-17 bcbd0e7be1 docs: Added back in forgotten gif of a session 2025-11-07 13:44:44 -07:00
Dark-Alex-17 8ccc61e831 docs: documentation on how sessions work in Loki 2025-11-07 13:44:32 -07:00
Dark-Alex-17 a1656da7a2 docs: Created a demo gif of how to use roles in general 2025-11-07 13:44:16 -07:00
Dark-Alex-17 499d396802 docs: Created a demo gif of a temporary prompt role 2025-11-07 13:44:00 -07:00
Dark-Alex-17 bdfc9ca062 docs: Documented roles 2025-11-07 13:43:37 -07:00
Dark-Alex-17 120368178d docs: created a gif that demonstrates macro functionality 2025-11-07 13:43:26 -07:00
Dark-Alex-17 783dc76285 docs: Removed a forgotten TODO comment 2025-11-07 13:43:09 -07:00
Dark-Alex-17 cf1f5d39a1 docs: created a screenshot of the global settings overrides for MCP servers 2025-11-07 13:42:36 -07:00
Dark-Alex-17 beb4c54ea5 docs: created screenshots for both ephemeral and persistent RAG 2025-11-07 13:42:15 -07:00
Dark-Alex-17 9573c88efd docs: documented RAG 2025-11-07 13:41:50 -07:00
Dark-Alex-17 7b339e35f8 docs: Created docs that explain how to use MCP servers with Loki 2025-11-07 13:41:19 -07:00
Dark-Alex-17 ed3f4b23f8 docs: created docs for Loki's macro system 2025-11-07 13:40:48 -07:00
Dark-Alex-17 8b2c23f598 docs: documented how to use custom themes 2025-11-07 13:40:25 -07:00
Dark-Alex-17 5f227988bb docs: documented how to create custom REPL prompts 2025-11-07 13:40:10 -07:00
Dark-Alex-17 82e2bcbce4 docs: documented the now built-in bash helper script and the tools it comes with 2025-11-07 13:39:53 -07:00
Dark-Alex-17 4277226ca1 docs: created documentation for how to patch requests via configuration settings 2025-11-07 13:39:04 -07:00
Dark-Alex-17 21ccc7af86 docs: created documentation for client configurations 2025-11-07 13:38:34 -07:00
Dark-Alex-17 f1a2570d41 docs: updated the vault demo screenshots and gifs 2025-11-07 13:38:22 -07:00
Dark-Alex-17 e977864158 docs: Added screenshots for select custom themes 2025-11-07 13:37:56 -07:00
Dark-Alex-17 4b8085b142 docs: Added documentation for secret injection support into environment variables for agents 2025-11-07 12:28:11 -07:00
Dark-Alex-17 832bc419dd docs: Added an explain-shell screenshot 2025-11-07 12:26:43 -07:00
Dark-Alex-17 0ceae6a98f docs: Fixed a typo in the shell integrations documentation 2025-11-07 12:25:26 -07:00
Dark-Alex-17 922e4f4b1a docs: Created license 2025-11-07 11:48:19 -07:00
Dark-Alex-17 7b68077f7a ci: Created Loki installation scripts 2025-11-07 11:48:08 -07:00
Dark-Alex-17 7f359af72c refactor: Changed the name of the summary_prompt setting to summary_context_prompt 2025-11-07 11:13:58 -07:00
Dark-Alex-17 1330ff72ce refactor: Renamed summarize_prompt setting to summarization_prompt 2025-11-07 11:09:48 -07:00
Dark-Alex-17 288e1fa234 refactor: Renamed the compress_threshold setting to compression_threshold 2025-11-07 11:06:20 -07:00
Dark-Alex-17 71f33cb87a style: Applied formatting 2025-11-06 18:19:25 -07:00
Dark-Alex-17 afeb634b94 refactor: Migrated around the location of some of the more large documents for documentation 2025-11-06 18:02:17 -07:00
Dark-Alex-17 72ad69b401 docs: Updated the global configuration example to have a separate section for the REPL prompts 2025-11-06 16:24:20 -07:00
Dark-Alex-17 c1ac4d9032 docs: Fixed a typo in the description of the stream setting 2025-11-06 16:10:44 -07:00
Dark-Alex-17 9f9ef10da9 docs: Referenced the vault documentation in the example config 2025-11-06 16:09:21 -07:00
Dark-Alex-17 a44e58547e docs: Created a separate, dedicated section of the example configuration file for the vault 2025-11-06 16:08:20 -07:00
Dark-Alex-17 7d5e5fce76 docs: Improved the documentation for sessions and the examples in the global configuration example 2025-11-06 15:55:38 -07:00
Dark-Alex-17 610bebaae1 docs: Improved the documentation of preludes and their purpose in the example global configuration file 2025-11-06 15:48:44 -07:00
Dark-Alex-17 aa1b7d57a4 docs: Improved the documentation of the behavior-related settings of the global configuration file example 2025-11-06 15:47:30 -07:00
Dark-Alex-17 2c8daca20c docs: Improved wording in the example agent configuration 2025-11-06 13:55:44 -07:00
Dark-Alex-17 a13f771925 docs: Updated the example agent configuration to show the new global_tools and mcp_servers environment variables 2025-11-06 13:31:25 -07:00
Dark-Alex-17 0b23f1174b feat: Added the agents directory to sysinfo output 2025-11-06 13:22:13 -07:00
Dark-Alex-17 f09a06365b docs: Fixed a typo in the Vertex AI client configuration example in the example global configuration file 2025-11-06 13:07:34 -07:00
Dark-Alex-17 e9071c8b82 Added environment variables for agents for the global_tools and mcp_servers settings 2025-11-06 12:16:36 -07:00
Dark-Alex-17 5959cbd809 docs: Updated the example global configuration file with some better examples for RAG 2025-11-06 10:49:51 -07:00
Dark-Alex-17 19597735b8 docs: Created an example macro configuration file 2025-11-05 16:55:04 -07:00
Dark-Alex-17 aa171c6e6d feat: Added built-in macros 2025-11-05 16:28:56 -07:00
Dark-Alex-17 22939a53a9 bug: Removed deprecated experimentation for MCP sampling 2025-11-05 16:12:04 -07:00
Dark-Alex-17 f076373859 style: Added an import for Anyhow's Result in the macros module 2025-11-05 15:52:44 -07:00
Dark-Alex-17 528c3ae657 refactor: Factored out the macros structs from the large config module 2025-11-05 15:50:39 -07:00
Dark-Alex-17 e0e0f519fb bug: Fixed a bug with the spacing of info output now that function_calling_support is a longer name 2025-11-05 15:41:49 -07:00
Dark-Alex-17 8feb292738 feat: Updated the example role configuration file to also have the prompt field 2025-11-05 15:25:01 -07:00
Dark-Alex-17 17abfe9aa4 feat: Updated the code role 2025-11-05 15:24:45 -07:00
Dark-Alex-17 441e472328 refactor: Refactored mcp_servers and function_calling to mcp_server_support and function_calling_support to make the purpose of the fields more clear 2025-11-04 13:17:58 -07:00
Dark-Alex-17 89cf081749 refactor: Refactored the use_mcp_servers field to enabled_mcp_servers to make the purpose of the field more clear 2025-11-04 12:51:41 -07:00
Dark-Alex-17 872ac62e81 Merge branch 'main' of github.com:Dark-Alex-17/loki 2025-11-04 12:37:32 -07:00
Dark-Alex-17 9de95ca21d refactor: Refactored use_tools field to enabled_tools field to make the use of the field more clear 2025-11-04 12:37:14 -07:00
Dark-Alex-17 3af07cabe8 Refactored the use_tools field to enabled_tools to make field uses and functions more clear 2025-11-04 12:36:31 -07:00
Dark-Alex-17 5719ff2e79 docs: Updated the config.example.yaml to have an example of how to use the visible_tools array 2025-11-04 12:10:17 -07:00
Dark-Alex-17 84556cb706 refactor: Removed the use of the tools.txt file and added tool visibility declarations to the global configuration file 2025-11-04 12:07:58 -07:00
Dark-Alex-17 0983868196 refactor: Agents that depend on global tools now have all binaries compiled and stored in the agent's bin directory so multiple agents can run at once 2025-11-04 11:29:59 -07:00
Dark-Alex-17 382926243c feat: Secret injection as environment variables into agent tools 2025-11-03 15:10:34 -07:00
Dark-Alex-17 467afb6767 feat: Removed the server functionality 2025-11-03 14:25:55 -07:00
Dark-Alex-17 73356b4a76 feat: Require Vault set up for first-time setup so all passed in secrets can be encrypted right off the bat 2025-10-27 12:00:27 -06:00
Dark-Alex-17 34d4681b38 style: Re-applied formatting to make Clippy happy 2025-10-24 15:05:42 -06:00
Dark-Alex-17 aa980b0a96 refactor: Removed the git MCP server and used the newer, better mcp-server-docker for local docker integration 2025-10-24 14:38:13 -06:00
Dark-Alex-17 397db60782 docs: Added in forgotten MCP server configuration values to the example config 2025-10-24 14:16:13 -06:00
Dark-Alex-17 57c5c35c37 Created an Elvish integration script 2025-10-24 11:28:31 -06:00
Dark-Alex-17 7ab9fea439 refactor: Renamed the argument for the --completions flag to SHELL 2025-10-24 10:58:28 -06:00
Dark-Alex-17 4c0514d8e9 feat: Added static completions via a --completions flag 2025-10-24 10:56:34 -06:00
Dark-Alex-17 2fb9d2fa86 refactor: Updated the instructions for the jira-helper agent 2025-10-23 10:07:50 -06:00
Dark-Alex-17 f57a134bc0 bug: Fixed a bug when passing tools to Claude for tools that don't have any inputs 2025-10-21 10:04:38 -06:00
Dark-Alex-17 2ceb0808c8 bug: Fixed a bug that was duplicating entries of all the functions for agents between MCP and tools 2025-10-20 15:30:29 -06:00
Dark-Alex-17 c9b90e8411 ci: Updated to only include basic ARM64 and x86_64 architectures 2025-10-17 13:30:42 -06:00
Dark-Alex-17 8d03b2fc72 bug: corrected a typo for sourcing the prompt utility bash script in the built-in tools 2025-10-16 15:48:53 -06:00
Dark-Alex-17 b172fe8fbf fix: Corrected a typo for sourcing the bash utility script in some agent definitions 2025-10-16 15:47:07 -06:00
Dark-Alex-17 bdd3aaa0ab chore: update the models.yaml 2025-10-16 15:20:33 -06:00
Dark-Alex-17 64cbac0dd9 refactor: Modified the default PS1 look 2025-10-16 15:08:48 -06:00
Dark-Alex-17 50903c3d03 style: Cleaned up some linting issues for Windows 2025-10-16 13:30:30 -06:00
Dark-Alex-17 680b71e13d style: Applied formatting 2025-10-16 13:01:37 -06:00
Dark-Alex-17 a410818015 refactor: Fixed a linting issue for Windows builds 2025-10-16 12:44:50 -06:00
Dark-Alex-17 6c5bc51a0a docs: Updated outdated API links in the config example 2025-10-16 12:38:07 -06:00
Dark-Alex-17 38d114808e feat: Support for secret injection into the global config file (API keys, for example) 2025-10-16 12:30:18 -06:00
Dark-Alex-17 bb37513ef5 feat: Improved MCP handling toggle handling 2025-10-15 18:36:54 -06:00
Dark-Alex-17 85533f665e feat: Secret injection into the MCP configuration 2025-10-15 16:06:59 -06:00
Dark-Alex-17 b790041d95 feat: added REPL support for interacting with the Loki vault 2025-10-15 15:15:04 -06:00
Dark-Alex-17 bb5419967f feat: Integrated gman with Loki to create a vault and added flags to configure the Loki vault 2025-10-14 18:00:11 -06:00
Dark-Alex-17 21b00c6333 Applied formatting 2025-10-10 15:32:51 -06:00
Dark-Alex-17 4050997d7b bug: Automatically mark all extracted tools as executable 2025-10-10 15:30:58 -06:00
Dark-Alex-17 7d7477f4ec docs: Created an example role configuration 2025-10-10 15:15:11 -06:00
Dark-Alex-17 7d81b45f92 feat: Added a default session to the jira helper to make interaction more natural 2025-10-10 15:03:26 -06:00
Dark-Alex-17 83f3790d2f style: applied formatting 2025-10-10 15:01:55 -06:00
Dark-Alex-17 4ad20c380d refactor: Changed the name of agent_prelude to agent_session to make its purpose more clear 2025-10-10 15:01:44 -06:00
Dark-Alex-17 a895da9e47 style: Applied consistent formatting to agent changes 2025-10-10 14:48:10 -06:00
Dark-Alex-17 1bfd2b7370 feat: Created the repo-analyzer role 2025-10-10 14:43:18 -06:00
Dark-Alex-17 6631ff53f2 feat: Created the coder and sql agents 2025-10-10 13:38:47 -06:00
Dark-Alex-17 6244e337b0 feat: Cleaned the built-in functions to not have leftover dependencies 2025-10-10 13:38:27 -06:00
Dark-Alex-17 d199e9ebe6 feat: Created additional built-in roles for slack, repo analysis, and github 2025-10-10 13:38:03 -06:00
Dark-Alex-17 ca5bfd6e8f feat: Install built-in agents 2025-10-10 13:37:05 -06:00
Dark-Alex-17 c8984cf91a refactor: Removed leftover javascript function support; will not implement 2025-10-10 10:22:05 -06:00
Dark-Alex-17 bf4422ed0d docs: Fixed typo in Python execution docs 2025-10-10 10:05:09 -06:00
Dark-Alex-17 e41fbed9cc feat: Embedded baseline MCP config and global tools 2025-10-10 09:58:20 -06:00
Dark-Alex-17 4e6e8a845f docs: Created the code of conduct 2025-10-07 10:59:27 -06:00
Dark-Alex-17 e24c056191 docs: Added the security policy 2025-10-07 10:58:02 -06:00
Dark-Alex-17 b56fe7d3cd ci: Initialized commitizen configuration 2025-10-07 10:57:37 -06:00
Dark-Alex-17 f4c5d9f0d7 docs: Added loki contribution guidelines 2025-10-07 10:55:52 -06:00
Dark-Alex-17 f9dc61e906 Created an .actrc file to make local CI/CD testing easier 2025-10-07 10:54:16 -06:00
Dark-Alex-17 ed8dc34ff6 Removed the hestia CLI since it is no longer needed 2025-10-07 10:53:44 -06:00
Dark-Alex-17 a2b57caff5 Updated gitignore 2025-10-07 10:53:00 -06:00
Dark-Alex-17 19a680442d Create issue templates and CI/CD workflows 2025-10-07 10:51:04 -06:00
Dark-Alex-17 394f1f92a0 Baseline project 2025-10-07 10:45:42 -06:00
Dark-Alex-17 044f34b029 Created initial assets 2025-10-07 10:43:34 -06:00
Dark-Alex-17 a250fe98bb Created initial assets 2025-10-07 10:42:46 -06:00
Dark-Alex-17 a7c770120a Initial commit 2025-10-07 10:41:42 -06:00
151 changed files with 21975 additions and 584 deletions
+29 -28
View File
@@ -1,6 +1,7 @@
# Loki: All-in-one, batteries-included LLM CLI Tool
![Test](https://github.com/Dark-Alex-17/loki/actions/workflows/ci.yaml/badge.svg)
![LOC](https://tokei.rs/b1/github/Dark-Alex-17/loki?category=code)
[![crates.io link](https://img.shields.io/crates/v/loki-ai.svg)](https://crates.io/crates/loki-ai)
![Release](https://img.shields.io/github/v/release/Dark-Alex-17/loki?color=%23c694ff)
![Crate.io downloads](https://img.shields.io/crates/d/loki-ai?label=Crate%20downloads)
@@ -12,36 +13,36 @@ Agents, and More.
It is designed to include a number of useful agents, roles, macros, and more so users can get up and running with Loki
in as little time as possible.
![Agent example](https://raw.githubusercontent.com/wiki/Dark-Alex-17/loki/images/agents/sql.gif)
![Agent example](./docs/images/agents/sql.gif)
Coming from [AIChat](https://github.com/sigoden/aichat)? Follow the [migration guide](https://github.com/Dark-Alex-17/loki/wiki/AIChat-Migration) to get started.
Coming from [AIChat](https://github.com/sigoden/aichat)? Follow the [migration guide](./docs/AICHAT-MIGRATION.md) to get started.
## Quick Links
* [AIChat Migration Guide](https://github.com/Dark-Alex-17/loki/wiki/AIChat-Migration): Coming from AIChat? Follow the migration guide to get started.
* [AIChat Migration Guide](./docs/AICHAT-MIGRATION.md): Coming from AIChat? Follow the migration guide to get started.
* [Installation](#install): Install Loki
* [Getting Started](#getting-started): Get started with Loki by doing first-run setup steps.
* [REPL](https://github.com/Dark-Alex-17/loki/wiki/REPL): Interactive Read-Eval-Print Loop for conversational interactions with LLMs and Loki.
* [Custom REPL Prompt](https://github.com/Dark-Alex-17/loki/wiki/REPL-Prompt): Customize the REPL prompt to provide useful contextual information.
* [Vault](https://github.com/Dark-Alex-17/loki/wiki/Vault): Securely store and manage sensitive information such as API keys and credentials.
* [Shell Integrations](https://github.com/Dark-Alex-17/loki/wiki/Shell-Integrations): Seamlessly integrate Loki with your shell environment for enhanced command-line assistance.
* [Function Calling](https://github.com/Dark-Alex-17/loki/wiki/Tools): Leverage function calling capabilities to extend Loki's functionality with custom tools
* [Creating Custom Tools](https://github.com/Dark-Alex-17/loki/wiki/Custom-Tools): You can create your own custom tools to enhance Loki's capabilities.
* [Create Custom Python Tools](https://github.com/Dark-Alex-17/loki/wiki/Custom-Tools#custom-python-based-tools)
* [Create Custom TypeScript Tools](https://github.com/Dark-Alex-17/loki/wiki/Custom-Tools#custom-typescript-based-tools)
* [Create Custom Bash Tools](https://github.com/Dark-Alex-17/loki/wiki/Custom-Bash-Tools)
* [Bash Prompt Utilities](https://github.com/Dark-Alex-17/loki/wiki/Bash-Prompt-Helpers)
* [First-Class MCP Server Support](https://github.com/Dark-Alex-17/loki/wiki/MCP-Servers): Easily connect and interact with MCP servers for advanced functionality.
* [Macros](https://github.com/Dark-Alex-17/loki/wiki/Macros): Automate repetitive tasks and workflows with Loki "scripts" (macros).
* [RAG](https://github.com/Dark-Alex-17/loki/wiki/RAG): Retrieval-Augmented Generation for enhanced information retrieval and generation.
* [Sessions](https://github.com/Dark-Alex-17/loki/wiki/Sessions): Manage and persist conversational contexts and settings across multiple interactions.
* [Roles](https://github.com/Dark-Alex-17/loki/wiki/Roles): Customize model behavior for specific tasks or domains.
* [Agents](https://github.com/Dark-Alex-17/loki/wiki/Agents): Leverage AI agents to perform complex tasks and workflows, including sub-agent spawning, teammate messaging, and user interaction tools.
* [Todo System](https://github.com/Dark-Alex-17/loki/wiki/TODO-System): Built-in task tracking for improved agent reliability with smaller models.
* [Environment Variables](https://github.com/Dark-Alex-17/loki/wiki/Environment-Variables): Override and customize your Loki configuration at runtime with environment variables.
* [Client Configurations](https://github.com/Dark-Alex-17/loki/wiki/Clients): Configuration instructions for various LLM providers.
* [Authentication (API Key & OAuth)](https://github.com/Dark-Alex-17/loki/wiki/Clients#authentication): Authenticate with API keys or OAuth for subscription-based access.
* [Patching API Requests](https://github.com/Dark-Alex-17/loki/wiki/Patches): Learn how to patch API requests for advanced customization.
* [Custom Themes](https://github.com/Dark-Alex-17/loki/wiki/Themes): Change the look and feel of Loki to your preferences with custom themes.
* [REPL](./docs/REPL.md): Interactive Read-Eval-Print Loop for conversational interactions with LLMs and Loki.
* [Custom REPL Prompt](./docs/REPL-PROMPT.md): Customize the REPL prompt to provide useful contextual information.
* [Vault](./docs/VAULT.md): Securely store and manage sensitive information such as API keys and credentials.
* [Shell Integrations](./docs/SHELL-INTEGRATIONS.md): Seamlessly integrate Loki with your shell environment for enhanced command-line assistance.
* [Function Calling](./docs/function-calling/TOOLS.md#Tools): Leverage function calling capabilities to extend Loki's functionality with custom tools
* [Creating Custom Tools](./docs/function-calling/CUSTOM-TOOLS.md): You can create your own custom tools to enhance Loki's capabilities.
* [Create Custom Python Tools](./docs/function-calling/CUSTOM-TOOLS.md#custom-python-based-tools)
* [Create Custom TypeScript Tools](./docs/function-calling/CUSTOM-TOOLS.md#custom-typescript-based-tools)
* [Create Custom Bash Tools](./docs/function-calling/CUSTOM-BASH-TOOLS.md)
* [Bash Prompt Utilities](./docs/function-calling/BASH-PROMPT-HELPERS.md)
* [First-Class MCP Server Support](./docs/function-calling/MCP-SERVERS.md): Easily connect and interact with MCP servers for advanced functionality.
* [Macros](./docs/MACROS.md): Automate repetitive tasks and workflows with Loki "scripts" (macros).
* [RAG](./docs/RAG.md): Retrieval-Augmented Generation for enhanced information retrieval and generation.
* [Sessions](/docs/SESSIONS.md): Manage and persist conversational contexts and settings across multiple interactions.
* [Roles](./docs/ROLES.md): Customize model behavior for specific tasks or domains.
* [Agents](/docs/AGENTS.md): Leverage AI agents to perform complex tasks and workflows, including sub-agent spawning, teammate messaging, and user interaction tools.
* [Todo System](./docs/TODO-SYSTEM.md): Built-in task tracking for improved agent reliability with smaller models.
* [Environment Variables](./docs/ENVIRONMENT-VARIABLES.md): Override and customize your Loki configuration at runtime with environment variables.
* [Client Configurations](./docs/clients/CLIENTS.md): Configuration instructions for various LLM providers.
* [Authentication (API Key & OAuth)](./docs/clients/CLIENTS.md#authentication): Authenticate with API keys or OAuth for subscription-based access.
* [Patching API Requests](./docs/clients/PATCHES.md): Learn how to patch API requests for advanced customization.
* [Custom Themes](./docs/THEMES.md): Change the look and feel of Loki to your preferences with custom themes.
* [History](#history): A history of how Loki came to be.
## Prerequisites
@@ -153,7 +154,7 @@ loki --list-secrets
### Authentication
Each client in your configuration needs authentication (with a few exceptions; e.g. ollama). Most clients use an API key
(set via `api_key` in the config or through the [vault](https://github.com/Dark-Alex-17/loki/wiki/Vault)). For providers that support OAuth (e.g. Claude Pro/Max
(set via `api_key` in the config or through the [vault](./docs/VAULT.md)). For providers that support OAuth (e.g. Claude Pro/Max
subscribers, Google Gemini), you can authenticate with your existing subscription instead:
```yaml
@@ -169,7 +170,7 @@ loki --authenticate my-claude-oauth
# Or via the REPL: .authenticate
```
For full details, see the [authentication documentation](https://github.com/Dark-Alex-17/loki/wiki/Clients#authentication).
For full details, see the [authentication documentation](./docs/clients/CLIENTS.md#authentication).
### Tab-Completions
You can also enable tab completions to make using Loki easier. To do so, add the following to your shell profile:
@@ -246,7 +247,7 @@ shown below:
| Setting | Description |
|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `repl_prelude` | This setting lets you specify a default `session` or `role` to use when starting Loki in [REPL](https://github.com/Dark-Alex-17/loki/wiki/REPL) mode. <br>Values can be <ul><li>`role:<name>` to define a role</li><li>`session:<name>` to define a session</li><li>`<session>:<role>` to define both a session and a role to use</li></ul> |
| `repl_prelude` | This setting lets you specify a default `session` or `role` to use when starting Loki in [REPL](./docs/REPL.md) mode. <br>Values can be <ul><li>`role:<name>` to define a role</li><li>`session:<name>` to define a session</li><li>`<session>:<role>` to define both a session and a role to use</li></ul> |
| `cmd_prelude` | This setting lets you specify a default `session` or `role` to use when running one-off queries in Loki via the CLI. <br>Values can be <ul><li>`role:<name>` to define a role</li><li>`session:<name>` to define a session</li><li>`<session>:<role>` to define both a session and a role to use</li></ul> |
| `agent_session` | This setting is used to specify a default session that all agents should start into, unless otherwise specified in the agent configuration. (e.g. `temp`, `default`) |
+11
View File
@@ -0,0 +1,11 @@
#!/usr/bin/env bash
set -e
# @meta require-tools jira
# @describe Query for jira issues using a Jira Query Language (JQL) query
# @option --jql-query! The Jira Query Language query to execute
# @env LLM_OUTPUT=/dev/stdout The output path
main() {
jira issue ls -q "$argc_jql_query" --plain >> "$LLM_OUTPUT"
}
+775
View File
@@ -0,0 +1,775 @@
# Agents
Agents in Loki follow the same style as OpenAI's GPTs. They consist of 3 parts:
* [Role](./ROLES.md) - Tell the LLM how to behave
* [RAG](./RAG.md) - Pre-built knowledge bases specifically for the agent
* [Function Calling](./function-calling/TOOLS.md#tools) ([#2](./function-calling/MCP-SERVERS.md)) - Extends the functionality of the LLM through custom functions it can call
![Agent example](./images/agents/sql.gif)
Agent configuration files are stored in the `agents` subdirectory of your Loki configuration directory. The location of
this directory varies between systems so you can use the following command to locate yours:
```shell
loki --info | grep 'agents_dir' | awk '{print $2}'
```
If you're looking for more example agents, refer to the [built-in agents](../assets/agents).
## Quick Links
<!--toc:start-->
- [Directory Structure](#directory-structure)
- [Metadata](#1-metadata)
- [2. Define the Instructions](#2-define-the-instructions)
- [Static Instructions](#static-instructions)
- [Special Variables](#special-variables)
- [User-Defined Variables](#user-defined-variables)
- [Dynamic Instructions](#dynamic-instructions)
- [Variables](#variables)
- [3. Initializing RAG](#3-initializing-rag)
- [4. Building Tools for Agents](#4-building-tools-for-agents)
- [Limitations](#limitations)
- [.env File Support](#env-file-support)
- [Python-Based Agent Tools](#python-based-agent-tools)
- [Bash-Based Agent Tools](#bash-based-agent-tools)
- [TypeScript-Based Agent Tools](#typescript-based-agent-tools)
- [5. Conversation Starters](#5-conversation-starters)
- [6. Todo System & Auto-Continuation](#6-todo-system--auto-continuation)
- [7. Sub-Agent Spawning System](#7-sub-agent-spawning-system)
- [Configuration](#spawning-configuration)
- [Spawning & Collecting Agents](#spawning--collecting-agents)
- [Task Queue with Dependencies](#task-queue-with-dependencies)
- [Active Task Dispatch](#active-task-dispatch)
- [Output Summarization](#output-summarization)
- [Teammate Messaging](#teammate-messaging)
- [Runaway Safeguards](#runaway-safeguards)
- [8. User Interaction Tools](#8-user-interaction-tools)
- [Available Tools](#user-interaction-available-tools)
- [Escalation (Sub-Agent to User)](#escalation-sub-agent-to-user)
- [9. Auto-Injected Prompts](#9-auto-injected-prompts)
- [Built-In Agents](#built-in-agents)
<!--toc:end-->
---
## Directory Structure
Agent configurations often have the following directory structure:
```
<loki-config-dir>/agents
└── my-agent
├── config.yaml
├── tools.sh
or
├── tools.py
or
├── tools.ts
```
This means that agent configurations often are only two files: the agent configuration file (`config.yaml`), and the
tool definitions (`agents/my-agent/tools.sh`, `tools.py`, or `tools.ts`).
To see a full example configuration file, refer to the [example agent config file](../config.agent.example.yaml).
The best way to understand how an agent is built is to go step by step in the following manner:
---
## 1. Metadata
Agent configurations have the following settings available to customize each agent:
```yaml
# Model Configuration
model: openai:gpt-4o # Specify the LLM to use
temperature: null # Set default temperature parameter, range (0, 1)
top_p: null # Set default top-p parameter, with a range of (0, 1) or (0, 2), depending on the model
# Agent Metadata Configuration
agent_session: null # Set a session to use when starting the agent. (e.g. temp, default); defaults to globally set agent_session
# Agent Configuration
name: <agent-name> # Name of the agent, used in the UI and logs
description: <description> # Description of the agent, used in the UI
version: 1 # Version of the agent
# Function Calling Configuration
mcp_servers: # Optional list of MCP servers that the agent utilizes
- github # Corresponds to the name of an MCP server in the `<loki-config-dir>/functions/mcp.json` file
global_tools: # Optional list of additional global tools to enable for the agent; i.e. not tools specific to the agent
- web_search
- fs
- python
# Todo System & Auto-Continuation (see "Todo System & Auto-Continuation" section below)
auto_continue: false # Enable automatic continuation when incomplete todos remain
max_auto_continues: 10 # Maximum continuation attempts before stopping
inject_todo_instructions: true # Inject todo tool instructions into system prompt
continuation_prompt: null # Custom prompt for continuations (optional)
# Sub-Agent Spawning (see "Sub-Agent Spawning System" section below)
can_spawn_agents: false # Enable spawning child agents
max_concurrent_agents: 4 # Max simultaneous child agents
max_agent_depth: 3 # Max nesting depth (prevents runaway)
inject_spawn_instructions: true # Inject spawning instructions into system prompt
summarization_model: null # Model for summarizing sub-agent output (e.g. 'openai:gpt-4o-mini')
summarization_threshold: 4000 # Char count above which sub-agent output is summarized
escalation_timeout: 300 # Seconds sub-agents wait for escalated user input (default: 5 min)
```
As mentioned previously: Agents utilize function calling to extend a model's capabilities. However, agents operate in
isolated environment, so in order for an agent to use a tool or MCP server that you have defined globally, you must
explicitly state which tools and/or MCP servers the agent uses. Otherwise, it is assumed that the agent doesn't use any
tools outside its own custom defined tools.
And if you don't define a `agents/my-agent/tools.sh`, `agents/my-agent/tools.py`, or `agents/my-agent/tools.ts`, then the agent is really just a
`role`.
You'll notice there are no settings for agent-specific tooling. This is because they are handled separately and
automatically. See the [Building Tools for Agents](#4-building-tools-for-agents) section below for more information.
To see a full example configuration file, refer to the [example agent config file](../config.agent.example.yaml).
## 2. Define the Instructions
At their heart, agents function similarly to roles in that they tell the model how to behave. Agent configuration files
have the following settings for the instruction definitions:
```yaml
dynamic_instructions: # Whether to use dynamically generated instructions for the agent; if false, static instructions are used. False by default.
instructions: # Static instructions for the LLM; These are ignored if dynamic instructions are used
variables: # An array of optional variables that the agent expects and uses
```
### Static Instructions
By default, Loki agents use statically defined instructions. Think of them as being identical to the instructions for a
[role](./ROLES.md#instructions), because they virtually are.
**Example:**
```yaml
instructions: |
You are an AI agent designed to demonstrate agentic capabilities
```
Just like roles, agents support variable interpolation at runtime. There's two types of variables that can be
interpolated into the instructions at runtime: special variables (like roles have), and user-defined variables. Just
like roles, variables are interpolated into your instructions anywhere Loki sees the `{{variable}}` syntax.
#### Special Variables
The following special variables are provided by Loki at runtime and can be injected into your agent's instructions:
| Name | Description | Example |
|-----------------|---------------------------------------------------------------------|----------------------------|
| `__os__` | Operating system name | `linux` |
| `__os_family__` | Operating system family | `unix` |
| `__arch__` | System architecture | `x86_64` |
| `__shell__` | The current user's default shell | `bash` |
| `__locale__` | The current user's preferred language and region settings | `en-US` |
| `__now__` | Current timestamp in ISO 8601 format | `2025-11-07T10:15:44.268Z` |
| `__cwd__` | The current working directory | `/tmp` |
| `__tools__` | A list of the enabled tools (global + mcp servers + agent-specific) | |
#### User-Defined Variables
Agents also support user-defined variables that can be interpolated into the instructions, and are made available to any
agent-specific tools you define (see [Building Tools for Agents](#4-building-tools-for-agents) for more details on how to
create agent-specific tooling).
The `variables` setting in an agent's config has the following fields:
| Field | Required | Description |
|---------------|----------|----------------------------------------------------------------------------------------------------|
| `name` | * | The name of the variable |
| `description` | * | The description of the field |
| `default` | | A default value for the field. If left undefined, the user will be prompted for a value at runtime |
These variables can be referenced in both the agent's instructions, and in the tool definitions via `LLM_AGENT_VAR_<name>`.
**Example:**
```yaml
instructions: |
You are an agent who answers questions about a user's system.
<tools>
{{__tools__}}
</tools>
<system>
os: {{__os__}}
os_family: {{__os_family__}}
arch: {{__arch__}}
shell: {{__shell__}}
locale: {{__locale__}}
now: {{__now__}}
cwd: {{__cwd__}}
</system>
<user>
username: {{username}}
</user>
variables:
- name: username # Accessible from the tool definitions via the `LLM_AGENT_VAR_USERNAME` environment variable
description: Your user name
```
### Dynamic Instructions
Sometimes you may find it useful to dynamically generate instructions on startup. Whether that be via a call to Loki
itself to generate them, or by some other means. Loki supports this type of behavior using a special function defined
in your `agents/my-agent/tools.py`, `agents/my-agent/tools.sh`, or `agents/my-agent/tools.ts`.
**Example: Instructions for a JSON-reader agent that specializes on each JSON input it receives**
`agents/json-reader/tools.py`:
```python
import json
from pathlib import Path
from genson import SchemaBuilder
def _instructions():
"""Generates instructions for the agent dynamically"""
value = input("Enter a JSON file path OR paste raw JSON: ").strip()
if not value:
raise SystemExit("A file path or JSON string is required.")
p = Path(value)
if p.exists() and p.is_file():
json_file_path = str(p.resolve())
json_text = p.read_text(encoding="utf-8")
else:
try:
json.loads(value)
except json.JSONDecodeError as e:
raise SystemExit(f"Input is neither a file nor valid JSON.\n{e}")
json_file_path = "<provided-inline-json>"
json_text = value
try:
data = json.loads(json_text)
except json.JSONDecodeError as e:
raise SystemExit(f"Provided content is not valid JSON.\n{e}")
builder = SchemaBuilder()
builder.add_object(data)
json_schema = builder.to_schema()
return f"""
You are an AI agent that can view and filter JSON data with jq.
## Context
json_file_path: {json_file_path}
json_schema: {json.dumps(json_schema, indent=2)}
"""
```
or
`agents/json-reader/tools.sh`:
```bash
#!/usr/bin/env bash
set -e
# @meta require-tools jq,genson
# @env LLM_OUTPUT=/dev/stdout The output path
# @cmd Generates instructions for the agent dynamically
_instructions() {
read -r -p "Enter a JSON file path OR paste raw JSON: " value
if [[ -z "${value}" ]]; then
echo "A file path or JSON string is required" >&2
exit 1
fi
json_file_path=""
inline_temp=""
cleanup() {
[[ -n "${inline_temp:-}" && -f "${inline_temp}" ]] && rm -f "${inline_temp}"
}
trap cleanup EXIT
if [[ -f "${value}" ]]; then
json_file_path="$(realpath "${value}")"
if ! jq empty "${json_file_path}" >/dev/null 2>&1; then
echo "Error: File does not contain valid JSON: ${json_file_path}" >&2
exit 1
fi
else
inline_temp="$(mktemp)"
printf "%s" "${value}" > "${inline_temp}"
if ! jq empty "${inline_temp}" >/dev/null 2>&1; then
echo "Error: Input is neither a file nor valid JSON." >&2
exit 1
fi
json_file_path="<provided-inline-json>"
fi
source_file="${json_file_path}"
if [[ "${json_file_path}" == "<provided-inline-json>" ]]; then
source_file="${inline_temp}"
fi
json_schema="$(genson < "${source_file}" | jq -c '.')"
cat <<EOF >> "$LLM_OUTPUT"
You are an AI agent that can view and filter JSON data with jq.
## Context
json_file_path: ${json_file_path}
json_schema: ${json_schema}
EOF
}
```
For more information on how to create custom tools for your agent and the structure of the `agent/my-agent/tools.sh`,
`agent/my-agent/tools.py`, or `agent/my-agent/tools.ts` files, refer to the [Building Tools for Agents](#4-building-tools-for-agents) section below.
#### Variables
All the same variable interpolations supported by static instructions is also supported by dynamic instructions. For
more information on what variables are available and how to use them, refer to the [Special Variables](#special-variables)
and [User-Defined Variables](#user-defined-variables) sections above.
## 3. Initializing RAG
Each agent you create also has a dedicated knowledge base that adds additional context to your queries and helps the LLM
answer queries effectively. The documents to load into RAG are defined in the `documents` array of your agent
configuration file:
```yaml
documents:
- https://www.ohdsi.org/data-standardization/
- https://github.com/OHDSI/Vocabulary-v5.0/wiki/**
- OMOPCDM_ddl.sql # Relative path to agent (i.e. file lives at '<loki-config-dir>/agents/my-agent/OMOPCDM_ddl.sql')
```
These documents use the same syntax as those you'd define when constructing RAG normally. To see all the available types
of documents that Loki supports and how to use custom document loaders, refer to the [RAG documentation](./RAG.md#supported-document-sources).
Anytime your agent starts up, it will automatically be using the RAG you've defined here.
## 4. Building Tools for Agents
Building tools for agents is virtually identical to building custom tools, with one slight difference: instead of
defining a single function that gets executed at runtime (e.g. `main` for bash tools and `run` for Python tools), agent
tools define a number of *subcommands*.
### Limitations
You can only utilize one of: a bash-based `<loki-config-dir>/agents/my-agent/tools.sh`, a Python-based
`<loki-config-dir>/agents/my-agent/tools.py`, or a TypeScript-based `<loki-config-dir>/agents/my-agent/tools.ts`.
However, if it's easier to achieve a task in one language vs the other,
you're free to define other scripts in your agent's configuration directory and reference them from the main
tools file. **Any scripts *not* named `tools.{py,sh,ts}` will not be picked up by Loki's compiler**, meaning they
can be used like any other set of scripts.
It's important to keep in mind the following:
* **Do not give agents the same name as an executable**. Loki compiles the tools for each agent into a binary that it
temporarily places on your path during execution. If you have a binary with the same name as your agent, then your
shell may execute the existing binary instead of your agent's tools
* **`LLM_ROOT_DIR` points to the agent's configuration directory**. This is where agents differ slightly from normal
tools: The `LLM_ROOT_DIR` environment variable does *not* point to the `functions/tools` directory like it does in
global tools. Instead, it points to the agent's configuration directory, making it easier to source scripts and other
miscellaneous files
### .env File Support
When Loki loads an agent, it will also search the agent's configuration directory for a `.env` file. If found, all
environment variables defined in the file will be made available to the agent's tools.
### Python-Based Agent Tools
Python-based tools are defined exactly the same as they are for custom tool definitions. The only difference is that
instead of a single `run` function, you define as many as you like with whatever arguments you like.
**Example:**
`agents/my-agent/tools.py`
```python
import urllib.request
def get_ip_info():
"""
Get your IP information
"""
with urllib.request.urlopen("https://httpbin.org/ip") as response:
data = response.read()
return data.decode('utf-8')
def get_ip_address_from_aws():
"""
Find your public IP address using AWS
"""
with urllib.request.urlopen("https://checkip.amazonaws.com") as response:
data = response.read()
return data.decode('utf-8')
```
Loki automatically compiles these as separate functions for the LLM to call. No extra work is needed. Just make sure you
follow all the same steps to define each function as you would when creating custom Python tools.
For more information on how to build tools in Python, refer to the [custom Python tools documentation](./function-calling/CUSTOM-TOOLS.md#custom-python-based-tools)
### Bash-Based Agent Tools
Bash-based agent tools are virtually identical to custom bash tools, with only one difference. Instead of defining a
single entrypoint via the `main` function, you actually define as many subcommands as you like.
**Example:**
`agents/my-agent/tools.sh`
```bash
#!/usr/bin/env bash
# @env LLM_OUTPUT=/dev/stdout The output path
# @describe Discover network information about your computer and its place in the internet
# Use the `@cmd` annotation to define subcommands for your script.
# @cmd Get your IP information
get_ip_info() {
curl -fsSL https://httpbin.org/ip >> "$LLM_OUTPUT"
}
# @cmd Find your public IP address using AWS
get_ip_address_from_aws() {
curl -fsSL https://checkip.amazonaws.com >> "$LLM_OUTPUT"
}
```
To compile the script so it's executable and testable:
```bash
$ loki --build-tools
```
Then you can execute your script (assuming your current working directory is `agents/my-agent`):
```bash
$ ./tools.sh get_ip_info
$ ./tools.sh get_ip_address_from_aws
```
All other special annotations (`@env`, `@arg`, `@option` `@flags`) apply to subcommands as well, so be sure to follow
the same syntax ad formatting as is used to create custom bash tools globally.
For more information on how to write, [build and test](function-calling/CUSTOM-BASH-TOOLS.md#execute-and-test-your-bash-tools) tools in bash, refer to the
[custom bash tools documentation](function-calling/CUSTOM-BASH-TOOLS.md).
### TypeScript-Based Agent Tools
TypeScript-based agent tools work exactly the same as TypeScript global tools. Instead of a single `run` function,
you define as many exported functions as you like. Non-exported functions are private helpers and are invisible to the
LLM.
**Example:**
`agents/my-agent/tools.ts`
```typescript
/**
* Get your IP information
*/
export async function get_ip_info(): Promise<string> {
const resp = await fetch("https://httpbin.org/ip");
return await resp.text();
}
/**
* Find your public IP address using AWS
*/
export async function get_ip_address_from_aws(): Promise<string> {
const resp = await fetch("https://checkip.amazonaws.com");
return await resp.text();
}
// Non-exported helper — invisible to the LLM
function formatResponse(data: string): string {
return data.trim();
}
```
Loki automatically compiles each exported function as a separate tool for the LLM to call. Just make sure you
follow the same JSDoc and parameter conventions as you would when creating custom TypeScript tools.
TypeScript agent tools also support dynamic instructions via an exported `_instructions()` function:
```typescript
import { readFileSync } from "fs";
/**
* Generates instructions for the agent dynamically
*/
export function _instructions(): string {
const schema = readFileSync("schema.json", "utf-8");
return `You are an AI agent that works with the following schema:\n${schema}`;
}
```
For more information on how to build tools in TypeScript, refer to the [custom TypeScript tools documentation](function-calling/CUSTOM-TOOLS.md#custom-typescript-based-tools).
## 5. Conversation Starters
It's often helpful to also have some conversation starters so users know what kinds of things the agent is capable of
doing. These are available in the REPL via the `.starter` command and are selectable.
They are defined using the `conversation_starters` setting in your agent's configuration file:
**Example:**
`agents/my-agent/config.yaml`:
```yaml
conversation_starters:
- What is my username?
- What is my current shell?
- What is my ip?
- How much disk space is left on my PC??
- How to create an agent?
```
![Example Conversation Starters](./images/agents/conversation-starters.gif)
## 6. Todo System & Auto-Continuation
Loki includes a built-in task tracking system designed to improve the reliability of agents, especially when using
smaller language models. The Todo System helps models:
- Break complex tasks into manageable steps
- Track progress through multi-step workflows
- Automatically continue work until all tasks are complete
### Quick Configuration
```yaml
# agents/my-agent/config.yaml
auto_continue: true # Enable auto-continuation
max_auto_continues: 10 # Max continuation attempts
inject_todo_instructions: true # Include the default todo instructions into prompt
```
### How It Works
1. When `inject_todo_instructions` is enabled, agents receive instructions on using five built-in tools:
- `todo__init`: Initialize a todo list with a goal
- `todo__add`: Add a task to the list
- `todo__done`: Mark a task complete
- `todo__list`: View current todo state
- `todo__clear`: Clear the entire todo list and reset the goal
These instructions are a reasonable default that detail how to use Loki's To-Do System. If you wish,
you can disable the injection of the default instructions and specify your own instructions for how
to use the To-Do System into your main `instructions` for the agent.
2. When `auto_continue` is enabled and the model stops with incomplete tasks, Loki automatically sends a
continuation prompt with the current todo state, nudging the model to continue working.
3. This continues until all tasks are done or `max_auto_continues` is reached.
### When to Use
- Multistep tasks where the model might lose track
- Smaller models that need more structure
- Workflows requiring guaranteed completion of all steps
For complete documentation including all configuration options, tool details, and best practices, see the
[Todo System Guide](./TODO-SYSTEM.md).
## 7. Sub-Agent Spawning System
Loki agents can spawn and manage child agents that run **in parallel** as background tasks inside the same process.
This enables orchestrator-style agents that delegate specialized work to other agents, similar to how tools like
Claude Code or OpenCode handle complex multi-step tasks.
For a working example of an orchestrator agent that uses sub-agent spawning, see the built-in
[sisyphus](../assets/agents/sisyphus) agent. For an example of the teammate messaging pattern with parallel sub-agents,
see the [code-reviewer](../assets/agents/code-reviewer) agent.
### Spawning Configuration
| Setting | Type | Default | Description |
|-----------------------------|---------|---------------|--------------------------------------------------------------------------------|
| `can_spawn_agents` | boolean | `false` | Enable this agent to spawn child agents |
| `max_concurrent_agents` | integer | `4` | Maximum number of child agents that can run simultaneously |
| `max_agent_depth` | integer | `3` | Maximum nesting depth for sub-agents (prevents runaway spawning chains) |
| `inject_spawn_instructions` | boolean | `true` | Inject the default spawning instructions into the agent's system prompt |
| `summarization_model` | string | current model | Model to use for summarizing long sub-agent output (e.g. `openai:gpt-4o-mini`) |
| `summarization_threshold` | integer | `4000` | Character count above which sub-agent output is summarized before returning |
| `escalation_timeout` | integer | `300` | Seconds a sub-agent waits for an escalated user interaction response |
**Example configuration:**
```yaml
# agents/my-orchestrator/config.yaml
can_spawn_agents: true
max_concurrent_agents: 6
max_agent_depth: 2
inject_spawn_instructions: true
summarization_model: openai:gpt-4o-mini
summarization_threshold: 3000
escalation_timeout: 600
```
### Spawning & Collecting Agents
When `can_spawn_agents` is enabled, the agent receives tools for spawning and managing child agents:
| Tool | Description |
|------------------|-------------------------------------------------------------------------|
| `agent__spawn` | Spawn a child agent in the background. Returns an agent ID immediately. |
| `agent__check` | Non-blocking check: is the agent done? Returns `PENDING` or the result. |
| `agent__collect` | Blocking wait: wait for an agent to finish, return its output. |
| `agent__list` | List all spawned agents and their status. |
| `agent__cancel` | Cancel a running agent by ID. |
The core pattern is **Spawn -> Continue -> Collect**:
```
# 1. Spawn agents in parallel (returns IDs immediately)
agent__spawn --agent explore --prompt "Find auth middleware patterns in src/"
agent__spawn --agent explore --prompt "Find error handling patterns in src/"
# 2. Continue your own work while they run
# 3. Check if done (non-blocking)
agent__check --id agent_explore_a1b2c3d4
# 4. Collect results when ready (blocking)
agent__collect --id agent_explore_a1b2c3d4
agent__collect --id agent_explore_e5f6g7h8
```
Any agent defined in your `<loki-config-dir>/agents/` directory can be spawned as a child. Child agents:
- Run in a fully isolated environment (separate session, config, and tools)
- Have their output suppressed from the terminal (no spinner, no tool call logging)
- Return their accumulated output to the parent when collected
### Task Queue with Dependencies
For complex workflows where tasks have ordering requirements, the spawning system includes a dependency-aware
task queue:
| Tool | Description |
|------------------------|-----------------------------------------------------------------------------|
| `agent__task_create` | Create a task with optional dependencies and auto-dispatch agent. |
| `agent__task_list` | List all tasks with their status, dependencies, and assignments. |
| `agent__task_complete` | Mark a task done. Returns newly unblocked tasks and auto-dispatches agents. |
| `agent__task_fail` | Mark a task as failed. Dependents remain blocked. |
```
# Create tasks with dependency ordering
agent__task_create --subject "Explore existing patterns"
agent__task_create --subject "Implement feature" --blocked_by ["task_1"]
agent__task_create --subject "Write tests" --blocked_by ["task_2"]
# Mark tasks complete to unblock dependents
agent__task_complete --task_id task_1
```
### Active Task Dispatch
Tasks can optionally specify an agent to auto-spawn when the task becomes runnable:
```
agent__task_create \
--subject "Implement the auth module" \
--blocked_by ["task_1"] \
--agent coder \
--prompt "Implement auth module based on patterns found in task_1"
```
When `task_1` completes and the dependent task becomes unblocked, an agent is automatically spawned with the
specified prompt. No manual intervention needed. This enables fully automated multi-step pipelines.
### Output Summarization
When a child agent produces long output, it can be automatically summarized before returning to the parent.
This keeps parent context windows manageable.
- If the output exceeds `summarization_threshold` characters (default: 4000), it is sent through an LLM
summarization pass
- The `summarization_model` setting lets you use a cheaper/faster model for summarization (e.g. `gpt-4o-mini`)
- If `summarization_model` is not set, the parent's current model is used
- The summarization preserves all actionable information: code snippets, file paths, error messages, and
concrete recommendations
### Teammate Messaging
All agents (including children) automatically receive tools for **direct sibling-to-sibling messaging**:
| Tool | Description |
|-----------------------|-----------------------------------------------------|
| `agent__send_message` | Send a text message to another agent's inbox by ID. |
| `agent__check_inbox` | Drain all pending messages from your inbox. |
This enables coordination patterns where child agents share cross-cutting findings:
```
# Agent A discovers something relevant to Agent B
agent__send_message --id agent_reviewer_b1c2d3e4 --message "Found a security issue in auth.rs line 42"
# Agent B checks inbox before finalizing
agent__check_inbox
```
Messages are routed through the parent's supervisor. A parent can message its children, and children can message
their siblings. For a working example of the teammate pattern, see the built-in
[code-reviewer](../assets/agents/code-reviewer) agent, which spawns file-specific reviewers that share
cross-cutting findings with each other.
### Runaway Safeguards
The spawning system includes built-in safeguards to prevent runaway agent chains:
- **`max_concurrent_agents`:** Caps how many agents can run at once (default: 4). Spawn attempts beyond this
limit return an error asking the agent to wait or cancel existing agents.
- **`max_agent_depth`:** Caps nesting depth (default: 3). A child agent spawning its own child increments the
depth counter. Attempts beyond the limit are rejected.
- **`can_spawn_agents`:** Only agents with this flag set to `true` can spawn children. By default, spawning is
disabled. This means child agents cannot spawn their own children unless you explicitly create them with
`can_spawn_agents: true` in their config.
## 8. User Interaction Tools
Loki includes built-in tools for agents (and the REPL) to interactively prompt the user for input. These tools
are **always available**. No configuration needed. They are automatically injected into every agent and into
REPL mode when function calling is enabled.
### User Interaction Available Tools
| Tool | Description | Returns |
|------------------|-----------------------------------------|----------------------------------|
| `user__ask` | Present a single-select list of options | The selected option string |
| `user__confirm` | Ask a yes/no question | `"yes"` or `"no"` |
| `user__input` | Request free-form text input | The text entered by the user |
| `user__checkbox` | Present a multi-select checkbox list | Array of selected option strings |
**Parameters:**
- `user__ask`: `--question "..." --options ["Option A", "Option B", "Option C"]`
- `user__confirm`: `--question "..."`
- `user__input`: `--question "..."`
- `user__checkbox`: `--question "..." --options ["Option A", "Option B", "Option C"]`
At the top level (depth 0), these tools render interactive terminal prompts directly using arrow-key navigation,
checkboxes, and text input fields.
### Escalation (Sub-Agent to User)
When a **child agent** (depth > 0) calls a `user__*` tool, it cannot prompt the terminal directly. Instead,
the request is **automatically escalated** to the root agent:
1. The child agent calls `user__ask(...)` and **blocks**, waiting for a reply
2. The root agent sees a `pending_escalations` notification in its next tool results
3. The root agent either answers from context or prompts the user itself, then calls
`agent__reply_escalation` to unblock the child
4. The child receives the reply and continues
The escalation timeout is configurable via `escalation_timeout` in the agent's `config.yaml` (default: 300
seconds / 5 minutes). If the timeout expires, the child receives a fallback message asking it to use its
best judgment.
| Tool | Description |
|---------------------------|--------------------------------------------------------------------------|
| `agent__reply_escalation` | Reply to a pending child escalation, unblocking the waiting child agent. |
This tool is automatically available to any agent with `can_spawn_agents: true`.
## 9. Auto-Injected Prompts
Loki automatically appends usage instructions to your agent's system prompt for each enabled built-in system.
These instructions are injected into both **static and dynamic instructions** after your own instructions,
ensuring agents always know how to use their available tools.
| System | Injected When | Toggle |
|--------------------|----------------------------------------------------------------|-----------------------------|
| Todo tools | `auto_continue: true` AND `inject_todo_instructions: true` | `inject_todo_instructions` |
| Spawning tools | `can_spawn_agents: true` AND `inject_spawn_instructions: true` | `inject_spawn_instructions` |
| Teammate messaging | Always (all agents) | None (always injected) |
| User interaction | Always (all agents) | None (always injected) |
If you prefer to write your own instructions for a system, set the corresponding `inject_*` flag to `false`
and include your custom instructions in the agent's `instructions` field. The built-in tools will still be
available; only the auto-injected prompt text is suppressed.
## Built-In Agents
Loki comes packaged with some useful built-in agents:
* `coder`: An agent to assist you with all your coding tasks
* `code-reviewer`: A [CodeRabbit](https://coderabbit.ai)-style code reviewer that spawns per-file reviewers using the teammate messaging pattern
* `demo`: An example agent to use for reference when learning to create your own agents
* `explore`: An agent designed to help you explore and understand your codebase
* `file-reviewer`: An agent designed to perform code-review on a single file (used by the `code-reviewer` agent)
* `jira-helper`: An agent that assists you with all your Jira-related tasks
* `oracle`: An agent for high-level architecture, design decisions, and complex debugging
* `sisyphus`: A powerhouse orchestrator agent for writing complex code and acting as a natural language interface for your codebase (similar to ClaudeCode, Gemini CLI, Codex, or OpenCode). Uses sub-agent spawning to delegate to `explore`, `coder`, and `oracle`.
* `sql`: A universal SQL agent that enables you to talk to any relational database in natural language
+211
View File
@@ -0,0 +1,211 @@
# AIChat to Loki Migration Guide
Loki originally started as a fork of AIChat but has since evolved into its own separate project with separate goals.
As a result, there's some changes you'll need to make to your AIChat configuration to be able to use Loki.
Be sure you've run `loki` at least once so that the Loki configuration directory and subdirectories exist and is
populated with the built-in defaults.
## Global Configuration File
You should be able to copy/paste your AIChat configuration file into your Loki configuration directory. Since the
location of the Loki configuration directory varies between systems, you can use the following command to locate your
config directory:
```shell
loki --info | grep 'config_dir' | awk '{print $2}'
```
Then, you'll need to make the following changes:
* `function_calling` -> `function_calling_support`
* `use_tools` -> `enabled_tools`
* `agent_prelude` -> `agent_session`
* `compress_threshold` -> `compression_threshold`
* `summarize_prompt` -> `summarization_prompt`
* `summary_prompt` -> `summary_context_prompt`
## Roles
Locate your `roles` directory using the following command:
```shell
loki --info | grep 'roles_dir' | awk '{print $2}'
```
Update any roles that have `use_tools` to `enabled_tools`.
## Sessions
Locate your `sessions` directory using the following command:
```shell
loki --info | grep 'sessions_dir' | awk '{print $2}'
```
Update the following settings:
* `use_tools` -> `enabled_tools`
* `compress_threshold` -> `compression_threshold`
* `summarize_prompt` -> `summarization_prompt`
* `summary_prompt` -> `summary_context_prompt`
---
# LLM Functions Changes
Probably the most significant difference between AIChat and Loki is how tools are handled. So if you cloned the
[llm-functions](https://github.com/sigoden/llm-functions) repo, you'll need to make the following changes.
**Note: JavaScript functions are not supported in Loki.**
The following guide assumes you're using the `llm-functions` repository as your base for custom functions, and thus
follows that directory structure.
## Agents
Agents are now all handled in one place: the `agents` directory (`<loki-config-dir>/agents`):
```shell
loki --info | grep 'agents_dir' | awk '{print $2}'
```
And instead of separate `index.yaml` and `config.yaml` files, they're now both in a single `config.yaml` file.
So now for all of your agents, copy all the contents of those directories to the corresponding directory in the Loki
`agents` directory. Then make the following changes:
* Copy the contents of your `<aichat-config-dir>/functions/agents` directory into `<loki-config-dir/agents`
* Merge `index.yaml` into `config.yaml`
* If you never created a custom `config.yaml` file, then simply rename `index.yaml` to `config.yaml`
* If you've defined an `agent_prelude`, rename that field to `agent_session`
* Convert all JavaScript tools to either Python or Bash
* For Bash `tools.sh`: Remove the following line:
```bash
eval "$(argc --argc-eval "$0" "$@")"
```
* Any `tools.txt` files you have that define what global functions the agent uses is now replaced by the `global_tools`
field in the agent's `config.yaml`. So for example: If your `tools.txt` looks like this:
```text
fs_mkdir.sh
fs_ls.sh
fs_patch.sh
fs_cat.sh
```
then you need to add the following to your agent's `config.yaml`:
```yaml
global_tools:
- fs_mkdir.sh
- fs_ls.sh
- fs_patch.sh
- fs_cat.sh
```
* If you have any bash `tools.sh` that depend on the utility scripts in the `llm-functions` repository, they've been
replaced by built-in utility scripts. So use the following to replace any matching lines in your `tools.sh` files:
```bash
##################
## Scripts file ##
##################
ROOT_DIR="${LLM_ROOT_DIR:-$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)}"
# replace with
source "$LLM_PROMPT_UTILS_FILE"
#######################
## guard_path script ##
#######################
"$ROOT_DIR/utils/guard_path.sh"
# replace with
guard_path
############################
## guard_operation script ##
############################
"$ROOT_DIR/utils/guard_operation.sh"
# replace with
guard_operation
######################
## patch.awk script ##
######################
awk -f "$ROOT_DIR/utils/patch.awk"
# replace with
patch_file
```
When you're done with this migration, you should have the following:
* No more `functions/agents` directory
* No `functions/agents.txt` file (Loki assumes that if the agent directory exists, it is loadable)
* No `<loki-config-dir>/agents/<agent-name>/tools.txt`
* No `<loki-config-dir>/agents/<agent-name>/index.yaml`
## Functions
Loki consolidates much of the `llm-functions` repo functionality into one binary. So this means
* There's no need to have `argc` installed anymore
* No separate repository to manage
* No `tools.txt`
* No `functions.json`
* No `functions/mcp` directory at all
* No `functions/scripts`
Here's how to migrate your functions over to Loki from the `llm-functions` repository.
* Copy your AIChat `<aichat-config-dir>/functions` directory into your Loki config directory
* Delete the following files and directories from your `<loki-config-dir>/functions` directory:
* `scripts/`
* `agents.txt`
* `functions.json`
* `Argcfile.sh`
* `README.md` (irrelevant now)
* `LICENSE` (irrelevant now)
* `utils/guard_operation.sh`
* `utils/guard_path.sh`
* `utils/patch.awk`
* Everything in `tools.txt` now lives in the global config file under the `visible_tools` setting:
```text
get_current_weather.sh
execute_command.sh
web_search.sh
#execute_py_code.py
query_jira_issues.sh
```
becomes the following in your `<loki-config-dir>/config.yaml`
```yaml
visible_tools:
- get_current_weather.sh
- execute_command.sh
- web_search.sh
# - web_search.sh
- query_jira_issues.sh
```
* If you've defined a `functions/mcp.json` file, you can leave it alone.
* Similarly to agents, if you have any bash `tools.sh` that depend on the utility scripts in the `llm-functions`
repository, they've been replaced by built-in utility scripts. So use the following to replace any matching lines in
your `tools.sh` files:
```bash
##################
## Scripts file ##
##################
ROOT_DIR="${LLM_ROOT_DIR:-$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)}"
# replace with
source "$LLM_PROMPT_UTILS_FILE"
#######################
## guard_path script ##
#######################
"$ROOT_DIR/utils/guard_path.sh"
# replace with
guard_path
############################
## guard_operation script ##
############################
"$ROOT_DIR/utils/guard_operation.sh"
# replace with
guard_operation
######################
## patch.awk script ##
######################
awk -f "$ROOT_DIR/utils/patch.awk"
# replace with
patch_file
```
Refer to the [custom bash tools docs](./function-calling/CUSTOM-BASH-TOOLS.md) to learn how to compile and test bash
tools in Loki without needing to use `argc`.
+113
View File
@@ -0,0 +1,113 @@
# Environment Variables
Loki is designed to be highly dynamic and customizable. As a result, Loki utilizes a number of environment variables
that can be used to modify its behavior at runtime without needing to modify the existing configuration files.
Loki also supports defining environment variables via a `.env` file in the Loki configuration directory. This directory
varies between systems, so you can find the location of your configuration directory using the following command:
```shell
loki --info | grep 'config_dir' | awk '{print $2}'
```
## Quick Links
<!--toc:start-->
- [Global Configuration Related Variables](#global-configuration-related-variables)
- [Client Related Variables](#client-related-variables)
- [Files and Directory Related Variables](#files-and-directory-related-variables)
- [Agent Related Variables](#agent-related-variables)
- [Logging Related Variables](#logging-related-variables)
- [Miscellaneous Variables](#miscellaneous-variables)
<!--toc:end-->
---
## Global Configuration Related Variables
All configuration items in the global config file have environment variables that can be overridden at runtime. To see
all configuration options and more thorough descriptions, refer to the [example config file](../config.example.yaml).
Below are the most commonly used configuration settings and their corresponding environment variables:
| Setting | Environment Variable |
|----------------------------|---------------------------------|
| `model` | `LOKI_MODEL` |
| `temperature` | `LOKI_TEMPERATURE` |
| `top_p` | `LOKI_TOP_P` |
| `stream` | `LOKI_STREAM` |
| `save` | `LOKI_SAVE` |
| `editor` | `LOKI_EDITOR` |
| `wrap` | `LOKI_WRAP` |
| `wrap_code` | `LOKI_WRAP_CODE` |
| `save_session` | `LOKI_SAVE_SESSION` |
| `compression_threshold` | `LOKI_COMPRESSION_THRESHOLD` |
| `function_calling_support` | `LOKI_FUNCTION_CALLING_SUPPORT` |
| `enabled_tools` | `LOKI_ENABLED_TOOLS` |
| `mcp_server_support` | `LOKI_MCP_SERVER_SUPPORT` |
| `enabled_mcp_servers` | `LOKI_ENABLED_MCP_SERVERS` |
| `rag_embedding_model` | `LOKI_RAG_EMBEDDING_MODEL` |
| `rag_reranker_model` | `LOKI_RAG_RERANKER_MODEL` |
| `rag_top_k` | `LOKI_RAG_TOP_K` |
| `rag_chunk_size` | `LOKI_RAG_CHUNK_SIZE` |
| `rag_chunk_overlap` | `LOKI_RAG_CHUNK_OVERLAP` |
| `highlight` | `LOKI_HIGHLIGHT` |
| `theme` | `LOKI_THEME` |
| `serve_addr` | `LOKI_SERVE_ADDR` |
| `user_agent` | `LOKI_USER_AGENT` |
| `save_shell_history` | `LOKI_SAVE_SHELL_HISTORY` |
| `sync_models_url` | `LOKI_SYNC_MODELS_URL` |
## Client Related Variables
The following environment variables are available for clients in Loki:
| Environment Variable | Description |
|----------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `{client}_API_KEY` | For clients that require an API key, you can define the keys either through environment variables or <br>using the [vault](./VAULT.md). The variables are named after the client to which they apply; <br>e.g. `OPENAI_API_KEY`, `GEMINI_API_KEY`, etc. |
| `LOKI_PLATFORM` | Combine with `{client}_API_KEY` to run Loki without a configuration file. <br>This variable is ignored if a configuration file exists. |
| `LOKI_PATCH_{client}_CHAT_COMPLETIONS` | Patch chat completion requests to models on the corresponding client; Can modify the URL, body, <br>or headers. |
| `LOKI_SHELL` | Specify the shell that Loki should be using when executing commands |
## Files and Directory Related Variables
You can also customize the files and directories that Loki loads its configuration files from:
| Environment Variable | Description | Default Value |
|----------------------|------------------------------------------------------------------------|---------------------------------|
| `LOKI_CONFIG_DIR` | Customize the location of the Loki configuration directory. | `<user-config-dir>/loki` |
| `LOKI_ENV_FILE` | Customize the location of the `.env` file to load at startup. | `<loki-config-dir>/.env` |
| `LOKI_CONFIG_FILE` | Customize the location of the global `config.yaml` configuration file. | `<loki-config-dir>/config.yaml` |
| `LOKI_ROLES_DIR` | Customize the location of the `roles` directory. | `<loki-config-dir>/roles` |
| `LOKI_SESSIONS_DIR` | Customize the location of the `sessions` directory. | `<loki-config-dir>/sessions` |
| `LOKI_RAGS_DIR` | Customize the location of the `rags` directory. | `<loki-config-dir>/rags` |
| `LOKI_FUNCTIONS_DIR` | Customize the location of the `functions` directory. | `<loki-config-dir>/functions` |
## Agent Related Variables
You can also customize the location of full agent configurations using the following environment variables:
| Environment Variable | Description |
|------------------------------|-------------------------------------------------------------------------------------------------------------------------------------|
| `<AGENT_NAME>_CONFIG_FILE` | Customize the location of the agent's configuration file; e.g. `SQL_CONFIG_FILE` |
| `<AGENT_NAME>_MODEL` | Customize the `model` used for the agent; e.g `SQL_MODEL` |
| `<AGENT_NAME>_TEMPERATURE` | Customize the `temperature` used for the agent; e.g. `SQL_TEMPERATURE` |
| `<AGENT_NAME>_TOP_P` | Customize the `top_p` used for the agent; e.g. `SQL_TOP_P` |
| `<AGENT_NAME>_GLOBAL_TOOLS` | Customize the `global_tools` that are enabled for the agent (a JSON string array); e.g. `SQL_GLOBAL_TOOLS` |
| `<AGENT_NAME>_MCP_SERVERS` | Customize the `mcp_servers` that are enabled for the agent (a JSON string array); e.g. `SQL_MCP_SERVERS` |
| `<AGENT_NAME>_AGENT_SESSION` | Customize the `agent_session` used with the agent; e.g. `SQL_SESSION` |
| `<AGENT_NAME>_INSTRUCTIONS` | Customize the `instructions` for the agent; e.g. `SQL_INSTRUCTIONS` |
| `<AGENT_NAME>_VARIABLES` | Customize the `variables` used for the agent (in JSON format of `[{"key1": "value1", "key2": "value2"}]`); <br>e.g. `SQL_VARIABLES` |
## Logging Related Variables
The following variables can be used to change the log level of Loki or the location of the log file:
| Environment Variable | Description | Default Value |
|----------------------|---------------------------------------------|----------------------------------|
| `LOKI_LOG_LEVEL` | Customize the log level of Loki | `INFO` |
| `LOKI_LOG_FILE` | Customize the location of the Loki log file | `<user-cache-dir>/loki/loki.log` |
**Pro-Tip:** You can always tail the Loki logs using the `--tail-logs` flag. If you need to disable color output, you
can also pass the `--disable-log-colors` flag as well.
## Miscellaneous Variables
| Environment Variable | Description | Default Value |
|----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|
| `AUTO_CONFIRM` | Bypass all `guard_*` checks in the bash prompt helpers; useful for agent composition and routing | |
| `LLM_TOOL_DATA_FILE` | Set automatically by Loki on Windows. Points to a temporary file containing the JSON tool call data. <br>Tool scripts (`run-tool.sh`, `run-agent.sh`, etc.) read from this file instead of command-line args <br>to avoid JSON escaping issues when data passes through `cmd.exe` → bash. **Not intended to be set by users.** | |
+103
View File
@@ -0,0 +1,103 @@
# Macros
Macros are essentially Loki "scripts"; that is, a predefined sequence of REPL commands that automate repetitive tasks or
workflows. Macros run in isolated environments, ensuring that the macros don't inherit any pre-existing role, session,
RAG, or agent state, and they will not affect your current context.
This isolation ensures that your workspace remains clean and unaffected by macro operations.
![Macro Example](./images/macros/macros-example.gif)
For more information on Loki's REPL, refer to the [REPL](./REPL.md) documentation.
## Quick Links
<!--toc:start-->
- [Macro Definition](#macro-definition)
- [Step Definitions](#step-definitions)
- [Macro Variables](#macro-variables)
- [Built-In Macros](#built-in-macros)
<!--toc:end-->
---
## Macro Definition
Macros are defined as YAML files in the `macros` subdirectory of your Loki configuration directory. The Loki configuration
directory can vary between systems, so to find the location of your macros config directory, you can use the following
command:
```shell
loki --info | grep 'macros_dir' | awk '{print $2}'
```
Macro definitions are broken into two parts: the `steps` of the macro, and an optional `variables` section that lets
users pass in variables to alter the behavior of the macro at runtime.
### Step Definitions
The step definitions for a macro are straightforward: They are simply the exact commands you would otherwise type in the
REPL.
**Example: Macro to generate a git commit message**
`macros/generate-commit-message.yaml`
```yaml
steps:
- .file `git diff` -- generate git commit message
```
Usage:
```shell
$ loki --macro generate-commit-message
>> .file `git diff` -- generate a git commit message
Add documentation on macros
```
For a full example configuration, refer to the [example macro configuration file](../config.macro.example.yaml) in the root of this project.
### Macro Variables
Sometimes it's useful to be able to modify the behavior of a macro at runtime. This is achieved with the `variables`
array of the macro definition.
To pass variables to a macro, since they are just Loki scripts, the syntax is the same as it is for any other scripting
language: You just pass them alongside your invocation.
**Example:**
```shell
$ loki --macro example-variable-macro first_argument second_argument
```
Each variable in the `variables` array has the following properties:
* `name` (Required): the name of the variable, which can be referenced in the actual steps of the macro using the
`{{name}}` syntax.
* `default` (Optional): A default value for the variable if no value is specified. If no default value is defined, and
no value is provided for the variable at runtime, Loki will error out.
* `rest` (Optional, Boolean): When set to `true`, this variable will collect all remaining arguments passed to the
macro. This behavior is only applicable when the variable is the last variable in the list. By default, this is
`false`.
The `variables` array is order-dependent; that is to say that all arguments passed to the macro are positional. So be
careful about the ordering if that is important to your macro's invocation.
**Example: Simple variable example to invoke an agent**
`macros/invoke-agent.yaml`
```yaml
variables:
- name: agent # No default value means this must be defined at runtime
- name: args
rest: true # All remaining arguments to the macro are collected into this variable
default: What can you do? # This is used if no value is passed at runtime
steps:
- .agent {{agent}}
- '{{args}}'
```
Usage:
```shell
$ loki --macro invoke-agent sql
# or
$ loki --macro invoke-agent sql What tables are available?
```
For a full example configuration, refer to the [example macro configuration file](../config.macro.example.yaml) in the root of this project.
## Built-In Macros
Loki comes packaged with some useful built-in macros. These are also good examples if you're looking for more examples
on how to make your own macros, so be sure to check out the [built-in macro definitions](../assets/macros) if you're
looking for more examples.
* `generate-commit-message` - Generate a Git commit message based on the staged changes in the current directory
+307
View File
@@ -0,0 +1,307 @@
# RAG
Retrieval Augmented Generation (RAG) is a method of minimizing LLM hallucinations and extending the model's context
without consuming a significant portion of the context length. It uses documents and other additional resources that you
provide to give the model more context for all of your prompts.
Loki has a built-in vector database and full-text search engine to support RAG knowledge bases for your queries.
The generated knowledge bases are stored in the `rag` subdirectory of your Loki configuration directory. The location of
this directory varies by system, so you can use the following command to find your RAG directory:
```shell
loki --info | grep 'rags_dir' | awk '{print $2}'
```
## Quick Links
<!--toc:start-->
- [Usage](#usage)
- [Persistent RAG](#persistent-rag)
- [Ephemeral RAG](#ephemeral-rag)
- [How It Works](#how-it-works)
- [1. Build](#1-build)
- [2. Lookup](#2-lookup)
- [2a. Reranking (Optional)](#2a-reranking-optional)
- [3. Prompt](#3-prompt)
- [Supported Document Sources](#supported-document-sources)
- [Document Loaders](#document-loaders)
- [Document Loader Usage](#document-loader-usage)
- [Advanced Customizations](#advanced-customizations)
- [Embedding Model](#embedding-model)
- [Reranker](#reranker)
- [Chunk Size](#chunk-size)
- [Trade-Offs](#chunk-size-trade-offs)
- [Chunk Overlap](#chunk-overlap)
- [Top K](#top-k)
- [Trade-Offs](#top-k-trade-offs)
- [RAG Template](#rag-template)
<!--toc:end-->
---
## Usage
There's two ways to use RAG in Loki: A persistent RAG that can be loaded on-demand for queries, and an ephemeral one for
adding RAG to a single specific query.
### Persistent RAG
In the REPL, persistent RAG is initialized via the `.rag` command:
![Persistent RAG example](./images/rag/persistent-rag.gif)
The generated RAG is then saved to the `rag` subdirectory of the Loki configuration, and can then be loaded whenever you
want that knowledge base via either `.rag <name>` or `loki --rag <RAG>`.
### Ephemeral RAG
Short-lived RAG that is only used for a single session or query is loaded using `.file`/`--file`.
You can use it to either execute a prompt from a file, or for temporary RAG. The difference is the usage of the `--`
separator. If you only specify a filename and no `--` separator, Loki will know to read the file contents and pass them
as a query to the model. Otherwise, the `--` separator is read to indicate that this is the end of the list of documents
to load into the ephemeral RAG, and what follows is the query to pass to the model.
```shell
.file prompt.md # Read the file as a prompt
.file %% -- translate the last reply to italian
.file `git diff` -- generate a commit message
```
![Ephemeral RAG Example](./images/rag/ephemeral-rag.gif)
Once the session ends, this RAG will no longer be accessible and is only visible to the current session.
#### The `%%` Document Type
In addition to the usual documents that can be specified for persistent RAG, ephemeral RAG has a special `%%` value.
This value references the content of the last reply. So you can use it like this:
```shell
.file %% -- translate the last reply to italian
```
The `--` indicates that this is the end of your documents and the beginning of your prompt.
#### The `cmd` Document Type
Loki also lets you use command outputs for ephemeral RAG input. Simply enclose the command in backticks:
```shell
.file `git diff` -- generate a commit message
```
The `--` indicates that this is the end of your documents and the beginning of your prompt.
## How It Works
#### 1. Build
When you define RAG, Loki will first "build" the RAG. This means that Loki will consume the documents you specified and
generate [embeddings](https://huggingface.co/spaces/hesamation/primer-llm-embedding) for that text. This essentially just means that Loki translates the document into a language
the LLM can understand.
These embeddings are then stored in an in-memory vector database.
#### 2. Lookup
Loki sits between you and the model. So when you submit a prompt to the model, before Loki ever sends it, it will first
convert your prompt into embeddings (LLM language), and look for relevant snippets of text in the vector database.
Loki then passes the top `n`-snippets of text that it finds in the vector database as additional context to the model
before your prompt.
#### 2a. Reranking (Optional)
The lookup for relevant snippets of texts uses embeddings to find text that is semantically similar to your prompt, and
returns the top `n`-results. This often works fairly well, however these top results aren't always the most relevant for
answering the specific query.
Reranking improves these initial results (say, the top 20-100 text snippets) and re-scores them using a more
sophisticated model. The reranker model will rank documents by their actual usefulness for answering the query to ensure
the most relevant context is passed to the model alongside your query.
This reranking model can be customized for each RAG you build in Loki. See the [Custom Reranker](#reranker) section
below for more details on how to customize this.
#### 3. Prompt
Finally, the text snippets that were looked up in RAG are passed to the model as additional context to your prompt,
giving the model query-specific context to answer your question.
## Supported Document Sources
Loki supports a number of document sources that can be used for RAG:
| Source | Example | Comments |
|--------------------------|-----------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------|
| Files | `/tmp/dir1/file1;/tmp/dir1/file2` | |
| Directory | `/tmp/dir` | Picks up all files in a directory and all its subdirectories |
| Directory (extensions} | `/tmp/dir2/**/*.{md,txt}` | Finds all files in all subdirectories with the specified extensions |
| Recursive Filename | `/tmp/*/LOKI.md` | The following files will be picked up: <br><ul><li>`/tmp/dir1/LOKI.md`</li><li>`/tmp/dir2/subdir1/LOKI.md`</li><li>`/tmp/dir2/subdir2/LOKI.md`</li></ul> |
| URL | `https://www.ohdsi.org/data-standardization/` | Downloads and loads the specified webpage into the <br>knowledge base |
| Recursive URL (Websites) | `https://github.com/OHDSI/Vocabulary-v5.0/wiki/**` | Crawls all pages under the given URL and loads them <br>into the knowledge base |
| Document Loader (custom) | `jina:https://cloud.google.com/bigquery/docs/reference/standard-sql/` | Use a custom document loader to parse the given document |
## Document Loaders
Loki only has built-in support for loading text files. But that functionality can be extended to read all kinds of files
into your knowledge bases. These custom loaders are used by both RAG and for documents specified using the
`.file`/`--file` flags.
In the global configuration file, you can specify loaders for specific document types using the `document_loaders`
setting. Each loader is defined by specifying a name and then a command that Loki will execute to load the document.
The following variables are interpolated at runtime by Loki and can be used as placeholders in your command definitions:
* `$1` (Required) - The input file
* `$2` (Optional) - The output file. If omitted, `stdout` is used as the output destination
**Note:** It is your responsibility to ensure that any tools used to parse documents into text that Loki can read are
installed on your system and are available on your `$PATH`. Loki does not have any built-in way of installing
dependencies for document loaders for you.
The following are some example loaders:
```yaml
document_loaders:
pdf: 'pdftotext $1 -' # Use pdftotext to convert a PDF file to text
# (see https://poppler.freedesktop.org for details on how to install pdftotext)
docx: 'pandoc --to plain $1' # Use pandoc to convert a .docx file to text
# (see https://pandoc.org for details on how to install pandoc)
jina: 'curl -fsSL https://r.jina.ai/$1 -H "Authorization: Bearer {{JINA_API_KEY}}' # Use Jina to translate a website into text;
# Requires a Jina API key to be added to the Loki vault
git: > # Use yek to load a git repository into the knowledgebase (https://github.com/bodo-run/yek)
sh -c "yek $1 --json | jq 'map({ path: .filename, contents: .content })'"
```
### Document Loader Usage
Once you have your loaders defined, you can specify when Loki should use them by prefixing any RAG file/directory/URI
with the name of the loader.
**Example: Load a git repo into RAG**
![Git Repo Loader Example](./images/rag/git-loader.png)
**Example: Use pdf loader for ephemeral RAG**
```shell
$ loki --file pdf:some-file.pdf
```
## Advanced Customizations
For those familiar with RAG, Loki exposes a handful of advanced global settings that can be used to tweak your default
RAG configurations.
### Embedding Model
When Loki queries your RAG knowledge bases, it needs to first convert your query into embeddings. By default, Loki uses
the same embedding model that was used to create the knowledge base in the first place.
This can be customized to any other embedding model available in your configured clients by setting the
`rag_embedding_model` setting in your global Loki configuration file:
```yaml
rag_embedding_model: null # Specifies the embedding model used for context retrieval
```
### Reranker
By default, Loki uses [Reciprocal Rank Fusion (RRF)](https://www.elastic.co/docs/reference/elasticsearch/rest-apis/reciprocal-rank-fusion) to merge vector and keyword search results.
You can change the default reranker model to any other reranking model in your configured clients. To change the default
reranker model, simply change the value of the `rag_reranker_model` setting in your global configuration file:
```yaml
rag_reranker_model: null # By default,
```
### Chunk Size
In the context of RAG, the chunk size is the maximum length of each text chunk (measured in characters) that is created
when splitting documents. In Loki, this defaults to `2000` characters.
You can specify a different global default by setting the `rag_chunk_size` property in your global configuration file:
```yaml
rag_chunk_size: null # Defines the size of chunks for document processing in characters
```
#### Chunk Size Trade-Offs
Keep in mind the following trade-offs when changing the chunk size:
* **Smaller chunks (e.g. 256 characters):** More precise retrieval, better semantic focus, but may lack context or split
important information
* **Larger chunks (e.g. 1024 characters):** More context preserved, fewer chunks to manage, but less precise matching
and more noise in retrieved document
### Chunk Overlap
Chunk overlap in RAG is the number of characters that overlap between consecutive chunks to maintain continuity.
---
**Example:** If the following sentence is cut off at the end of one chunk
`I was doing fine until someone brought up`
You'll ideally want that full sentence to be picked up at the beginning of the next chunk to make sure the full meaning
is captured. So in this example, if your chunk overlap is 42 characters, then the start of the next chunk would look
like this:
`I was doing fine until someone brought up the game. <next sentence>`
---
Often, this value is 10%-20% of the chunk size.
By default, in Loki, this value is 5% the chunk size. You can override this and specify the default chunk overlap (in
characters) that Loki should use as a global default by setting the `rag_chunk_overlap` property in the global Loki
configuration file:
```yaml
rag_chunk_overlap: null # Defines the overlap between chunks
```
### Top K
In RAG, `top_k` represents the top `k`-chunks to return from the vector database query. Think of it like if you search
something on Google and only care about the top 10 results, that's what you'll use for your context.
In Loki, the default value for this is `5`. You can customize this global default by setting the `rag_top_k` property in
your global configuration file:
```yaml
rag_top_k: 5 # Specifies the number of documents to retrieve for answering queries
```
#### Top K Trade-Offs
When customizing this value, keep in mind the following trade-offs so you get the best performance:
* **Lower top_k (e.g. 3):** Faster, more focused context, lower cost, but risks missing relevant information
* **Higher top_k (e.g. 10):** More comprehensive coverage, but more noise, higher latency, increased token costs, and
potential context window constraints
### RAG Template
When you use RAG in Loki, after Loki performs the lookup for relevant chunks of text to add as context to your query, it
will add the retrieved text chunks as context to your query before sending it to the model. The format of this context
is determined by the `rag_template` setting in your global Loki configuration file.
This template utilizes three placeholders:
* `__INPUT__`: The user's actual query
* `__CONTEXT__`: The context retrieved from RAG
* `__SOURCES__`: A numbered list of the source file paths or URLs that the retrieved context came from
These placeholders are replaced with the corresponding values into the template and make up what's actually passed to
the model at query-time. The `__SOURCES__` placeholder enables the model to cite which documents its answer is based on,
which is especially useful when building knowledge-base assistants that need to provide verifiable references.
The default template that Loki uses is the following:
```text
Answer the query based on the context while respecting the rules. (user query, some textual context and rules, all inside xml tags)
<context>
__CONTEXT__
</context>
<sources>
__SOURCES__
</sources>
<rules>
- If you don't know, just say so.
- If you are not sure, ask for clarification.
- Answer in the same language as the user query.
- If the context appears unreadable or of poor quality, tell the user then answer as best as you can.
- If the answer is not in the context but you think you know the answer, explain that to the user then answer with your own knowledge.
- Answer directly and without using xml tags.
- When using information from the context, cite the relevant source from the <sources> section.
</rules>
<user_query>
__INPUT__
</user_query>
```
You can customize this template by specifying the `rag_template` setting in your global Loki configuration file. Your
template *must* include both the `__INPUT__` and `__CONTEXT__` placeholders in order for it to be valid. The
`__SOURCES__` placeholder is optional. If it is omitted, source references will not be included in the prompt.
+117
View File
@@ -0,0 +1,117 @@
# Customize REPL Prompt
The prompt you see when you start the Loki REPL can be customized to your liking. This is achieved via the `left_prompt`
and `right_prompt` settings in the global Loki configuration file:
```yaml
left_prompt: '{color.red}{model}){color.green}{?session {?agent {agent}>}{session}{?role /}}{!session {?agent {agent}>}}{role}{?rag @{rag}}{color.cyan}{?session )}{!session >}{color.reset} '
right_prompt: '{color.purple}{?session {?consume_tokens {consume_tokens}({consume_percent}%)}{!consume_tokens {consume_tokens}}}{color.reset}'
```
The location of the global configuration file differs between systems, so you can use the following command to find your
global configuration file's location:
```shell
loki --info | grep 'config_file' | awk '{print $2}'
```
## Quick Links
<!--toc:start-->
- [Syntax](#syntax)
- [Variables](#variables)
<!--toc:end-->
## Syntax
The syntax for the prompts consists of plain text and templates contained in `{...}`. The plain text is
printed exactly as given.
The syntax for the templates `{...}` is as follows:
* `{variable}` - Replaced with the value of `variable`
* `{?variable <template>}` - Evaluate the `<template>` when `variable` is evaluated to `true`
* `{!variable <template>}` - Evaluate the `<template>` when `variable` is evaluated to `false`
Where a `<template>` is another expression consisting of plain text and/or more special computations inside `{...}`.
Variables are evaluated to also be "truthy"; that is, if a variable is undefined, it is considered to be the exact same
as if that variable's value was `false`.
**Example 1: Simple Boolean Usage**
For the prompt `{?variable yay}{!variable boo}`, if `variable=true`, then the output will be
```
yay
```
And if `variable=false`:
```
boo
```
**Example 2: Nested Expressions**
For the prompt `{?variable {!variable2 yay}>}`, and assuming
* `variable=true`
* `variable2=false`
the output will be
```
yay>
```
If `variable2=true`, the output will be empty.
If `variable=false`, the output will be empty.
## Variables
The following variables and output modifiers are available to you when you're creating your prompts:
```yaml
# Model Variables
model: openai:gpt-4 # The active model's full name
client_name: openai # The name of the client serving the active model
model_name: gpt-4 # The aliased name of the active model
max_input_tokens: 4096 # The maximum number of input tokens for the active model
# Configuration Variables
temperature: 1.0 # The temperature for the active model
top_p: 0.9 # The top_p for the active model
dry_run: true # Whether the given command is flagged to be a dry run
stream: false # Whether streaming responses are enabled
save: true # Whether shell history is saved
wrap: 120 # The number of characters to allow before wrapping around output to the next line
# Role Variables
role: code # The active role
# Session Variables
session: temp # The name of the active session
dirty: false # Whether the session settings have been updated but not persisted
consume_tokens: 200 # The number of tokens consumed
consume_percent: 1% # The percentage of tokens consumed to the maximum input tokens
user_messages_len: 0 # The total number of sent user messages
# RAG Variables
rag: temp # The name of the active RAG
# Agent Variables
agent: todo-sh # The name of the active agent
# ANSI COLORS
color.reset:
color.black:
color.dark_gray:
color.red:
color.light_red:
color.green:
color.light_green:
color.yellow:
color.light_yellow:
color.blue:
color.light_blue:
color.purple:
color.light_purple:
color.magenta:
color.light_magenta:
color.cyan:
color.light_cyan:
color.white:
color.light_gray:
```
+260
View File
@@ -0,0 +1,260 @@
# Loki REPL Guide
In addition to being a CLI, Loki also has a built-in REPL (Read-Execute-Print-Loop). This enables users to quickly try
out prompts, commands, configurations, and everything in between without having to modify the same command every time.
You can enter the REPL by simply typing `loki` without any follow-up flags or arguments.
## Quick Links
<!--toc:start-->
- [Features](#features)
- [REPL Commands](#repl-commands)
- [`.model` - Change the current LLM](#model---change-the-current-llm)
- [`.role` - Role management](#role---role-management)
- [`.prompt` - Set a temporary role using a prompt](#prompt---set-a-temporary-role-using-a-prompt)
- [`.session` - Session management](#session---session-management)
- [`.agent` - Chat with an AI agent](#agent---chat-with-an-ai-agent)
- [`.rag` - Chat with documents](#rag---chat-with-documents)
- [`.macro` - Execute a macro](#macro---execute-a-macro)
- [`.file` - Read files and use them as input](#file---read-files-and-use-them-as-input)
- [`.vault` - Manage the Loki vault](#vault---manage-the-loki-vault)
- [`.continue` - Continue the previous response](#continue---continue-the-previous-response)
- [`.regenerate` - Regenerate the last response](#regenerate---regenerate-the-last-response)
- [`.copy` - Copy the last response to your clipboard](#copy---copy-the-last-response-to-your-clipboard)
- [`.set` - Adjust runtime settings](#set---adjust-runtime-settings)
- [`.edit` - Modify configuration files](#edit---modify-configuration-files)
- [`.delete` - Delete configurations from Loki](#delete---delete-configurations-from-loki)
- [`.info` - Display information about the current mode](#info---display-information-about-the-current-mode)
- [`.authenticate` - Authenticate the current model client via OAuth](#authenticate---authenticate-the-current-model-client-via-oauth)
- [`.exit` - Exit an agent/role/session/rag or the Loki REPL itself](#exit---exit-an-agentrolesessionrag-or-the-loki-repl-itself)
- [`.help` - Show the help guide](#help---show-the-help-guide)
<!--toc:end-->
---
## Features
The REPL has features that are intended to make your Loki experience as easy and as enjoyable as possible! This includes
things like
* **Tab Autocompletion:** Every command in the REPL (i.e. everything that starts with a `.`) has fuzzy search auto
completions.
* `.<tab>` to complete REPL commands
* `.model <tab>` to complete chat models
* `.set <tab>` to complete configuration keys
* `.set key <tab>` to complete configuration values
* **Multi-Line Prompts:** You can also type prompts that span more than one line to help organize your thoughts. This
can be done in the following ways:
* `Ctrl-o` to open the current input buffer in your preferred editor (either the value of `editor` or `$EDITOR`)
* You can paste multi-line text
* You can type `:::` to start multi-line editing, and use `:::` to finish it.
* And finally, you can use hotkeys like `{ctrl/shift/alt}+enter` or `ctrl-j` to insert a new line directly in the
REPL.
* **History Search** Press `ctrl+r` to search the REPL history, and navigate it with `↑↓`
* **Configurable Keybindings:** You can switch between `emacs` style keybindings or `vi` style keybindings
* [**Custom REPL Prompt:**](./REPL-PROMPT.md) You can even customize the REPL prompt to display information about the
current context in the prompt
* **Built-in user interaction tools:** When function calling is enabled in the REPL, the `user__ask`, `user__confirm`,
`user__input`, and `user__checkbox` tools are always available for interactive prompts. These are not injected in the
one-shot CLI mode.
---
## REPL Commands
All REPL commands begin with a `.` to indicate that they're not part of a prompt. The following list details the
commands available in Loki:
### `.model` - Change the current LLM
When browsing models in the REPL, use the following legend to understand the purpose of each column in the model table:
```
openai:gpt-4o 128000 / 4096 | 5 / 15 👁 ⚒
| | | | | | └─ supports function calling
| | | | | └─ support vision (multi-modal)
| | | | └─ output price ($/1M)
| | | └─ input price ($/1M)
| | |
| | └─ max output tokens
| └─ max input tokens
└─ model id
```
![model](./images/repl/model.gif)
For more information about how to add models to Loki, refer to the [clients documentation](./clients/CLIENTS.md).
### `.role` - Role management
Loki offers the following commands to manage your roles:
| Command | Description |
|--------------|-------------------------------------------------------------------------|
| `.role` | Create or switch to a role |
| `.info role` | Show information about the active role |
| `.edit role` | Open the active role's configuration file in your preferred text editor |
| `.save role` | Save the active role and its configurations to a configuration file |
| `.exit role` | Exit the active role |
![role](./images/roles/code.gif)
For more information about roles in Loki and how to build them, refer to the [roles documentation](./ROLES.md).
### `.prompt` - Set a temporary role using a prompt
If you need to create a temporary role that you want to discard after use, you use `.prompt`. `.prompt`-based roles
cannot be persisted to a file and saved.
![prompt-role](./images/roles/prompt-role.gif)
### `.session` - Session management
Use the following commands to manage sessions in Loki:
| Command | Description |
|---------------------|---------------------------------------------------------------------------------------------|
| `.session` | Start or switch to a session |
| `.empty session` | Clear all messages for the active session |
| `.compress session` | Compress the session messages using the `summarization_prompt` setting in the global config |
| `.info session` | Display information about the active session |
| `.edit session` | Open the active session's configuration in your preferred text editor |
| `.save session` | Save the active session to a `session` configuration file |
| `.exit session` | Exit the active session |
![sessions](./images/sessions/sessions-example.gif)
For more information on sessions and how to use them in Loki, refer to the [sessions documentation](./SESSIONS.md).
### `.agent` - Chat with an AI agent
Loki lets you build OpenAI GPT-style agents. The following commands let you interact with and manage your agents in
Loki:
| Command | Description |
|----------------------|-----------------------------------------------------------------------------------------------|
| `.agent` | Use an agent |
| `.starter` | Display and use conversation starters for the active agent |
| `.clear todo` | Clear the todo list and stop auto-continuation (requires `auto_continue: true` on the agent) |
| `.edit agent-config` | Open the agent configuration in your preferred text editor |
| `.info agent` | Display information about the active agent |
| `.exit agent` | Leave the active agent |
![agent](./images/agents/sql.gif)
For more information on agents in Loki and how to create them, refer to the [agents documentation](./AGENTS.md).
### `.rag` - Chat with documents
RAG (Retrieval Augmented Generation) enables you to load documents into the LLM so you can ask questions about it or
complete tasks using the documents as additional context.
| Command | Description |
|------------------|------------------------------------------------------------------------------|
| `.rag` | Initialize or access a RAG |
| `.edit rag-docs` | Add or remove documents from the active RAG using your preferred text editor |
| `.rebuild rag` | Rebuild the active RAG to accommodate document changes |
| `.sources rag` | Show a works-cited of the sources used in the last query |
| `.info rag` | Display information about the active RAG |
| `.exit rag` | Exit the active RAG |
![rag](./images/rag/persistent-rag.gif)
For more information about RAG in Loki and how to utilize it, refer to the [rag documentation](./RAG.md).
### `.macro` - Execute a macro
Macros in Loki are like "scripts" of commands that can be run in isolated environments; that means they do not use any
active settings and use the same settings they had when written. They are created/executed using the `.macro <name>`
command.
![macro](./images/macros/macros-example.gif)
For more information on macros in Loki and how to create them, refer to the [macros documentation](./MACROS.md).
### `.file` - Read files and use them as input
Loki lets you specify any number of documents that you can load and use as ephemeral RAG to chat with the LLM. To see
what files or values you can pass to it, simply run the command `.file` with no arguments:
```shell
openai:gpt-4o)> .file
Usage: .file <file|dir|url|%%|cmd>... [-- <text>...]
```
![ephemeral-rag](./images/rag/ephemeral-rag.gif)
For more information about ephemeral RAG, refer to the [ephemeral RAG documentation](./RAG.md#ephemeral-rag).
### `.vault` - Manage the Loki vault
The Loki vault lets users store sensitive secrets and credentials securely so that there's no plaintext secrets
anywhere in your configurations.
![vault](./images/vault/vault-demo.gif)
For more information about the Loki vault, refer to the [vault documentation](./VAULT.md).
### `.continue` - Continue the previous response
When you have a response that exceeds the context length, you can use the `.continue` command to continue the generation
of the last response.
![continue](./images/repl/continue.gif)
### `.regenerate` - Regenerate the last response
If ever your response is interrupted, or you want to try generating it again, you can use the `.regenerate` command to do
this without having to retype your query:
![regenerate](./images/repl/regenerate.gif)
### `.copy` - Copy the last response to your clipboard
If you're trying to copy the last response (like copying some code), you can use the `.copy` command to copy the entire
last response to your system clipboard:
![copy](./images/repl/copy.gif)
### `.set` - Adjust runtime settings
You can use `.set` to adjust select settings at runtime. This is useful when you're experimenting with settings and want
to know how they'll affect Loki. To persist the changes you make, be sure to update them in the global configuration
file.
![set](./images/repl/set.gif)
### `.edit` - Modify configuration files
The `.edit` command lets you modify configuration files for the current mode of the REPL. It will open the selected
configuration in your preferred text editor. It lets you modify the following configurations:
* `.edit config` - Modify the global configuration
* `.edit role` - Modify the active role's configuration
* `.edit session` - Modify the active session's configuration
* `.edit agent-config` - Modify the active agent's configuration
* `.edit rag-docs` - Add or remove documents from the active RAG
### `.delete` - Delete configurations from Loki
The `.delete` command allows you to delete entities in Loki without having to directly run `rm -rf` on the configuration
directory or file corresponding to the target entity. You can use it to delete the following entities:
* `.delete role` - Delete select roles
* `.delete session` - Delete select sessions
* `.delete macro` - Delete select macros
* `.delete rag` - Delete select RAGs
* `.delete agent-data` - Delete select agent's configurations and all tools
### `.info` - Display information about the current mode
The `.info` command provides useful information about different modes that Loki may be operating in. It's helpful if you
want a quick understanding of the system info, a role's configuration, an agent's configuration, etc.
The following entities are supported:
| Command | Description |
|-----------------|-------------------------------------------------------------|
| `.info` | Display system information (identical to the `--info` flag) |
| `.info role` | Display information about the active role |
| `.info session` | Display information about the active session |
| `.info agent` | Display information about the active agent |
| `.info rag` | Display information about the active RAG |
### `.authenticate` - Authenticate the current model client via OAuth
The `.authenticate` command will start the OAuth flow for the current model client if
* The client supports OAuth (See the [clients documentation](./clients/CLIENTS.md#providers-that-support-oauth) for supported clients)
* The client is configured in your Loki configuration to use OAuth via the `auth: oauth` property
### `.exit` - Exit an agent/role/session/rag or the Loki REPL itself
The `.exit` command is used to move between modes in the Loki REPL.
| Command | Description |
|-----------------|-------------------------|
| `.exit role` | Exit the active role |
| `.exit session` | Exit the active session |
| `.exit agent` | Exit the active agent |
| `.exit rag` | Exit the active RAG |
| `.exit` | Exit the Loki REPL |
### `.help` - Show the help guide
Just like with any shell or REPL, you sometimes need a little help and want to know what commands are available to you.
That's when you use the `.help` command.
+266
View File
@@ -0,0 +1,266 @@
# Roles
When customizing the behavior or LLMs, we use roles to "constrain" the responses or behavior of the LLM to whatever
purpose we desire.
Think of them kind of like a baby: That baby can grow up to do anything! Be a resume builder, teacher, engineer, etc.
The only difference is that with roles, we're explicitly telling the LLM what we want it to be. Also: the LLM is already
grown up so we don't have to wait!
![Role demo](./images/roles/code.gif)
## Quick Links
<!--toc:start-->
- [Role Definition](#role-definition)
- [Metadata Header](#metadata-header)
- [Instructions](#instructions)
- [Special Case: Metadata Header Only](#special-case-metadata-header-only)
- [Prompt Types](#prompt-types)
- [Embedded Prompts](#embedded-prompts)
- [System Prompts](#system-prompts)
- [Few-Shot Prompt](#few-shot-prompt)
- [Built-In Roles](#built-in-roles)
<!--toc:end-->
---
## Role Definition
Roles in Loki are Markdown files that live in the `roles` directory of your Loki configuration. Loki configuration
locations vary between systems, so you can use the following command to find the location of your roles configuration
directory:
```shell
loki --info | grep 'roles_dir' | awk '{print $2}'
```
All role configuration files have two parts: The metadata header, and the instructions.
**Example:** An expert resume builder role that specializes in helping users build and refine their resumes.
```markdown
---
# This is the metadata header
name: resume-builder
model: openai:gpt-4o
temperature: 0.2
top_p: 0
enabled_tools: fs_ls,fs_cat
enabled_mcp_servers: github
---
<!-- This is the instructions -->
You are an expert resume builder.
```
To see a full example configuration for a role, refer to the [example role configuration](../config.role.example.md)
file in the root of the repo.
### Metadata Header
The metadata header in all role configuration files is completely optional. It lets you define role-specific settings
for each role that make the model work the way you want for your role. This includes things like forcing your role to
always use a specific model, set of tools, and tailoring the hyperparameters of the model for your role.
The header consists of a YAML-formatted list of settings that let you customize the model behavior for your role. These
settings sit between `---` separators in your role configuration so Loki knows they're not part of the instructions you
want to feed the model.
The following table lists the available configuration settings and their default values (if undefined):
| Setting | Default | Description |
|-----------------------|----------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------|
| `name` | The name of the role markdown file | The name of the role |
| `model` | Default configured model or currently in-use model (REPL mode) | The preferred model to use with this role |
| `temperature` | Default `temperature` for the preferred model | Controls the creativity and randomness of the model's responses |
| `top_p` | Default `top_p` for the preferred model | Alternative way to control the model's output diversity, affecting the <br>probability distribution of tokens |
| `enabled_tools` | Global setting for `enabled_tools` | The tools that this role utilizes |
| `enabled_mcp_servers` | Global setting for `enabled_mcp_servers` | The MCP servers that this role utilizes |
| `prompt` | `null` | See [Prompt Types](#prompt-types) for detailed usage |
### Instructions
The instructions for a role is what you use to tell the model how you want it to behave. This typically consists of one
or two sentences, but can be more. To see some examples, look at the [built-in roles](../assets/roles) to see how they are defined.
**Pro-Tip:** The struggle to create good instructions for a role (or any other kind of instructions for your model) is
so common, that Loki comes with a role to help you write instructions for roles! Simply invoke the role to start
creating a role with the `create-prompt` role:
```shell
loki -r create-prompt
```
### Special Case: Metadata Header Only
When instructions are defined, the metadata header is optional. However sometimes we want a way to enable specific
functions or MCP servers when prompting different models. In this situation, you need only specify the metadata header
to just enable these settings as you like.
**Example: Role that enables all filesystem tools**
`roles/filesystem-functions.md`
```markdown
---
enabled_tools: fs_ls,fs_cat,fs_mkdir,fs_patch,fs_write
---
```
**Example: Role that enables the GitHub MCP server with the ollama:deepseek-r1 model**
`roles/github.md`
```markdown
---
model: ollama:deepseek-r1
enabled_mcp_servers: github
---
```
For more examples of this special use case of roles, you can look at the role configuration files for the following
built-in roles:
* [explain-shell](../assets/roles/explain-shell.md) - Explains cryptic shell commands in natural language
* [functions](../assets/roles/functions.md) - Enables all available functions (i.e. all globally `visible_functions`)
* [mcp-servers](../assets/roles/mcp-servers.md) - Enables all available MCP servers
## Special Variables
Loki has a set of built-in special variables that it will inject into your role's instructions if it finds them in the
`{{variable_name}}` syntax. The available special variables are listed below:
| Name | Description | Example |
|-----------------|-----------------------------------------------------------|----------------------------|
| `__os__` | Operating system name | `linux` |
| `__os_family__` | Operating system family | `unix` |
| `__arch__` | System architecture | `x86_64` |
| `__shell__` | The current user's default shell | `bash` |
| `__locale__` | The current user's preferred language and region settings | `en-US` |
| `__now__` | Current timestamp in ISO 8601 format | `2025-11-07T10:15:44.268Z` |
| `__cwd__` | The current working directory | `/tmp` |
## Prompt Types
In Loki, you can also create roles with pre-configured prompts so you can template prompts for your use cases. This is
the purpose of the `prompt` field in the role's metadata header.
There's three types of prompts you can create:
### Embedded Prompts
Embedded prompts let you create templated prompts for any input given to it. They are ideal for concise, input-driven
replies from the model. The input that users pass to Loki are injected into your prompt via a `__INPUT__` placeholder in
your prompt.
**Example: Role to convert the given input to TOML**
`roles/convert-to-toml.md`
```markdown
---
prompt: convert __INPUT__ to TOML
---
Convert the given input to TOML format. Exclude any markdown formatting or code blocks and only output code.
```
Usage:
```shell
$ loki -r json-to-toml '{"test":"hi me"}'
test = "hi me"
```
Without the instructions (i.e. the prompt after the metadata header), this role would simply generate the following
message for the model:
```json
[
{"role": "user", "content": "convert {\"test\":\"hi me\"} to TOML"}
]
```
### System Prompts
System prompts let you set the general context of the LLMs behavior. This is no different than other system prompts you
define in ChatGPT, Claude, Open WebUI, etc.
They are essentially Embedded Prompts without an `__INPUT__` placeholder.
**Example: Role to convert all input words to emoji**
`roles/emoji.md`
```markdown
---
prompt: convert my words to emojis
---
Convert all given input words into emojis
```
Usage:
```shell
$ loki -r emoji music joy
🎵 😊
```
Without the instructions (i.e. the prompt after the metadata header), this role would simply generate the following
messages for the model:
```json
[
{"role": "system", "content": "convert my words to emojis"},
{"role": "user", "content": "music joy"}
]
```
### Few-Shot Prompt
[Few-Shot prompting](https://www.promptingguide.ai/techniques/fewshot) is a technique to enable in-context learning for LLMs by providing examples in the prompt to steer
the model to better performance. In Loki, this is done as an extension of System Prompts.
**Example: Role to output code only**
`roles/code-generator.md`
~~~markdown
---
prompt: |-
Output code only without comments or explanations.
### INPUT:
async sleep in js
### OUTPUT:
```javascript
async function timeout(ms) {
return new Promise(resolve => setTimeout(resolve, ms));
}
```
---
Output code only in response to the user's request
~~~
Usage:
~~~shell
$ loki -r code-generator python add two numbers
```python
# Function to add two numbers
def add_numbers(num1, num2):
return num1 + num2
# Example usage
number1 = 5
number2 = 7
result = add_numbers(number1, number2)
print(f"The sum of {number1} and {number2} is {result}.")
```
~~~
Without the instructions (i.e. the prompt after the metadata header), this role would simply generate the following
messages for the model:
```json
[
{"role": "system", "content": "Output code only without comments or explanations."},
{"role": "user", "content": "async sleep in js"},
{"role": "assistant", "content": "```javascript\nasync function timeout(ms) {\n return new Promise(resolve => setTimeout(resolve, ms));\n}\n```"},
{"role": "user", "content": "python add two numbers"}
]
```
## Built-In Roles
Loki comes packaged with some useful built-in roles. These are also good examples if you're looking for more examples on
how to make your own roles, so be sure to check out the [built-in role definitions](../assets/roles) if you're looking
for more examples.
* `code`: Generates code (used by `loki -c`)
* `create-prompt`: Creates a prompt based on the user's input
* `create-title`: Creates 3-6 word titles based on the user's input
* `explain-shell`: Explains shell commands
* `functions`: Enable all globally-visible functions
* `github`: Interact with GitHub using natural language
* `mcp-servers`: Enables all MCP servers
* `repo-analyzer`: Ask questions about the code repository in the current working directory
* `shell`: Convert natural language into shell commands (used by `loki -e`)
* `slack`: Interact with Slack using natural language
## Temporary Roles
Loki also enables you to create temporary roles that will be discarded once you're finished with them. This is done via
the `.prompt/--prompt` command:
![prompt role](./images/roles/prompt-role.gif)
+44
View File
@@ -0,0 +1,44 @@
# Sessions
By default, Loki does not send back all previous messages in a conversation to the model. This means that each time you
query a model, it's essentially a one-off. However, Loki does support chat-like conversations with LLMs via its
`sessions` mechanism.
Sessions in Loki enable the familiar conversational interactions with LLMs. This means you can reference previous
answers and ask follow-up questions and the model will know what you're referring to.
Sessions can be temporary, or can be saved so you can continue conversations at a later time.
Saved sessions are stored in the `sessions` subdirectory of the Loki configuration directory. The location of the
`sessions` directory varies by system, so you can use the following command to find the `sessions` directory if you need
it:
```shell
loki --info | grep 'sessions_dir' | awk '{print $2}'
```
## Usage
When you use a session in Loki, you can either persist it or discard it once you're done. Sessions you discard are then
just considered 'temporary' sessions.
![Persistent Session Example](./images/sessions/sessions-example.gif)
Sessions you persist and then load again later will inherit the same configuration as was used during the last usage of
that session. That is to say, if you had certain tools or MCP servers enabled when you were last in that session, they
will be available again when you continue that session.
## Configuration
Session behavior can be configured from the global Loki configuration file. The location of this file varies between
systems so you can use the following command to locate it on your system:
```shell
loki --info | grep 'config_file' | awk '{print $2}'
```
The following settings are available to customize the default behavior of sessions globally:
| Setting | Description |
|--------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `save_session` | Controls the persistence of the session. <br><ul><li>If `true`, then any time you're in a session, changes will auto-save unless explicitly defined otherwise.</li> <li>If `false`, then any time you're in a session, changes will not auto-save unless explicitly specified otherwise.</li><li>If `null`, Loki will always prompt the user for what to do.</li></ul> |
| `compression_threshold` | Defines the token count threshold at which Loki will compress the session to save on the context length |
| `summarization_prompt` | This is the prompt that is used to compress the session up to a given point when compression is triggered |
| `summary_context_prompt` | This is the prompt that's used to add the summarized conversation generated by the `summarization_prompt` as context to the model |
+104
View File
@@ -0,0 +1,104 @@
# Loki Shell Integrations
Loki supports the following integrations with a handful of shell environments to enhance user experience and streamline workflows.
## Tab Completions
### Dynamic
Dynamic tab completions are supported by Loki to assist users in quickly completing commands, options, and arguments.
You can enable it by using the corresponding command for your shell. To enable dynamic tab completions for every
shell session (i.e. persistently), add the corresponding command to your shell's configuration file as indicated:
```shell
# Bash
# (add to: `~/.bashrc`)
source <(COMPLETE=bash loki)
# Zsh
# (add to: `~/.zshrc`)
source <(COMPLETE=zsh loki)
# Fish
# (add to: `~/.config/fish/config.fish`)
source <(COMPLETE=fish loki | psub)
# Elvish
# (add to: `~/.elvish/rc.elv`)
eval (E:COMPLETE=elvish loki | slurp)
# PowerShell
# (add to: `$PROFILE`)
$env:COMPLETE = "powershell"
loki | Out-String | Invoke-Expression
```
At the time of writing, `nushell` is not yet fully supported for dynamic tab completions due to limitations
in the [`clap`](https://crates.io/crates/clap) crate. However, `nushell` support is being actively developed, and will
be added in a future release.
Progress on this feature can be tracked in the following issue: [Clap Issue #5840](https://github.com/clap-rs/clap/issues/5840).
### Static
Static tab completions (i.e. pre-generated completion scripts that are not context aware) can also be generated using the
`--completions` flag. You can enable static tab completions by using the corresponding commands for your shell. These commands
will enable them for every shell session (i.e. persistently):
```shell
# Bash
echo 'source <(loki --completions bash)' >> ~/.bashrc
# Zsh
echo 'source <(loki --completions zsh)' >> ~/.zshrc
# Fish
echo 'loki --completions fish | source' >> ~/.config/fish/config.fish
# Elvish
echo 'eval (loki --completions elvish | slurp)' >> ~/.elvish/rc.elv
# Nushell
[[ -d ~/.config/nushell/completions ]] || mkdir -p ~/.config/nushell/completions
loki --completions nushell | save -f ~/.config/nushell/completions/loki.nu
echo 'use ~/.config/nushell/completions/cli.nu *' >> ~/.config/nushell/config.nu
# PowerShell
Add-content $PROFILE "loki --completions powershell | Out-String | Invoke-Expression"
```
## Shell Assistant
Loki has an `-e,--execute` flag that allows users to run natural language commands directly from the CLI. It accepts
natural language input and translates it into executable shell commands.
![Shell Assistant Demo](./images/shell_integrations/assistant.gif)
## Intelligent Command Completions
Loki also provides shell scripts that bind `Alt-e` to `loki -e "<current command line>"`, allowing users to generate
commands from natural text directly without invoking the CLI.
For example:
```shell
$ find all typescript files with more than 100 lines<Alt-e>
# Gets replaced with
$ find . -name '*.ts' -type f -exec awk 'NR>100{exit 1}' {} \; -print
```
To use the CLI helper, add the content of the appropriate integration script for your shell to your shell configuration file:
* [Bash Integration](../scripts/shell-integration/integration.bash) (add to: `~/.bashrc`)
* [Zsh Integration](../scripts/shell-integration/integration.zsh) (add to: `~/.zshrc`)
* [Elvish Integration](../scripts/shell-integration/integration.elv) (add to: `~/.elvish/rc.elv`)
* [Fish Integration](../scripts/shell-integration/integration.fish) (add to: `~/.config/fish/config.fish`)
* [Nushell Integration](../scripts/shell-integration/integration.nu) (add to: `~/.config/nushell/config.nu`)
* [PowerShell Integration](../scripts/shell-integration/integration.ps1) (add to: `$PROFILE`)
## Explain Commands
In addition to the Shell Assistant, Loki has a built-in role that explains shell commands to you to decipher their
language. So if Loki generates a command that you're unsure of what it does, simply pass it to the `explain-shell` role:
![Explain Shell Role](./images/shell_integrations/explain-shell.png)
## Code Generation
Users can also directly generate code snippets from natural language prompts using the `-c,--code` flag.
![Code Generation Demo](./images/shell_integrations/code-generation.gif)
**Pro Tip:** Pipe the output of the code generation directly into `tee` to ensure the generated code is properly extracted
from any generated Markdown (i.e. remove any triple backticks).
+71
View File
@@ -0,0 +1,71 @@
# Theming Loki
Loki supports customizing the theme via a `.tmTheme` file.
## Setup
To install a custom theme, download the `.tmTheme` file to the Loki configuration directory and name it `dark.tmTheme`
or `light.tmTheme`. The location of the Loki configuration directory varies between systems, so you can use the
following command to locate it on your system:
```shell
loki --info | grep 'config_dir' | awk '{print $2}'
```
## Themes
### 1337-Scheme
https://raw.githubusercontent.com/MarkMichos/1337-Scheme/ca6a329cfda8307449d405b70f8fab34b8fd23b5/1337.tmTheme
![1337-scheme](./images/themes/1337-scheme.png)
### Coldark
https://raw.githubusercontent.com/ArmandPhilippot/coldark-bat/e44750b2a9629dd12d8ed3ad9fd50c77232170b9/Coldark-Dark.tmTheme
![coldark](./images/themes/coldark.png)
### Dracula
https://raw.githubusercontent.com/dracula/sublime/c2de0acf5af67042393cf70de68013153c043656/Dracula.tmTheme
![dracula](./images/themes/dracula.png)
### GitHub
https://raw.githubusercontent.com/AlexanderEkdahl/github-sublime-theme/508740b2430c3c3a9e785fc93ee1d7c6f233af53/GitHub.tmTheme
![github](./images/themes/github.png)
### gruvbox
#### Dark
https://raw.githubusercontent.com/subnut/gruvbox-tmTheme/64c47250e54298b91e2cf8d401320009aba9f991/gruvbox-dark.tmTheme
![gruvbox-dark](./images/themes/gruvbox-dark.png)
#### Light
https://raw.githubusercontent.com/subnut/gruvbox-tmTheme/64c47250e54298b91e2cf8d401320009aba9f991/gruvbox-light.tmTheme
![gruvbox-light](./images/themes/gruvbox-light.png)
### OneHalf
#### Dark
https://raw.githubusercontent.com/sonph/onehalf/141c775ace6b71992305f144a8ab68e9a8ca4a25/sublimetext/OneHalfDark.tmTheme
![onehalf-dark](./images/themes/onehalf-dark.png)
#### Light
https://raw.githubusercontent.com/sonph/onehalf/141c775ace6b71992305f144a8ab68e9a8ca4a25/sublimetext/OneHalfLight.tmTheme
![onehalf-light](./images/themes/onehalf-light.png)
### Solarized
#### Dark
https://raw.githubusercontent.com/braver/Solarized/87e01090cggjf5fb821a234265b3138426ae84900e7/Solarized%20(dark).tmTheme
![solarized-dark](./images/themes/solarized-dark.png)
#### Light
https://raw.githubusercontent.com/braver/Solarized/87e01090cf5fb821a234265b3138426ae84900e7/Solarized%20(light).tmTheme
![solarized-light](./images/themes/solarized-light.png)
### Sublime Snazzy
https://raw.githubusercontent.com/greggb/sublime-snazzy/70343201f1d7539adbba3c79e2fe81c2559a0431/Sublime%20Snazzy.tmTheme
![sublime-snazzy](./images/themes/sublime-snazzy.png)
### TwoDark
https://raw.githubusercontent.com/erremauro/TwoDark/8e0f6fa5b59d196658a22288f519fd8320de4c87/TwoDark.tmTheme
![twodark](./images/themes/twodark.png)
### Visual Studio Dark+
https://raw.githubusercontent.com/vidann1/visual-studio-dark-plus/01ee1e8e0dc578f3b4e8c0dbb6aa0279b4a26a40/Visual%20Studio%20Dark%2B.tmTheme
![visual-studio-dark-plus](./images/themes/visual-studio-dark-plus.png)
### Zenburn
https://raw.githubusercontent.com/colinta/zenburn/86d4ee7a1f884851a1d21d66249687f527fced32/zenburn.tmTheme
![zenburn](./images/themes/zenburn.png)
+250
View File
@@ -0,0 +1,250 @@
# Todo System
Loki's Todo System is a built-in task tracking feature designed to improve the reliability and effectiveness of LLM agents,
especially smaller models. It provides structured task management that helps models:
- Break complex tasks into manageable steps
- Track progress through multistep workflows
- Automatically continue work until all tasks are complete
- Avoid forgetting steps or losing context
![Todo System Example](./images/agents/todo-system.png)
## Quick Links
<!--toc:start-->
- [Why Use the Todo System?](#why-use-the-todo-system)
- [How It Works](#how-it-works)
- [Configuration Options](#configuration-options)
- [Available Tools](#available-tools)
- [Auto-Continuation](#auto-continuation)
- [Best Practices](#best-practices)
- [Example Workflow](#example-workflow)
- [Troubleshooting](#troubleshooting)
<!--toc:end-->
## Why Use the Todo System?
Smaller language models often struggle with:
- **Context drift**: Forgetting earlier steps in a multi-step task
- **Incomplete execution**: Stopping before all work is done
- **Lack of structure**: Jumping between tasks without clear organization
The Loki Todo System addresses these issues by giving the model explicit tools to plan, track, and verify task completion.
The system automatically prompts the model to continue when incomplete tasks remain, ensuring work gets finished.
## How It Works
1. **Planning Phase**: The model initializes a todo list with a goal and adds individual tasks
2. **Execution Phase**: The model works through tasks, marking each done immediately after completion
3. **Continuation Phase**: If incomplete tasks remain, the system automatically prompts the model to continue
4. **Completion**: When all tasks are marked done, the workflow ends naturally
The todo state is preserved across the conversation (and any compressions), and injected into continuation prompts,
keeping the model focused on remaining work.
## Configuration Options
The Todo System is configured per-agent in `<loki-config-dir>/agents/<agent-name>/config.yaml`:
| Setting | Type | Default | Description |
|----------------------------|---------|-------------|---------------------------------------------------------------------------------|
| `auto_continue` | boolean | `false` | Enable the To-Do system for automatic continuation when incomplete todos remain |
| `max_auto_continues` | integer | `10` | Maximum number of automatic continuations before stopping |
| `inject_todo_instructions` | boolean | `true` | Inject the default todo tool usage instructions into the agent's system prompt |
| `continuation_prompt` | string | (see below) | Custom prompt used when auto-continuing |
### Example Configuration
```yaml
# agents/my-agent/config.yaml
model: openai:gpt-4o
auto_continue: true # Enable auto-continuation
max_auto_continues: 15 # Allow up to 15 automatic continuations
inject_todo_instructions: true # Include todo instructions in system prompt
continuation_prompt: | # Optional: customize the continuation prompt
[CONTINUE]
You have unfinished tasks. Proceed with the next pending item.
Do not explain; just execute.
```
### Default Continuation Prompt
If `continuation_prompt` is not specified, the following default is used:
```
[SYSTEM REMINDER - TODO CONTINUATION]
You have incomplete tasks in your todo list. Continue with the next pending item.
Call tools immediately. Do not explain what you will do.
```
## Available Tools
When `inject_todo_instructions` is enabled (the default), agents have access to four built-in todo management tools:
### `todo__init`
Initialize a new todo list with a goal. Clears any existing todos.
**Parameters:**
- `goal` (string, required): The overall goal to achieve when all todos are completed
**Example:**
```json
{"goal": "Refactor the authentication module"}
```
### `todo__add`
Add a new todo item to the list.
**Parameters:**
- `task` (string, required): Description of the todo task
**Example:**
```json
{"task": "Extract password validation into separate function"}
```
**Returns:** The assigned task ID
### `todo__done`
Mark a todo item as done by its ID.
**Parameters:**
- `id` (integer, required): The ID of the todo item to mark as done
**Example:**
```json
{"id": 1}
```
### `todo__list`
Display the current todo list with status of each item.
**Parameters:** None
**Returns:** The full todo list with goal, progress, and item statuses
### `todo__clear`
Clear the entire todo list and reset the goal. Use when the current task has been canceled or invalidated.
**Parameters:** None
**Returns:** Confirmation that the todo list was cleared
### REPL Command: `.clear todo`
You can also clear the todo list manually from the REPL by typing `.clear todo`. This is useful when:
- You gave a custom response that changes or cancels the current task
- The agent is stuck in auto-continuation with stale todos
- You want to start fresh without leaving and re-entering the agent
**Note:** This command is only available when an agent with `auto_continue: true` is active. If the todo
system isn't enabled for the current agent, the command will display an error message.
## Auto-Continuation
When `auto_continue` is enabled, Loki automatically sends a continuation prompt if:
1. The agent's response completes (model stops generating)
2. There are incomplete tasks in the todo list
3. The continuation count hasn't exceeded `max_auto_continues`
4. The response isn't identical to the previous continuation (prevents loops)
### What Gets Injected
Each continuation prompt includes:
- The continuation prompt text (default or custom)
- The current todo list state showing:
- The goal
- Progress (e.g., "3/5 completed")
- Each task with status (✓ done, ○ pending)
**Example continuation context:**
```
[SYSTEM REMINDER - TODO CONTINUATION]
You have incomplete tasks in your todo list. Continue with the next pending item.
Call tools immediately. Do not explain what you will do.
Goal: Refactor the authentication module
Progress: 2/4 completed
✓ 1. Extract password validation into separate function
✓ 2. Add unit tests for password validation
○ 3. Update login handler to use new validation
○ 4. Update registration handler to use new validation
```
### Visual Feedback
During auto-continuation, you'll see a message in your terminal:
```
📋 Auto-continuing (3/10): 2 incomplete todo(s) remain
```
## Best Practices
### For Agent Developers
1. **Enable for complex workflows**: Use `auto_continue: true` for agents that handle multistep tasks
2. **Set reasonable limits**: Adjust `max_auto_continues` based on typical task complexity
3. **Customize the prompt**: If your agent needs specific continuation behavior, set a custom `continuation_prompt`
### For Model Behavior
The injected instructions tell models to:
1. **Always create a todo list before starting work**: This ensures planning happens upfront
2. **Mark each task done immediately after finishing**: Don't batch completions
3. **Add all planned steps before starting**: Complete planning before execution
### When to Use vs. Skip
**Use the Todo System when:**
- Tasks have 3+ distinct steps
- The model might lose track of progress
- You want guaranteed completion of all steps
- Working with smaller/less capable models
**Skip the Todo System when:**
- Single-step, simple tasks
- Interactive Q&A sessions
- The overhead of task tracking isn't worth it
## Example Workflow
Here's how a typical todo-driven workflow looks:
**User prompt:** "Add input validation to the user registration form"
**Model actions:**
```
1. todo__init(goal="Add input validation to user registration form")
2. todo__add(task="Analyze current registration form fields")
3. todo__add(task="Create validation rules for email field")
4. todo__add(task="Create validation rules for password field")
5. todo__add(task="Implement client-side validation")
6. todo__add(task="Add server-side validation")
7. todo__add(task="Write tests for validation logic")
```
**Model executes first task, then:**
```
8. todo__done(id=1)
9. [Proceeds with task 2...]
10. todo__done(id=2)
...
```
**If model stops with incomplete tasks:**
- System automatically sends continuation prompt
- Model sees remaining tasks and continues
- Repeats until all tasks are done or max continuations reached
## Troubleshooting
### Model Not Using Todo Tools
- Verify `inject_todo_instructions: true` in your agent config
- Check that the agent is properly loaded (not just a role)
- Some models may need explicit prompting to use the tools
### Too Many Continuations
- Lower `max_auto_continues` to a reasonable limit
- Check if the model is creating new tasks without completing old ones
- Ensure tasks are appropriately scoped (not too granular)
### Continuation Loop
The system detects when a model's response is identical to its previous continuation response and stops
automatically. If you're seeing loops:
- The model may be stuck; check if a task is impossible to complete
- Consider adjusting the `continuation_prompt` to be more directive
---
## Additional Docs
- [Agents](./AGENTS.md) - Full agent configuration guide
- [Function Calling](./function-calling/TOOLS.md) - How tools work in Loki
- [Sessions](./SESSIONS.md) - How conversation state is managed
+161
View File
@@ -0,0 +1,161 @@
# The Loki Vault
The Loki vault lets users store sensitive secrets and credentials securely so that there's no plaintext secrets
anywhere in your configurations.
It's based on the [G-Man library](https://github.com/Dark-Alex-17/gman) (which also comes in a binary format) which
functions as a universal secret management tool.
![Vault Demo](./images/vault/vault-demo.gif)
## Quick Links
<!--toc:start-->
- [Usage](#usage)
- [CLI Usage](#cli-usage)
- [REPL Usage](#repl-usage)
- [Motivation](#motivation)
- [How it works](#how-it-works)
- [Supported Files](#supported-files)
- [Environment Variable Secret Injection in Agents](#environment-variable-secret-injection-in-agents)
<!--toc:end-->
---
## Usage
The Loki vault can be used in one of two ways: via the CLI or via the REPL for interactive usage.
### CLI Usage
The vault is utilized from the CLI with the following flags:
```bash
--add-secret <SECRET_NAME> Add a secret to the Loki vault
--get-secret <SECRET_NAME> Decrypt a secret from the Loki vault and print the plaintext
--update-secret <SECRET_NAME> Update an existing secret in the Loki vault
--delete-secret <SECRET_NAME> Delete a secret from the Loki vault
--list-secrets List all secrets stored in the Loki vault
```
(The above is also documented in `loki --help`)
Loki will guide you through manipulating your secrets to make usage easier.
### REPL Usage
The vault can be access from within the Loki REPL using the `.vault` commands:
![Loki Vault REPL](./images/vault/vault-repl.png)
![Loki Vault REPL Commands](./images/vault/vault-repl-commands.png)
The manipulation of your vault is guided in the same way as the CLI usage, ensuring ease of use.
## Motivation
Loki is intended to be highly configurable and adaptable to many different use cases. This means that users of Loki
should be able to share configurations for agents, tools, roles, etc. with other users or even entire teams.
My objective is to encourage this, and to make it so that users can easily version their configurations using version
control. Good VCS hygiene dictates that one *never* commits secrets or sensitive information to a repository.
Since a number of files and configurations in Loki may contain sensitive information, the vault exists to solve this problem.
Users can either share the vault password with a team, making it so a single configuration can be pulled from VCS and used
by said team. Alternatively, each user can maintain their own vault password and expect other users to replace secret values
with their user-specific secrets.
## How it works
When you first start Loki, if you don't already have a vault password file, it will prompt you to create one. This file
houses the password that is used to encrypt and decrypt secrets within Loki. This file exists so that you are not prompted
for a password every time Loki attempts to decrypt a secret.
When you encrypt a secret, it uses the local provider for `gman` to securely store those secrets in the Loki vault file.
This file is typically located at your Loki configuration directory under `vault.yml`. If you open this file, you'll see a
bunch of gibberish. This is because all secrets are encrypted using the password you provided, meaning only you can decrypt them.
Secrets are specified in Loki configurations using the same variable templating as the [Jinja templating engine](https://jinja.palletsprojects.com/en/stable/):
```
{{some_variable}}
```
So whenever you want Loki to use a secret from the vault, you simply specify the secret name in this format in the applicable
file.
**Example:**
Suppose my vault has a secret called `GITHUB_TOKEN` in it, and I want to use that in the MCP configuration. Then, I simply replace
the expected value in my `mcp.json` with the templated secret:
```json
{
"mcpServers": {
"atlassian": {
"command": "npx",
"args": ["-y", "mcp-remote", "https://mcp.atlassian.com/v1/sse"]
},
"github": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"-e",
"GITHUB_PERSONAL_ACCESS_TOKEN",
"ghcr.io/github/github-mcp-server"
],
"env": {
"GITHUB_PERSONAL_ACCESS_TOKEN": "{{GITHUB_TOKEN}}"
}
}
}
}
```
At runtime, Loki will detect the templated secret and replace it with the decrypted value from the vault before executing.
## Supported Files
At the time of writing, the following files support Loki secret injection:
| File Type | Description | Limitations |
|-------------------------|-----------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------|
| `config.yaml` | The main Loki configuration file | Cannot use secret injection on the `vault_password_file` field |
| `functions/mcp.json` | The MCP server configuration file | |
| `<agent>/tools.<py/sh>` | Tool files for agents | Specific configuration and only supported for Agents, not all global tools ([see below](#environment-variable-secret-injection-in-agents)) |
Note that all paths are relative to the Loki configuration directory. The directory varies by system, so you can find yours by
running
```shell
loki --info | grep config_dir | awk '{print $2}'
```
## Environment Variable Secret Injection in Agents
Secrets from the Loki vault can be injected into agent `tools.sh/tools.py` as environment variables. This is done as
follows:
1. Ensure a secret named `MY_USERNAME` is in your Loki vault.
2. Set the name of the secret as the default value for a variable
`<agent>/config.yaml`
```yaml
name: Username
description: An AI agent that demonstrates agent capabilities
instructions: |
You are a AI agent designed to demonstrate agent capabilities.
variables:
- name: username
description: Your user name
# Configure the secret you want to inject using the same templating mentioned above; i.e. wrap the
# case-sensitive name in '{{}}'
default: '{{MY_USERNAME}}'
```
3. Reference the variable in your `<agent>/tools.<py/sh>` file using the familiar variable injection name; that is,
since the name of the variable is `username`, the environment variable that will be provided to the tool call will
be named `LLM_AGENT_VAR_USERNAME`
`tools.sh`
```bash
#!/usr/bin/env bash
# @env LLM_OUTPUT=/dev/stdout The output path
# @cmd Get my username
get_my_username() {
echo "$LLM_AGENT_VAR_USERNAME" >> "$LLM_OUTPUT"
}
```
For more information about variable usage within agents, refer to the [Variables section](./AGENTS.md#user-defined-variables) of the [Agents README](./AGENTS.md)
+185
View File
@@ -0,0 +1,185 @@
# Model Clients
Loki supports a large number of model providers (referred to as `clients` since Loki is a client of these providers). In
order to use them, you must configure each one in the `clients` array in the global Loki configuration file.
The location of the global Loki configuration file varies between systems, so you can use the following command to
locate your configuration file:
```shell
loki --info | grep 'config_file' | awk '{print $2}'
```
## Quick Links
<!--toc:start-->
- [Supported Clients](#supported-clients)
- [Client Configuration](#client-configuration)
- [Authentication](#authentication)
- [Extra Settings](#extra-settings)
<!--toc:end-->
---
## Supported Clients
Loki supports the following model client types:
* Azure AI Foundry
* AWS Bedrock
* Anthropic Claude
* Cohere
* Google Gemini
* OpenAI
* OpenAI-Compatible
* GCP Vertex AI
In addition to the settings detailed below, each client may have additional settings specific to the provider. Check the
[example global configuration file](../../config.example.yaml) to verify that your client has all the necessary fields
defined.
## Client Configuration
Each client in Loki has the same configuration settings available to them, with only special authentication fields added
for specific clients as necessary. They are each placed under the `clients` array in your global configuration file:
```yaml
clients:
- name: client1
# ... client configuration ...
- name: client2
# ... client configuration ...
```
### Metadata
The client metadata uniquely identifies the client in Loki so you can reference it across your configurations. The
available settings are listed below:
| Setting | Description |
|----------|------------------------------------------------------------------------------------------------------------|
| `name` | The name of the client (e.g. `openai`, `gemini`, etc.) |
| `auth` | Authentication method: `oauth` for OAuth, or omit to use `api_key` (see [Authentication](#authentication)) |
| `models` | See the [model settings](#model-settings) documentation below |
| `patch` | See the [client patch configuration](./PATCHES.md#client-configuration-patches) documentation |
| `extra` | See the [extra settings](#extra-settings) documentation below |
Be sure to also check provider-specific configurations for any extra fields that are added for authentication purposes.
### Model Settings
The `models` array lists the available models from the model client. Each one has the following settings:
| Setting | Required | Model Type | Description |
|-----------------------------|----------|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `name` | * | `all` | The name of the model |
| `real_name` | | `all` | You can define model aliases via the `name` field. However, Loki still needs to know the real name <br>of the model so it can query it. For example: If you have `name: gpt-alias`, then you must <br>also define `real_name: gpt-oss:latest` |
| `type` | * | `all` | The type of model. Loki supports only 3 types of models: <ul><li>`chat`</li><li>`embedding`</li><li>`reranker`</li></ul> |
| `input_price` | | `all` | The cost in USD per 1M tokens for each input sequence; Loki will keep track of usage costs if this is defined |
| `output_price` | | `all` | The cost in USD per 1M tokens of the model output; Loki will keep track of usage costs if this is defined |
| `patch` | | `all` | See the [model-specific patch configuration](./PATCHES.md#model-specific-patches) documentation |
| `max_input_tokens` | | `all` | The maximum number of input tokens for the model |
| `max_output_tokens` | | `chat` | The maximum number of output tokens for the model |
| `require_max_tokens` | | `chat` | Whether to enforce the `max_output_tokens` constraint. |
| `supports_vision` | | `chat` | Indicates if the model supports multimodal queries that would require vision (i.e. image recognition) |
| `supports_function_calling` | | `chat` | Indicates if the model supports function calling |
| `no_stream` | | `chat` | Enable or disable streaming API responses |
| `no_system_message` | | `chat` | Controls whether the model supports system messages |
| `system_prompt_prefix` | | `chat` | An additional prefix prompt to add to all system prompts to ensure consistent behavior across all interactions |
| `max_tokens_per_chunk` | | `embedding` | The maximum chunk size supported by the embedding model |
| `default_chunk_size` | | `embedding` | The default chunk size to use with the given model |
| `max_batch_size` | | `embedding` | The maximum batch size that the given embedding model supports |
## Authentication
Loki clients support two authentication methods: **API keys** and **OAuth**. Each client entry in your configuration
must use one or the other.
### API Key Authentication
Most clients authenticate using an API key. Simply set the `api_key` field directly or inject it from the
[Loki vault](../VAULT.md):
```yaml
clients:
- type: claude
api_key: '{{ANTHROPIC_API_KEY}}'
```
API keys can also be provided via environment variables named `{CLIENT_NAME}_API_KEY` (e.g. `OPENAI_API_KEY`,
`GEMINI_API_KEY`). See the [environment variables documentation](../ENVIRONMENT-VARIABLES.md#client-related-variables)
for details.
### OAuth Authentication
For [providers that support OAuth](#providers-that-support-oauth), you can authenticate using your existing subscription instead of an API key. This uses
the OAuth 2.0 PKCE flow.
**Step 1: Configure the client**
Add a client entry with `auth: oauth` and no `api_key`:
```yaml
clients:
- type: claude
name: my-claude-oauth
auth: oauth
```
**Step 2: Authenticate**
Run the `--authenticate` flag with the client name:
```sh
loki --authenticate my-claude-oauth
```
Or if you have only one OAuth-configured client, you can omit the name:
```sh
loki --authenticate
```
Alternatively, you can use the REPL command `.authenticate`.
This opens your browser for the OAuth authorization flow. Depending on the provider, Loki will either start a
temporary localhost server to capture the callback automatically (e.g. Gemini) or ask you to paste the authorization
code back into the terminal (e.g. Claude). Loki stores the tokens in `~/.cache/loki/oauth` and automatically refreshes
them when they expire.
#### Gemini OAuth Note
Loki uses the following scopes for OAuth with Gemini:
* https://www.googleapis.com/auth/generative-language.peruserquota
* https://www.googleapis.com/auth/userinfo.email
* https://www.googleapis.com/auth/generative-language.retriever (Sensitive)
Since the `generative-language.retriever` scope is a sensitive scope, Google needs to verify Loki, which requires full
branding (logo, official website, privacy policy, terms of service, etc.). The Loki app is open-source and is designed
to be used as a simple CLI. As such, there's no terms of service or privacy policy associated with it, and thus Google
cannot verify Loki.
So, when you kick off OAuth with Gemini, you may see a page similar to the following:
![](../images/clients/gemini-oauth-page.png)
Simply click the `Advanced` link and click `Go to Loki (unsafe)` to continue the OAuth flow.
![](../images/clients/gemini-oauth-unverified.png)
![](../images/clients/gemini-oauth-unverified-allow.png)
**Step 3: Use normally**
Once authenticated, the client works like any other. Loki uses the stored OAuth tokens automatically:
```sh
loki -m my-claude-oauth:claude-sonnet-4-20250514 "Hello!"
```
> **Note:** You can have multiple clients for the same provider. For example: you can have one with an API key and
> another with OAuth. Use the `name` field to distinguish them.
### Providers That Support OAuth
* Claude
* Gemini
## Extra Settings
Loki also lets you customize some extra settings for interacting with APIs:
| Setting | Description |
|-------------------|-------------------------------------------------------|
| `proxy` | Set a proxy to use |
| `connect_timeout` | Set the timeout in seconds for connections to the API |
+368
View File
@@ -0,0 +1,368 @@
# Request Patching in Loki
Loki provides two mechanisms for modifying API requests sent to LLM providers: **Model-Specific Patches** and
**Client Configuration Patches**. These allow you to customize request parameters, headers, and URLs to work around
provider quirks or add custom behavior.
## Quick Links
- [Model-Specific Patches](#model-specific-patches)
- [Client Configuration Patches](#client-configuration-patches)
- [Comparison](#comparison)
- [Common Use Cases](#common-use-cases)
- [Environment Variable Patches](#environment-variable-patches)
- [Tips](#tips)
- [Debugging Patches](#debugging-patches)
---
## Model-Specific Patches
### Overview
Model-specific patches are applied **unconditionally** to a single model. They are useful for handling model-specific
quirks or requirements.
### When to Use
- A specific model requires certain parameters to be set or removed
- A model needs different default values than other models from the same provider
- You need to add special configuration for one model only
### Structure
```yaml
models:
- name: model-name
type: chat
# ... other model properties ...
patch:
url: "https://custom-endpoint.com" # Optional: override the API endpoint
body: # Optional: modify request body
<parameter>: <value> # Add or modify parameters
<parameter>: null # Remove parameters (set to null)
headers: # Optional: modify request headers
<header-name>: <value> # Add or modify headers
<header-name>: null # Remove headers (set to null)
```
### Examples
#### Example 1: Removing Parameters
OpenAI's o1 models don't support `temperature`, `top_p`, or `max_tokens` parameters. The `patch` removes them:
```yaml
- name: o4-mini
type: chat
max_input_tokens: 200000
max_output_tokens: 100000
supports_function_calling: true
patch:
body:
max_tokens: null # Remove max_tokens from request
temperature: null # Remove temperature from request
top_p: null # Remove top_p from request
```
#### Example 2: Setting Required Parameters
Some models require specific parameters to be set:
```yaml
- name: o4-mini-high
type: chat
patch:
body:
reasoning_effort: high # Always set reasoning_effort to "high"
max_tokens: null
temperature: null
```
#### Example 3: Custom Endpoint
If a model needs a different API endpoint:
```yaml
- name: custom-model
type: chat
patch:
url: "https://special-endpoint.example.com/v1/chat"
```
#### Example 4: Adding Headers
Add authentication or custom headers:
```yaml
- name: special-model
type: chat
patch:
headers:
X-Custom-Header: "special-value"
X-API-Version: "2024-01"
```
### How It Works
1. When you use a model, Loki loads its configuration
2. If the model has a `patch` field, it's **always applied** to every request
3. The patch modifies the request URL, body, or headers before sending to the API
4. Parameters set to `null` are **removed** from the request
---
## Client Configuration Patches
### Overview
Client configuration patches allow you to apply customizations to **multiple models** based on
**regex pattern matching**. They're defined in your `config.yaml` file and can target specific API types (`chat`,
`embeddings`, or `rerank`).
### When to Use
- You want to apply the same settings to multiple models from a provider
- You need different configurations for different groups of models
- You want to override the default client model settings
- You need environment-specific customizations
### Structure
```yaml
clients:
- type: <client> # e.g., gemini, openai, claude
# ... client configuration ...
patch:
chat_completions: # For chat models
'<regex-pattern>': # Regex to match model names
url: "..." # Optional: override endpoint
body: # Optional: modify request body
<parameter>: <value>
headers: # Optional: modify headers
<header>: <value>
embeddings: # For embedding models
'<regex-pattern>':
# ... same structure ...
rerank: # For reranker models
'<regex-pattern>':
# ... same structure ...
```
### Pattern Matching
- Patterns are **regular expressions** that match against the model name
- Use `.*` to match all models
- Use specific patterns like `gpt-4.*` to match model families
- Use `model1|model2` to match multiple specific models
### Examples
#### Example 1: Disable Safety Filters for Gemini Models
Apply to all Gemini chat models:
```yaml
clients:
- type: gemini
api_key: "{{GEMINI_API_KEY}}"
patch:
chat_completions:
'.*': # Matches all Gemini models
body:
safetySettings:
- category: HARM_CATEGORY_HARASSMENT
threshold: BLOCK_NONE
- category: HARM_CATEGORY_HATE_SPEECH
threshold: BLOCK_NONE
- category: HARM_CATEGORY_SEXUALLY_EXPLICIT
threshold: BLOCK_NONE
- category: HARM_CATEGORY_DANGEROUS_CONTENT
threshold: BLOCK_NONE
```
#### Example 2: Apply Settings to Specific Model Family
Only apply to GPT-4 models (not GPT-3.5):
```yaml
clients:
- type: openai
api_key: "{{OPENAI_API_KEY}}"
patch:
chat_completions:
'gpt-4.*': # Matches gpt-4, gpt-4-turbo, gpt-4o, etc.
body:
frequency_penalty: 0.2
presence_penalty: 0.1
```
#### Example 3: Different Settings for Different Models
Apply different patches based on model name:
```yaml
clients:
- type: openai
api_key: "{{OPENAI_API_KEY}}"
patch:
chat_completions:
'gpt-4o': # Specific model
body:
temperature: 0.7
'gpt-3.5.*': # Model family
body:
temperature: 0.9
max_tokens: 2000
```
#### Example 4: Modify Embedding Requests
Apply to embedding models:
```yaml
clients:
- type: openai
api_key: "{{OPENAI_API_KEY}}"
patch:
embeddings:
'text-embedding-.*': # All text-embedding models
body:
dimensions: 1536
encoding_format: "float"
```
#### Example 5: Custom Headers for Specific Models
Add headers only for certain models:
```yaml
clients:
- type: openai-compatible
api_base: "https://api.example.com/v1"
patch:
chat_completions:
'custom-model-.*':
headers:
X-Custom-Auth: "bearer-token"
X-Model-Version: "latest"
```
#### Example 6: Override Endpoint for Specific Models
Use different endpoints for different model groups:
```yaml
clients:
- type: openai-compatible
api_base: "https://default-endpoint.com/v1"
patch:
chat_completions:
'premium-.*': # Premium models use different endpoint
url: "https://premium-endpoint.com/v1/chat/completions"
```
### How It Works
1. When making a request, Loki checks if the client has a `patch` configuration
2. It looks at the appropriate API type (`chat_completions`, `embeddings`, or `rerank`)
3. For each pattern in that section, it checks if the regex matches the model name
4. If a match is found, that patch is applied to the request
5. Only the **first matching pattern** is applied (patterns are processed in order)
---
## Comparison
| Feature | Model-Specific Patch | Client Configuration Patch |
|-----------------------|-----------------------|-------------------------------------|
| **Scope** | Single model only | Multiple models via regex |
| **Matching** | Exact model name | Regular expression pattern |
| **Application** | Always applied | Only if pattern matches |
| **API Type** | All APIs | Separate for chat/embeddings/rerank |
| **Override** | Cannot be overridden | Can override model patch |
| **Use Case** | Model-specific quirks | User preferences & customization |
| **Application Order** | Applied first | Applied second (can override) |
### Patch Application Order
When both patches are present, they're applied in this order:
1. **Model-Specific Patch**
2. **Client Configuration Patch**
This means client configuration patches can override model-specific patches if they modify the same parameters.
## Common Use Cases
### Removing Unsupported Parameters
Some models don't support standard parameters like `temperature` or `max_tokens`:
**Model Patch**:
```yaml
patch:
body:
temperature: null
max_tokens: null
```
### Adding Provider-Specific Parameters
Providers often have unique parameters:
**Client Patch**:
```yaml
patch:
chat_completions:
'.*':
body:
safetySettings: [...] # Gemini
thinking_budget: 10000 # DeepSeek
response_format: # OpenAI
type: json_object
```
### Changing Endpoints
Use custom or regional endpoints:
**Client Patch**:
```yaml
patch:
chat_completions:
'.*':
url: "https://eu-endpoint.example.com/v1/chat"
```
### Setting Default Values
Provide defaults for specific models or model families:
**Client Patch**:
```yaml
patch:
chat_completions:
'claude-3-.*':
body:
max_tokens: 4096
temperature: 0.7
```
### Custom Authentication
Add special authentication headers:
**Client Patch**:
```yaml
patch:
chat_completions:
'.*':
headers:
Authorization: "Bearer {{custom_token}}"
X-Organization-ID: "org-123"
```
## Environment Variable Patches
You can also apply patches via environment variables for temporary overrides:
```bash
export LLM_PATCH_OPENAI_CHAT_COMPLETIONS='{"gpt-4.*":{"body":{"temperature":0.5}}}'
```
This takes precedence over client configuration patches but not model-specific patches.
## Tips
1. **Use model patches** for permanent, model-specific requirements
2. **Use client patches** for personal preferences or environment-specific settings
3. **Test regex patterns** carefully
4. **Set to `null`** to remove parameters, don't just omit them
5. **Check each model provider's docs** for available parameters and their formats
6. **Be specific** with patterns to avoid unintended matches
7. **Remember order matters** - first matching pattern wins for client patches
8. **Patches merge** - both types can be applied, with client patches overriding model patches
## Debugging Patches
To see what request is actually being sent, enable debug logging:
```bash
export RUST_LOG=loki=debug
loki "your prompt here"
```
This will show the final request body after all patches are applied.
@@ -0,0 +1,279 @@
# Bash Prompt Helpers
When creating bash based tools, it's often helpful to prompt the user for input or confirmation.
Loki comes pre-packaged with a handful of prompt helpers for your bash-based tools. These helpers
can be used to prompt the user for various types of input, such as yes/no confirmations,
text input, and selections from a list.
The utility script is located at `functions/utils/prompt-utils.sh` within your Loki `functions` directory.
The Loki `functions` directory varies between machines, so you can find its location on your system by running the following command in your terminal:
```shell
loki --info | grep functions_dir | awk '{print $2}'
```
## Quick Links
<!--toc:start-->
- [Import The Prompt Utils Into Your Tools Script](#import-the-prompt-utils-into-your-tools-script)
- [Included Utility Functions](#included-utility-functions)
- [input](#input)
- [confirm](#confirm)
- [list](#list)
- [checkbox](#checkbox)
- [password](#password)
- [editor](#editor)
- [with_validate](#with_validate)
- [validate_present](#validate_present)
- [detect_os](#detect_os)
- [get_opener](#get_opener)
- [open_link](#open_link)
- [guard_operation](#guard_operation)
- [guard_path](#guard_path)
- [patch_file](#patch_file)
- [error](#error)
- [warn](#warn)
- [info](#info)
- [debug](#debug)
- [trace](#trace)
- [Colored Output](#colored-output)
<!--toc:end-->
---
## Import The Prompt Utils Into Your Tools Script
In order to use the bash prompt helpers in your bash scripts, you need to source the provided `prompt-utils.sh` script.
This script is pre-packaged with Loki and is located [here](../../assets/functions/utils/prompt-utils.sh).
When sourcing the file in your bash script, you use the `LLM_PROMPT_UTILS_FILE` environment variable that automatically
populates the `functions/utils/prompt-utils.sh` path for you.
Thus, to properly source and enable all the bash prompt helpers in your Bash tools, add the following prelude to your
scripts:
```bash
source "$LLM_PROMPT_UTILS_FILE"
```
## Included Utility Functions
Below are the built-in bash prompt helpers that can be used to enhance user interaction with your tool scripts.
### input
Prompt for text input
![Prompt Utils Input](../images/tools/prompt-utils-input.png)
**Example With Validation:**
```bash
text=$(with_validation 'input "Please enter something:"' validate_present 2>/dev/tty)
```
**Example Without Validation:**
```bash
text=$(input "Please enter something:" 2>/dev/tty)
```
### confirm
Show a confirm dialog with options for yes/no
![Prompt Utils Confirm](../images/tools/prompt-utils-confirm.png)
**Example:**
```bash
confirmed=$(confirm "Do the thing?" 2>/dev/tty)
if [[ $confirmed == "0" ]]; then echo "No"; else echo "Yes"; fi
```
### list
Renders a text based list of options that can be selected by the user using up, down, and enter
keys that then returns the chosen option.
![Prompt Utils List](../images/tools/prompt-utils-list.png)
**Example:**
```bash
options=("one" "two" "three" "four")
choice=$(list "Select an item" "${options[@]}" 2>/dev/tty)
echo "Your choice: ${options[$choice]}"
```
### checkbox
Render a text based list of options, where multiple options can be selected by the user using down, up,
and enter keys that then returns the chosen options.
![Prompt Utils Checkbox](../images/tools/prompt-utils-checkbox.png)
**Example:**
```bash
options=("one" "two" "three" "four")
checked=$(checkbox "Select one or more items" "${options[@]}" 2>/dev/tty)
echo "Your choices: ${checked}"
```
### password
Show a password prompt displaying stars for each character typed.
![Prompt Utils Password](../images/tools/prompt-utils-password.png)
**Example With Validation:**
```bash
validate_password() {
if [[ ${#1} -lt 10 ]]; then
echo "Password must be at least 10 characters"
exit 1
fi
}
pass=$(with_validate 'password "Enter your password"' validate_password 2>/dev/tty)
```
**Example Without Validation:**
```bash
pass="$(password "Enter your password:" 2>/dev/tty)"
```
### editor
Open the default editor (`$EDITOR`); if none is set, default back to `vi`
**Example:**
```bash
text=$(editor "Please enter something in the editor" 2>/dev/tty)
echo -e "You wrote:\n${text}"
```
### with_validate
Evaluate the given prompt command with validation. This prompts the user for input until the
validation functions returns 0.
![Prompt Utils With-validate](../images/tools/prompt-utils-with-validate.png)
**Example:**
```bash
# Using the built-in 'validate_present' validator
text=$(with_validate 'input "Please enter something and confirm with enter"' validate_present 2>/dev/tty)
# Using a custom validator; e.g. for password
validate_password() {
if [[ ${#1} -lt 10 ]]; then
echo "Password needs to be at least 10 characters"
exit 1
fi
}
pass=$(with_validate 'password "Enter random password"' validate_password 2>/dev/tty)
```
### validate_present
Validate that the prompt returned a value.
![Prompt Utils Validate-Present](../images/tools/prompt-utils-validate-present.png)
**Example:**
```bash
text=$(with_validate 'input "Please enter something and confirm with enter"' validate_present 2>/dev/tty)
```
### detect_os
Detect the current OS.
Returns one of the following:
* `solaris`
* `macos`
* `linux`
* `bsd`
* `windows`
* `unknown`
**Example:**
```bash
detect_os
```
### get_opener
Determines the Os-specific file opening command (i.e. the command to open anything)
**Example:**
```bash
# Returns 'xdg-open'
get_opener
```
### open_link
Opens the given link in the default browser
**Example:**
```bash
open_link https://www.google.com
```
### guard_operation
Prompt for permission to run an operation.
Can be disabled by setting the environment variable `AUTO_CONFIRM`.
**Example:**
```bash
guard_operation "Execute SQL?"
_run_sql
```
### guard_path
Prompt for permission to perform path operations.
Can be disabled by setting the environment variable `AUTO_CONFIRM`.
**Example:***
```bash
guard_path "$target_path" "Remove '$target_path'?"
rm -rf "$target_path"
```
### patch_file
Patch a file and show a diff using the default diff viewer. Uses git diff syntax.
**Example:**
```bash
new_contents="$(patch_file "$path" file.patch)"
```
### error
Log an error
![Prompt Utils Error](../images/tools/prompt-utils-error.png)
### warn
Log a warning
![Prompt Utils Warning](../images/tools/prompt-utils-warning.png)
### info
Log info
![Prompt Utils Info](../images/tools/prompt-utils-info.png)
### debug
Log a debug message
![Prompt Utils Debug](../images/tools/prompt-utils-debug.png)
### trace
Log a trace message
![Prompt Utils Trace](../images/tools/prompt-utils-trace.png)
### Colored Output
The following commands allow users to output text in specific colors.
* `red`
* `green`
* `gold`
* `blue`
* `magenta`
* `cyan`
* `white`
**Example:**
```bash
red "This will be red"
yellow "This will be yellow"
```
+309
View File
@@ -0,0 +1,309 @@
# Custom Bash-Based Tools
Loki supports tools written in Bash. However, they must be written in a special format with special annotations in order
for Loki to be able to properly parse and utilize them. This formatting ensures that each Bash script is
self-describing, and formatted in such a way that Loki can anticipate how to execute it and what parameters to pass to
it. This standardization also lets Loki compile the script into a JSON schema that can be used to inform the LLM about
how to use the tool.
Each Bash-based tool must follow a specific structure in order for Loki to be able to properly compile and execute it:
* The tool must be a Bash script with a `.sh` file extension.
* The script must have the following comments:
* `# @describe ...` comment at the top that describes the tool.
* `# @env LLM_OUTPUT=/dev/stdout The output path` comment to describe the `LLM_OUTPUT` environment variable. This
syntax in particular assigns `/dev/stdout` as the default value for `LLM_OUTPUT`, so that if it's not set by Loki,
the script will still function properly.
* `# @option --option <value> An example option` comments to define each option that the tool accepts.
* Use `--flag` syntax for boolean flags.
* Use `--option <value>` syntax for options that accept a value.
* Use `--option <value1,value2>` syntax for options that accept multiple values (i.e. arrays).
* The script must have a `main` function
* The `main` function must redirect the return value to the `>> "$LLM_OUTPUT"` environment variable.
* This is necessary because Loki relies on the `$LLM_OUTPUT` environment variable to capture the output of the tool.
Essentially, you can think of the Bash-based tool script as just a normal Bash script that uses special comments to
define a CLI.
* The `# @env LLM_OUTPUT=/dev/stdout` comment to define the `$LLM_OUTPUT` environment variable (good practice)
* A `# @describe`
* And a `main` function that writes to `$LLM_OUTPUT`
The following section explains how you can add parameters to your bash functions and how to test out your scripts.
## Quick Links:
<!--toc:start-->
- [Loki Bash Tools Syntax](#loki-bash-tools-syntax)
- [Metadata](#metadata)
- [Environment Variables](#environment-variables)
- [Arguments](#arguments)
- [Flags](#flags)
- [Options](#options)
- [Subcommands (Agents only)](#subcommands-agents-only)
- [Execute and Test Your Bash Tools](#execute-and-test-your-bash-tools)
- [Example](#example)
- [Prompt Helpers](#prompt-helpers)
<!--toc:end-->
---
## Loki Bash Tools Syntax
Loki Bash tools work via `@___` annotations that describe specific functionality of a script. The following reference
explains the general syntax of these annotations and how to use them to create a CLI that Loki can recognize.
Refer to the [Execute and Test Your Bash Tools](#execute-and-test-your-bash-tools) section to learn how to test out your Bash tools
without needing to go through Loki itself.
It's important to note that any functions prefixed with `_` are not sent to the LLM, so they will be invisible to the
LLM at runtime.
### Metadata:
You can define different metadata about your script to help Loki understand its dependencies and purpose.
```bash
# Use the `@meta require-tools` annotation to specify any external tools that your script depends on.
# @meta require-tools jq,yq
# Use the `@describe` annotation to describe the purpose of the script.
# @describe A tool to interact with things
```
### Environment Variables:
```bash
###########################
## Environment Variables ##
###########################
# Use `@env` to define environment variables that the script uses.
# @env LLM_OUTPUT=/dev/stdout The output path, with a default value of '/dev/stdout' if not set.
# @env OPTIONAL An optional environment variable
# @env REQUIRED! A required environment variable
# @env DEFAULT_VALUE=default An environment variable with a default value if unset.
# @env DEFAULT_FROM_FN=`_default_env_fn` An environment variable with a default value calculated from a function if unset.
# @env CHOICE[even|odd] An environment variable that, if set, must be set to either `even` or `odd`
# @env CHOICE_WITH_DEFAULT[=even|odd] An environment variable that, if set, must be set to either `even` or `odd`, and defaults to `even` when unset
# @env CHOICE_FROM_FN[`_choice_env_fn`] An environment variable that, if set, must be set to one of the values returned by the `_choice_fn` function.
# Example variable usage:
export CHOICE=even
# ./script.sh
main() {
[[ $CHOICE == "even" ]] || { echo "The value of the 'CHOICE' env var is not 'even'" >> "$LLM_OUTPUT" && exit 1 }
}
# Loki does not pass functions prefixed with `_` to the LLM, so these are essentially `private` functions
_default_env_fn() {
echo "calculated default env value"
}
# Loki does not pass functions prefixed with `_` to the LLM, so these are essentially `private` functions
_choice_env_fn() {
echo even
echo odd
}
```
### Arguments:
When referencing an argument defined via the `@arg` annotation, you can access its value using the `argc_<argument_name>` variable that
is created at runtime.
```bash
###############
## Arguments ##
###############
# Use `@arg` To define positional arguments for your script.
# To reference an argument within your script, use the `argc_<argument_name>` variable.
# @arg optional Optional argument
# @arg required! Required argument
# @arg multi_value* An argument that accepts multiple values (e.g. './script.sh one two three')
# @arg multi_value_required+ An argument that is required and accepts multiple values
# @arg value_notated <VALUE> An argument that explicitly specifies the name for documentation (e.g. Usage: ./script.sh [VALUE])
# @arg default=default An argument with a default value if unset
# @arg default_from_fn=`_default_arg_fn` An argument with a default value calculated from a function if unset
# @arg choice[even|odd] An argument that, if set, must be set to either `even` or `odd`
# @arg required_choice+[even|odd] An required argument that must be set to either `even` or `odd`
# @arg default_choice[=even|odd] An argument that if unset defaults to 'even', but if set must be either `even` or `odd`
# @arg multi_value_choice*[even|odd] An argument that, if set, must be set to either `even` or `odd`, and accepts multiple values
# @arg choice_fn[`_choice_arg_fn`] An argument that, if set, must be set to one of the values returned by the `_choice_arg_fn` function.
# @arg choice_fn_no_valid[?`_choice_arg_fn`] An argument that, if set, can be set to one of the values returned by the `_choice_arg_fn` function,
# but does not validate the value.
# @arg multi_choice_fn*[`_choice_arg_fn`] An argument that, if set, must be set to one of the values returned by the `_choice_arg_fn` function,
# and accepts multiple values.
# @arg multi_choice_comma_fn*,[`_choice_arg_fn`] An argument that, if set, must be set to one of the values returned by the `_choice_arg_fn` function,
# and accepts multiple values in the form of a comma-separated list
# @arg capture_arg~ An argument that captures all remaining args passed to the script
# Example usage 1: ./script.sh something_required
main() {
[[ $argc_required == "something_required" ]] || { echo "The value of the 'required' arg is not 'something_required'" >> "$LLM_OUTPUT" && exit 1 }
}
# Example usage 2: ./script.sh this is a test
main() {
[[ "${argc_multi_value[*]}" == "this is a test" ]] || { echo "The value of the 'multi_value' arg is not 'this is a test'" >> "$LLM_OUTPUT" && exit 1 }
}
# Loki does not pass functions prefixed with `_` to the LLM, so these are essentially `private` functions
_default_arg_fn() {
echo "default arg value"
}
# Loki does not pass functions prefixed with `_` to the LLM, so these are essentially `private` functions
_choice_arg_fn() {
echo even
echo odd
}
```
### Flags:
To access the value of a flag defined via the `@flag` annotation, you can check the value of the `argc_<flag_name>` variable.
```bash
###########
## Flags ##
###########
# Use `@flag` to define boolean flags for your script
# To reference a flag within your script, use the `argc_<argument_name>` variable.
# @flag --bool A boolean flag with only a long option
# @flag -b --bool A boolean flag with a short and long option
# @flag -b A boolean flag with only a short option
# @flag --multi* A boolean flag that can be used multiple times (e.g. '--multi --multi' will return '2')
# Example usage 1: ./script.sh --bool
main() {
[[ $argc_bool == "1" ]] || { echo "The value of the 'bool' flag is not '1'" >> "$LLM_OUTPUT" && exit 1 }
}
# Example usage 2: ./script.sh --multi --multi
main() {
[[ $argc_multi == "2" ]] || { echo "The value of the 'multi' flag is not 2" >> "$LLM_OUTPUT" && exit 1 }
}
```
### Options:
To access the value of an option defined via the `@option` annotation, you can check the value of the `argc_<option_name>` variable.
```bash
#############
## Options ##
#############
# Use `@option` to define flags that accept values
# To reference an option within your script, use the `argc_<argument_name>` variable.
# @option --option An option that accepts a value with only a long flag
# @option -o --option An option that accepts a value with both a short and long flag
# @option -o An option that accepts a value with only a short flag
# @option --required A required option that accepts a value
# @option --multi* An option that accepts multiple values
# @option --required-multi+ An option that accepts multiple values and is required
# @option --multi-comma*, An option that accepts multiple values in the form of a comma-separated list
# @option --value <VALUE> An option that explicitly specifies the name for documentation (e.g. Usage: ./script.sh --value [VALUE])
# @option --two-args <SRC> <DEST> An option that accepts two arguments and explicitly names them for documentation
# (e.g. Usage: ./script.sh --two-args [SRC] [DEST])
# @option --unlimited-args <SRC> <DEST+> An option that accepts an unlimited number of arguments and explicitly names them for documentation
# (e.g. Usage: ./script.sh --unlimited-args [SRC] [DEST ...])
# @option --default=default An option that has a default value if unset
# @option --default-from-fn=`_default_opt_fn` An option that has a default value calculated from a function if unset
# @option --choice[even|odd] An option that, if set, must be set to either `even` or `odd`
# @option --choice-default[=even|odd] An option that, if unset, defaults to `even`, but if set must be either `even` or `odd`
# @option --choice-multi*[even|odd] An option that, if set, must be set to either `even` or `odd`, and can be specified multiple times
# (e.g. ./script.sh --choice-multi even --choice-multi odd)
# @option --required-choice-multi+[even|odd] A required option that, must be set to either `even` or `odd`, and can be specified multiple times
# @option --choice-fn[`_choice_opt_fn`] An option that, if set, must be set to one of the values returned by the `_choice_opt_fn` function.`
# @option --choice-fn-no-valid[?`_choice_opt_fn`] An option that, if set, can be set to one of the values returned by the `_choice_opt_fn` function, with no validation
# @option --choice-multi-fn*[`_choice_opt_fn`] An option that, if set, must be set to one of the values returned by the `_choice_opt_fn` function,
# and can be specified multiple times
# @option --choice-multi-comma*,[`_choice_opt_fn`] An option that, if set, must be set to one of the values returned by the `_choice_opt_fn` function,
# and is specified as a comma-separated list
# @option --capture~ An option that captures all remaining arguments passed to the script
# Example usage 1: ./script.sh --option some_value
main() {
[[ $argc_option == "some_value" ]] || { echo "The value of the 'option' option is not 'some_value'" >> "$LLM_OUTPUT" && exit 1 }
}
# Example usage 2: ./script.sh --multi value1 --multi value2
main() {
[[ "${argc_multi[*]}" == "value1 value2" ]] || { echo "The value of the 'multi' option is not 'value1 value2'" >> "$LLM_OUTPUT" && exit 1 }
}
# Loki does not pass functions prefixed with `_` to the LLM, so these are essentially `private` functions
_default_opt_fn() {
echo "calculated default option value"
}
# Loki does not pass functions prefixed with `_` to the LLM, so these are essentially `private` functions
_choice_opt_fn() {
echo even
echo odd
}
```
### Subcommands (Agents only):
By default, if no `@cmd` annotations are defined, the script's `main` function is treated as the default command.
However, for agents, there can be many functions defined in one file, and thus it is useful to create subcommands
to organize your agent's tools.
```bash
#################
## Subcommands ##
#################
# Use the `@cmd` annotation to define subcommands for your script.
# @cmd List all files
list() {
ls -la >> "$LLM_OUTPUT"
}
# @cmd Output the contents of the specified file
# @arg file! The file to output
cat() {
cat "$argc_file" >> "$LLM_OUTPUT"
}
# Example usage 1: ./script.sh cat myfile.txt
```
## Execute and Test Your Bash Tools
Your bash tools are just normal bash scripts stored in the `functions/tools` directory. So you can execute and test them
directly by first having Loki compile them so all this syntactic sugar means something.
This is achieved via the `loki --build-tools` command.
### Example
Suppose we want to execute the `functions/tools/get_current_time.sh` script for testing.
We'd first make sure the script is visible in all contexts by ensuring it's in the `visible_tools` array in your global
`config.yaml` file. This ensures Loki builds the tool so it's ready to use in any context.
You can find the location of your global `config.yaml` file with the following command:
```shell
loki --info | grep 'config_file' | awk '{print $2}'
```
Then, we can instruct Loki to build the script so we can test it out:
```shell
loki --build-tools
```
This will add additional boilerplate to the top of the script so that it can be executed directly.
Finally, we can now execute the script:
```bash
$ ./get_current_time.sh
Fri Oct 24 05:55:04 PM MDT 2025
```
## Prompt Helpers
It's often useful to create interactive prompts for our bash tools so that our tools can get input from
users.
To accommodate this, Loki provides a set of prompt helper functions that can be referenced and used within your Bash
tools.
For more information, refer to the [Bash Prompt Helpers documentation](BASH-PROMPT-HELPERS.md).
+282
View File
@@ -0,0 +1,282 @@
# Custom Tools
Loki is designed to be as flexible and as customizable as possible. One of the key
features that enables this flexibility is the ability to create and integrate custom tools
into your Loki setup. This document provides a guide on how to create and use custom tools within Loki.
## Quick Links
<!--toc:start-->
- [Supported Languages](#supported-languages)
- [Creating a Custom Tool](#creating-a-custom-tool)
- [Environment Variables](#environment-variables)
- [Custom Bash-Based Tools](#custom-bash-based-tools)
- [Custom Python-Based Tools](#custom-python-based-tools)
- [Custom TypeScript-Based Tools](#custom-typescript-based-tools)
- [Custom Runtime](#custom-runtime)
<!--toc:end-->
---
## Supported Languages
Loki supports custom tools written in the following programming languages:
* Python
* Bash
* TypeScript
## Creating a Custom Tool
All tools are created as scripts in either Python, Bash, or TypeScript. They should be placed in the `functions/tools` directory.
The location of the `functions` directory varies between systems, so you can use the following command to locate
your `functions` directory:
```shell
loki --info | grep functions_dir | awk '{print $2}'
```
Once you've created your custom tool, remember to add it to the `visible_tools` array in your global `config.yaml` file
to enable it globally. See the [Tools](TOOLS.md#enablingdisabling-global-tools) documentation for more information on how Loki utilizes the
`visible_tools` array.
### Environment Variables
All tools have access to the following environment variables that provide context about the current execution environment:
| Variable | Description |
|----------------------|--------------------------------------------------------------------------------------------------------------------------------------------|
| `LLM_OUTPUT` | Indicates where the output of the tool should go. <br>In certain situations, this may be set to a temporary file instead of `/dev/stdout`. |
| `LLM_ROOT_DIR` | The root `config_dir` directory for Loki <br>(i.e. `dirname $(loki --info \| grep config_file \| awk '{print $2}')`) |
| `LLM_TOOL_NAME` | The name of the tool being executed |
| `LLM_TOOL_CACHE_DIR` | A directory specific to the tool for storing cache or temporary files |
Loki also searches the tools directory on startup for a `.env` file. If found, all tools in `functions/tools/` will have
the environment variables defined in the `.env` file available to them.
### Custom Bash-Based Tools
To create a Bash-based tool, refer to the [custom bash tools documentation](CUSTOM-BASH-TOOLS.md).
### Custom Python-Based Tools
Loki supports tools written in Python.
Each Python-based tool must follow a specific structure in order for Loki to be able to properly compile and
execute it:
* The tool must be a Python script with a `.py` file extension.
* The tool must have a `def run` function that serves as the entry point for the tool.
* The `run` function must accept parameters that define the inputs for the tool.
* Always use type hints to specify the data type of each parameter.
* Use `Optional[...]` to indicate optional parameters
* The `run` function must return a `str`.
* For Python, this is automatically written to the `LLM_OUTPUT` environment variable, so there's no need to explicitly
write to the environment variable within the function.
* The function must also have a docstring that describes the tool and its parameters.
* Each parameter in the `run` function should be documented in the docstring using the `Args:` section. They should use the following format:
* `<parameter_name>: <description>` Where
* `<parameter_name>`: The name of the parameter
* `<description>`: The description of the parameter
* These are *very* important because these descriptions are what's passed to the LLM as the description of the tool,
letting the LLM know what the tool does and how to use it.
It's important to note that any functions prefixed with `_` are not sent to the LLM, so they will be invisible to the LLM
at runtime.
Below is the [`demo_py.py`](../../assets/functions/tools/demo_py.py) tool definition that comes pre-packaged with
Loki and demonstrates how to create a Python-based tool:
```python
import os
from typing import List, Literal, Optional
def run(
string: str,
string_enum: Literal["foo", "bar"],
boolean: bool,
integer: int,
number: float,
array: List[str],
string_optional: Optional[str] = None,
integer_with_default: int = 42,
boolean_with_default: bool = True,
number_with_default: float = 3.14,
string_with_default: str = "hello",
array_optional: Optional[List[str]] = None,
):
"""Demonstrates all supported Python parameter types and variations.
Args:
string: A required string property
string_enum: A required string property constrained to specific values
boolean: A required boolean property
integer: A required integer property
number: A required number (float) property
array: A required string array property
string_optional: An optional string property (Optional[str] with None default)
integer_with_default: An optional integer with a non-None default value
boolean_with_default: An optional boolean with a default value
number_with_default: An optional number with a default value
string_with_default: An optional string with a default value
array_optional: An optional string array property
"""
output = f"""string: {string}
string_enum: {string_enum}
boolean: {boolean}
integer: {integer}
number: {number}
array: {array}
string_optional: {string_optional}
integer_with_default: {integer_with_default}
boolean_with_default: {boolean_with_default}
number_with_default: {number_with_default}
string_with_default: {string_with_default}
array_optional: {array_optional}"""
for key, value in os.environ.items():
if key.startswith("LLM_"):
output = f"{output}\n{key}: {value}"
return output
```
### Custom TypeScript-Based Tools
Loki supports tools written in TypeScript. TypeScript tools require [Node.js](https://nodejs.org/) and
[tsx](https://tsx.is/) (`npx tsx` is used as the default runtime).
Each TypeScript-based tool must follow a specific structure in order for Loki to properly compile and execute it:
* The tool must be a TypeScript file with a `.ts` file extension.
* The tool must have an `export function run(...)` that serves as the entry point for the tool.
* Non-exported functions are ignored by the compiler and can be used as private helpers.
* The `run` function must accept flat parameters that define the inputs for the tool.
* Always use type annotations to specify the data type of each parameter.
* Use `param?: type` or `type | null` to indicate optional parameters.
* Use `param: type = value` for parameters with default values.
* The `run` function must return a `string` (or `Promise<string>` for async functions).
* For TypeScript, the return value is automatically written to the `LLM_OUTPUT` environment variable, so there's
no need to explicitly write to the environment variable within the function.
* The function must have a JSDoc comment that describes the tool and its parameters.
* Each parameter should be documented using `@param name - description` tags.
* These descriptions are passed to the LLM as the tool description, letting the LLM know what the tool does and
how to use it.
* Async functions (`export async function run(...)`) are fully supported and handled transparently.
**Supported Parameter Types:**
| TypeScript Type | JSON Schema | Notes |
|-------------------|--------------------------------------------------|-----------------------------|
| `string` | `{"type": "string"}` | Required string |
| `number` | `{"type": "number"}` | Required number |
| `boolean` | `{"type": "boolean"}` | Required boolean |
| `string[]` | `{"type": "array", "items": {"type": "string"}}` | Array (bracket syntax) |
| `Array<string>` | `{"type": "array", "items": {"type": "string"}}` | Array (generic syntax) |
| `"foo" \| "bar"` | `{"type": "string", "enum": ["foo", "bar"]}` | String enum (literal union) |
| `param?: string` | `{"type": "string"}` (not required) | Optional via question mark |
| `string \| null` | `{"type": "string"}` (not required) | Optional via null union |
| `param = "value"` | `{"type": "string"}` (not required) | Optional via default value |
**Unsupported Patterns (will produce a compile error):**
* Rest parameters (`...args: string[]`)
* Destructured object parameters (`{ a, b }: { a: string, b: string }`)
* Arrow functions (`const run = (x: string) => ...`)
* Function expressions (`const run = function(x: string) { ... }`)
Only `export function` declarations are recognized. Non-exported functions are invisible to the compiler.
Below is the [`demo_ts.ts`](../../assets/functions/tools/demo_ts.ts) tool definition that comes pre-packaged with
Loki and demonstrates how to create a TypeScript-based tool:
```typescript
/**
* Demonstrates all supported TypeScript parameter types and variations.
*
* @param string - A required string property
* @param string_enum - A required string property constrained to specific values
* @param boolean - A required boolean property
* @param number - A required number property
* @param array_bracket - A required string array using bracket syntax
* @param array_generic - A required string array using generic syntax
* @param string_optional - An optional string using the question mark syntax
* @param string_nullable - An optional string using the union-with-null syntax
* @param number_with_default - An optional number with a default value
* @param boolean_with_default - An optional boolean with a default value
* @param string_with_default - An optional string with a default value
* @param array_optional - An optional string array using the question mark syntax
*/
export function run(
string: string,
string_enum: "foo" | "bar",
boolean: boolean,
number: number,
array_bracket: string[],
array_generic: Array<string>,
string_optional?: string,
string_nullable: string | null = null,
number_with_default: number = 42,
boolean_with_default: boolean = true,
string_with_default: string = "hello",
array_optional?: string[],
): string {
const parts = [
`string: ${string}`,
`string_enum: ${string_enum}`,
`boolean: ${boolean}`,
`number: ${number}`,
`array_bracket: ${JSON.stringify(array_bracket)}`,
`array_generic: ${JSON.stringify(array_generic)}`,
`string_optional: ${string_optional}`,
`string_nullable: ${string_nullable}`,
`number_with_default: ${number_with_default}`,
`boolean_with_default: ${boolean_with_default}`,
`string_with_default: ${string_with_default}`,
`array_optional: ${JSON.stringify(array_optional)}`,
];
for (const [key, value] of Object.entries(process.env)) {
if (key.startsWith("LLM_")) {
parts.push(`${key}: ${value}`);
}
}
return parts.join("\n");
}
```
## Custom Runtime
By default, Loki uses the following runtimes to execute tools:
| Language | Default Runtime | Requirement |
|------------|-----------------|--------------------------------|
| Python | `python` | Python 3 on `$PATH` |
| TypeScript | `npx tsx` | Node.js + tsx (`npm i -g tsx`) |
| Bash | `bash` | Bash on `$PATH` |
You can override the runtime for Python and TypeScript tools using a **shebang line** (`#!`) at the top of your
script. Loki reads the first line of each tool file; if it starts with `#!`, the specified interpreter is used instead
of the default.
**Examples:**
```python
#!/usr/bin/env python3.11
# This Python tool will be executed with python3.11 instead of the default `python`
def run(name: str):
"""Greet someone.
Args:
name: The name to greet
"""
return f"Hello, {name}!"
```
```typescript
#!/usr/bin/env bun
// This TypeScript tool will be executed with Bun instead of the default `npx tsx`
/**
* Greet someone.
* @param name - The name to greet
*/
export function run(name: string): string {
return `Hello, ${name}!`;
}
```
This is useful for pinning a specific Python version, using an alternative TypeScript runtime like
[Bun](https://bun.sh/) or [Deno](https://deno.com/), or working with virtual environments.
+209
View File
@@ -0,0 +1,209 @@
# MCP Servers
[MCP servers](https://modelcontextprotocol.io/docs/getting-started/intro) are essentially APIs designed specifically for LLMs that work like a remote repository of
tools for the model to access and extend its capabilities.
So think of it like this: Instead of having to write all your own custom tools to interact with different
services, those services can expose their functionality through an MCP server.
Loki has first-class support for MCP servers.
As mentioned in the [Loki Vault documentation](../VAULT.md), Loki can inject sensitive
configuration data into your MCP configuration file to ensure that secrets are not hard-coded.
## Quick Links
<!--toc:start-->
- [Important Note](#important-note)
- [MCP Server Configuration](#mcp-server-configuration)
- [Secret Injection](#secret-injection)
- [Default MCP Servers](#default-mcp-servers)
- [Loki Configuration](#loki-configuration)
- [Global Configuration](#global-configuration)
- [Role Configuration](#role-configuration)
- [Agent Configuration](#agent-configuration)
<!--toc:end-->
---
## Important Note
Be careful how many MCP servers you enable at one time, regardless of the context. When there is a significant
number of configured MCP servers, enabling too many MCP servers may overwhelm the context length of a model,
and quickly exceed token limits.
## MCP Server Configuration
Loki stores the MCP server configuration file, `functions/mcp.json`, in the `functions` directory. You can find
this directory using the following command:
```shell
loki --info | grep functions_dir | awk '{print $2}'
```
The syntax for the `functions/mcp.json` file is compatible with MCP server configurations for Claude Desktop.
So any time you're looking to add a new server, look at the docs for it and find the configuration example for
Claude Desktop. You should be able to use the exact same configuration in your `functions/mcp.json` file.
Every server entry **must** include a `"type"` field set to one of: `"stdio"`, `"http"`, or `"sse"`.
### Transport Types
Loki supports three MCP transport types:
| Type | Use Case |
|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `stdio` | Spawns a local subprocess and communicates over stdin/stdout |
| `http` | Connects to a remote server via [Streamable HTTP](https://modelcontextprotocol.io/docs/concepts/transports#streamable-http) |
| `sse` | Connects to a remote server via the legacy [HTTP+SSE](https://modelcontextprotocol.io/docs/concepts/transports#http-with-sse) transport (Claude Desktop format) |
### Stdio Servers
Stdio is the standard transport for locally-installed MCP servers. Loki spawns the process and communicates
over stdin/stdout:
```json
{
"mcpServers": {
"github": {
"type": "stdio",
"command": "docker",
"args": ["run", "-i", "--rm", "ghcr.io/github/github-mcp-server"],
"env": {
"GITHUB_PERSONAL_ACCESS_TOKEN": "YOUR_GITHUB_TOKEN"
}
}
}
}
```
| Field | Required | Description |
|-----------|----------|------------------------------------------|
| `type` | yes | Must be `"stdio"` |
| `command` | yes | The executable to spawn |
| `args` | no | Arguments passed to the command |
| `env` | no | Environment variables for the subprocess |
| `cwd` | no | Working directory for the subprocess |
### HTTP (Streamable HTTP) Servers
For remote MCP servers that support the Streamable HTTP transport:
```json
{
"mcpServers": {
"datadog": {
"type": "http",
"url": "https://mcp.datadoghq.com/api/unstable/mcp-server/mcp"
}
}
}
```
| Field | Required | Description |
|-----------|----------|--------------------------------------------------------|
| `type` | yes | Must be `"http"` |
| `url` | yes | The server endpoint URL |
| `headers` | no | Custom HTTP headers to include with every request |
### SSE Servers
For remote MCP servers that use the legacy HTTP+SSE transport (the format used by Claude Desktop):
```json
{
"mcpServers": {
"my-sse-server": {
"type": "sse",
"url": "http://127.0.0.1:64342/sse",
"headers": {
"Authorization": "Bearer my-token"
}
}
}
}
```
| Field | Required | Description |
|-----------|----------|--------------------------------------------------------|
| `type` | yes | Must be `"sse"` |
| `url` | yes | The server SSE endpoint URL |
| `headers` | no | Custom HTTP headers to include with every request |
**Note:** Both `http` and `sse` types use the same underlying transport, which auto-negotiates the
protocol with the server. The `type` field primarily serves as documentation of which protocol the
server speaks. Neither type supports `command`, `args`, or `cwd` fields.
### Secret Injection
As mentioned in the [Loki Vault documentation](../VAULT.md), you can use Loki Vault to inject secrets into your MCP configuration file.
In fact, this is why you need to set up your vault before using Loki at all: the built-in MCP configuration
requires you set up some secrets to use it.
For more information about how to set up your vault and inject secrets, please refer to the [Loki Vault documentation](../VAULT.md).
## Default MCP Servers
Loki ships with a `functions/mcp.json` file that includes some useful MCP servers:
* [github](https://github.com/github/github-mcp-server) - Interact with GitHub repositories, issues, pull requests, and more.
* [docker](https://github.com/ckreiling/mcp-server-docker) - Manage your local Docker containers with natural language
* [slack](https://github.com/korotovsky/slack-mcp-server) - Interact with Slack
* [ddg-search](https://github.com/nickclyde/duckduckgo-mcp-server) - Perform web searches with the DuckDuckGo search engine
## Loki Configuration
MCP servers, like tools, can be used in a handful of contexts:
* Inside a session
* Inside a role
* Inside an agent
* Globally (i.e. outside a session, role, or agent)
Each of these has a different configuration and interaction with the global configuration.
***Note:** The names of each MCP server referenced in the below configuration properties directly corresponds
to the names given in the `functions/mcp.json` configuration file. So if you change the name of an MCP server
from `slack` to `lucem-slack`, then you need to also update your Loki configuration accordingly.
### Global Configuration
The global configuration is essentially what settings you want to have on by default when
you just invoke `loki`. (Don't worry about agents, roles, or sessions yet. We'll get to them in a bit).
The following settings are available in the global configuration for MCP servers:
```yaml
mcp_server_support: true # Enables or disables MCP server support (globally).
mapping_mcp_servers: # Alias for an MCP server or set of servers
git: github,gitmcp
enabled_mcp_servers: null # Which MCP servers to enable by default (e.g. 'github,slack')
```
A special note about `enabled_mcp_servers`: a user can set this to `all` to enable all configured MCP servers in the
`functions/mcp.json` configuration.
(See the [Configuration Example](../../config.example.yaml) file for an example global configuration with all options.)
When running in REPL-mode, the `mcp_server_support` and `enabled_mcp_servers` settings can be overridden using the
`.set` command:
![REPL set MCP servers](../images/mcp/global-settings-overrides-repl.png)
### Role Configuration
When you create a role, you have the following MCP-related configuration options available to you:
```yaml
enabled_mcp_servers: github # Which MCP servers the role uses.
```
The values for `mapping_mcp_servers` are inherited from the `[global configuration](#global-configuration)`.
For more information about roles, refer to the [Roles](../ROLES.md) documentation.
### Agent Configuration
When you create an agent, you have the following MCP-related configuration options available to you:
```yaml
mcp_servers: # Which MCP servers the agent uses
- github
- docker
```
The values for `mapping_mcp_servers` are inherited from the [global configuration](#global-configuration).
For more information about agents, refer to the [Agents](../AGENTS.md) documentation.
For a full example configuration for an agent, see the [Agent Configuration Example](../../config.agent.example.yaml) file.
+192
View File
@@ -0,0 +1,192 @@
# Tools
Loki supports function calling with various tools built-in to enhance LLM capabilities. All built-in tools for Loki
are located in the [`functions/tools`](../../assets/functions/tools) directory. These tools are also stored in your Loki `functions`
directory, which is also where you'd go to add more tools.
**Pro Tip:** The Loki functions directory can be found by running the following command:
```bash
loki --info | grep functions_dir | awk '{print $2}'
```
# Quick Links
<!--toc:start-->
- [Built-In Tools](#built-in-tools)
- [Configuration](#configuration)
- [Global Configuration](#global-configuration)
- [Enabling/Disabling Global Tools](#enablingdisabling-global-tools)
- [Role Configuration](#role-configuration)
- [Agent Configuration](#agent-configuration)
- [Tool Error Handling](#tool-error-handling)
- [Native/Shell Tool Errors](#nativeshell-tool-errors)
- [MCP Errors](#mcp-tool-errors)
- [Why Tool Error Handling Is Important](#why-this-matters)
<!--toc:end-->
---
## Built-In Tools
The following tools are built-in to Loki by default, and their default enabled/disabled status is indicated. More about how tools can
be enabled/disabled can be found in the [Configuration](#configuration) section below.
| Tool | Description | Enabled/Disabled |
|-------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|
| [`demo_py.py`](../../assets/functions/tools/demo_py.py) | Demonstrates how to create a tool using Python and how to use comments. | 🔴 |
| [`demo_sh.sh`](../../assets/functions/tools/demo_sh.sh) | Demonstrate how to create a tool using Bash and how to use comment tags. | 🔴 |
| [`demo_ts.ts`](../../assets/functions/tools/demo_ts.ts) | Demonstrates how to create a tool using TypeScript and how to use JSDoc comments. | 🔴 |
| [`execute_command.sh`](../../assets/functions/tools/execute_command.sh) | Execute the shell command. | 🟢 |
| [`execute_py_code.py`](../../assets/functions/tools/execute_py_code.py) | Execute the given Python code. | 🔴 |
| [`execute_sql_code.sh`](../../assets/functions/tools/execute_sql_code.sh) | Execute SQL code. | 🔴 |
| [`fetch_url_via_curl.sh`](../../assets/functions/tools/fetch_url_via_curl.sh) | Extract the content from a given URL using cURL. | 🔴 |
| [`fetch_url_via_jina.sh`](../../assets/functions/tools/fetch_url_via_jina.sh) | Extract the content from a given URL using Jina. | 🔴 |
| [`fs_cat.sh`](../../assets/functions/tools/fs_cat.sh) | Read the contents of a file at the specified path. | 🟢 |
| [`fs_read.sh`](../../assets/functions/tools/fs_read.sh) | Controlled reading of the contents of a file at the specified path with line numbers, offset, and limit to read specific sections. | 🟢 |
| [`fs_glob.sh`](../../assets/functions/tools/fs_glob.sh) | Find files by glob pattern. Returns matching file paths sorted by modification time. | 🟢 |
| [`fs_grep.sh`](../../assets/functions/tools/fs_grep.sh) | Search file contents using regular expressions. Returns matching file paths and lines. | 🟢 |
| [`fs_ls.sh`](../../assets/functions/tools/fs_ls.sh) | List all files and directories at the specified path. | 🟢 |
| [`fs_mkdir.sh`](../../assets/functions/tools/fs_mkdir.sh) | Create a new directory at the specified path. | 🔴 |
| [`fs_patch.sh`](../../assets/functions/tools/fs_patch.sh) | Apply a patch to a file at the specified path. <br>This can be used to edit a file without having to rewrite the whole file. | 🔴 |
| [`fs_rm.sh`](../../assets/functions/tools/fs_rm.sh) | Remove a file or directory at the specified path. | 🔴 |
| [`fs_write.sh`](../../assets/functions/tools/fs_write.sh) | Write the full file contents to a file at the specified path. | 🟢 |
| [`get_current_time.sh`](../../assets/functions/tools/get_current_time.sh) | Get the current time. | 🟢 |
| [`get_current_weather.py`](../../assets/functions/tools/get_current_weather.py) | Get the current weather in a given location (Python implementation) | 🔴 |
| [`get_current_weather.sh`](../../assets/functions/tools/get_current_weather.sh) | Get the current weather in a given location. | 🟢 |
| [`get_current_weather.ts`](../../assets/functions/tools/get_current_weather.ts) | Get the current weather in a given location (TypeScript implementation) | 🔴 |
| [`query_jira_issues.sh`](../../assets/functions/tools/query_jira_issues.sh) | Query for jira issues using a Jira Query Language (JQL) query. | 🟢 |
| [`search_arxiv.sh`](../../assets/functions/tools/search_arxiv.sh) | Search arXiv using the given search query and return the top papers. | 🔴 |
| [`search_wikipedia.sh`](../../assets/functions/tools/search_wikipedia.sh) | Search Wikipedia using the given search query. <br>Use it to get detailed information about a public figure, interpretation of a <br>complex scientific concept or in-depth connectivity of a significant historical <br>event, etc. | 🔴 |
| [`search_wolframalpha.sh`](../../assets/functions/tools/search_wolframalpha.sh) | Get an answer to a question using Wolfram Alpha. The input query should be <br>in English. Use it to answer user questions that require computation, detailed <br>facts, data analysis, or complex queries. | 🔴 |
| [`send_mail.sh`](../../assets/functions/tools/send_mail.sh) | Send an email. | 🔴 |
| [`send_twilio.sh`](../../assets/functions/tools/send_twilio.sh) | Send SMS or Twilio Messaging Channels messages using the Twilio API. | 🔴 |
| [`web_search_loki.sh`](../../assets/functions/tools/web_search_loki.sh) | Perform a web search to get up-to-date information or additional context. <br>Use this when you need current information or feel a search could provide <br>a better answer. | 🔴 |
| [`web_search_perplexity.sh`](../../assets/functions/tools/web_search_perplexity.sh) | Perform a web search using the Perplexity API to get up-to-date <br>information or additional context. Use this when you need current <br>information or feel a search could provide a better answer. | 🔴 |
| [`web_search_tavily.sh`](../../assets/functions/tools/web_search_tavily.sh) | Perform a web search using the Tavily API to get up-to-date <br>information or additional context. Use this when you need current <br>information or feel a search could provide a better answer. | 🔴 |
Details on what configuration, if any, is necessary for each tool can be found inside the tool file definition itself.
## Configuration
Tools can be used in a handful of contexts:
* Inside a session
* Inside a role
* Inside an agent
* Globally (i.e. outside a session, role, or agent)
Each of these has a different configuration and interaction with the global configuration.
**Note:** For each configuration property listed below, the functions that are mentioned *only*
correspond to the tool scripts located in your Loki `functions/tools` directory.
### Global Configuration
The global configuration is essentially what settings you want to have on by default when
you just invoke `loki`. (Don't worry about agents, roles, or sessions yet. We'll get to them in a bit).
The following settings are available in the global configuration for tools:
```yaml
function_calling_support: true # Enables or disables function calling in any context
mapping_tools: # Alias for a tool or toolset
fs: 'fs_cat,fs_ls,fs_mkdir,fs_rm,fs_write'
enabled_tools: null # Which tools to use by default. (e.g. 'fs,web_search_loki')
visible_tools: # Which tools are visible to be compiled (and are thus able to be defined in 'enabled_tools')
# - demo_py.py
- execute_command.sh
```
A special not about `enabled_tools`: a user can set this to `all` to enable all available tools listed in the
`visible_tools` section of your Loki `config.yaml` file.
See the [Enabling/Disabling Global Tools](#enablingdisabling-global-tools) section below for more information on how tools
are globally enabled/disabled globally.
(See the [Configuration Example](../../config.example.yaml) file for an example global configuration with all options.)
When running in REPL-mode, the `function_calling_support` and `enabled_tools` settings can be overridden using the
`.set` command:
![REPL set function calling](../images/tools/global-settings-overrides-repl.png)
You'll notice that mentioned above, some tools are disabled while others are enabled. How is that determined?
### Enabling/Disabling Global Tools
The configured tools are enabled/disabled by looking at the values in the `visible_tools` array in your `config.yaml`
file. This file is located in the root of the Loki `config` directory. The location of the Loki config varies by system,
so your config file can be found using the following command:
```bash
loki --info | grep 'config_file' | awk '{print $2}'
```
Each line in the `visible_tools` array lists a tool.
If that line is commented out, then that tool is not included in the global tool set, and cannot be used in any context;
This means it will not be built, and even if enabled under `enabled_tools`, it still will not be available in any
context.
### Role Configuration
When you create a role, you have the following global tool-related configuration options available to you:
```yaml
enabled_tools: query_jira_issues # Which tools the role uses.
```
The values for `mapping_tools` are inherited from the [global configuration](#global-configuration).
For more information about roles, refer to the [Roles](../ROLES.md) documentation.
### Agent Configuration
When you create an agent, you have the following global tool-related configuration options available to you:
```yaml
global_tools: # Which global tools the agent uses
- query_jira_issues.sh
- fs_cat.sh
- fs_ls.sh
```
The values for `mapping_tools` are inherited from the [global configuration](#global-configuration).
For more information about agents, refer to the [Agents](../AGENTS.md) documentation.
For a full example configuration for an agent, see the [Agent Configuration Example](../../config.agent.example.yaml) file.
---
## Tool Error Handling
When tools fail, Loki captures error information and passes it back to the model so it can diagnose issues and
potentially retry or adjust its approach.
### Native/Shell Tool Errors
When a shell-based tool exits with a non-zero exit code, the model receives:
```json
{
"tool_call_error": "Tool call 'my_tool' exited with code 1",
"stderr": "Error: file not found: config.json"
}
```
The `stderr` field contains the actual error output from the tool, giving the model context about what went wrong.
If the tool produces no stderr output, only the `tool_call_error` field is included.
**Note:** Tool stdout streams to your terminal in real-time so you can see progress. Only stderr is captured for
error reporting.
### MCP Tool Errors
When an MCP (Model Context Protocol) tool invocation fails due to connection issues, timeouts, or server errors,
the model receives:
```json
{
"tool_call_error": "MCP tool invocation failed: connection refused"
}
```
This allows the model to understand that an external service failed and take appropriate action (retry, use an
alternative approach, or inform the user).
### Why This Matters
Without proper error propagation, models would only know that "something went wrong" without understanding *what*
went wrong. By including stderr output and detailed error messages, models can:
- Diagnose the root cause of failures
- Suggest fixes (e.g., "the file doesn't exist, should I create it?")
- Retry with corrected parameters
- Fall back to alternative approaches when appropriate
Binary file not shown.

After

Width:  |  Height:  |  Size: 370 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 587 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 55 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 446 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.0 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 21 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 878 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 170 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 225 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 189 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 67 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 46 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 303 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 63 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 151 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 78 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 43 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 58 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 60 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 60 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 58 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 70 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 68 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 67 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 66 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 67 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 63 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 55 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 67 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 57 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 60 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.4 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.9 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.4 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.3 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.5 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.2 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.4 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.2 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 21 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 396 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.9 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.2 KiB

+407
View File
@@ -0,0 +1,407 @@
# Phase 1 Flow Test Plan
Comprehensive behavioral verification plan comparing the old codebase
(`~/code/testing/loki` on `develop` branch) against the new Phase 1
codebase (`~/code/loki`). Every test should produce identical behavior
in both codebases unless noted as an intentional improvement.
## How to run
For each test case:
1. Run the test in the OLD codebase (`cd ~/code/testing/loki && cargo run --`)
2. Run the same test in the NEW codebase (`cd ~/code/loki && cargo run --`)
3. Compare output/behavior
4. Mark PASS/FAIL/IMPROVED
Legend:
- `OLD:` = expected behavior from old codebase
- `NEW:` = expected behavior from new codebase (should match unless noted)
- `[IMPROVED]` = intentional behavioral improvement in new code
---
## 1. Build Baseline
| # | Test | Command | Expected |
|---|---|---|---|
| 1.1 | Compile check | `cargo check` | Zero warnings, zero errors |
| 1.2 | Clippy | `cargo clippy` | Zero warnings (excluding pre-existing) |
| 1.3 | Tests | `cargo test` | All tests pass |
---
## 2. CLI — Info and Listing (early-exit paths)
These should produce identical output in both codebases.
| # | Test | Command | Expected |
|---|---|---|---|
| 2.1 | System info | `loki --info` | Prints config paths, model, settings |
| 2.2 | List models | `loki --list-models` | Prints all available model IDs |
| 2.3 | List roles | `loki --list-roles` | Prints role names (no hidden files) |
| 2.4 | List sessions | `loki --list-sessions` | Prints session names |
| 2.5 | List agents | `loki --list-agents` | Prints agent names, no `.shared` [IMPROVED] |
| 2.6 | List RAGs | `loki --list-rags` | Prints RAG names |
| 2.7 | List macros | `loki --list-macros` | Prints macro names |
| 2.8 | Sync models | `loki --sync-models` | Fetches models.yaml, prints status |
---
## 3. CLI — Single-shot Chat
| # | Test | Command | Expected |
|---|---|---|---|
| 3.1 | Basic chat | `loki "What is 2+2?"` | Response printed, exits |
| 3.2 | With role | `loki --role coder "hello"` | Role context applied |
| 3.3 | With prompt | `loki --prompt "you are a pirate" "hello"` | Temp role applied |
| 3.4 | With model | `loki --model <model_id> "hello"` | Uses specified model |
| 3.5 | With session | `loki -s test "hello"` | Session created, message saved |
| 3.6 | Resume session | `loki -s test "what did I say?"` | Session context preserved |
| 3.7 | Dry run | `loki --dry-run "hello"` | Input echoed, no API call |
| 3.8 | No stream | `loki --no-stream "hello"` | Response printed all at once |
| 3.9 | Empty session | `loki -s test --empty-session "hello"` | Session cleared, fresh start |
| 3.10 | Save session | `loki -s test --save-session "hello"` | Forces session save |
| 3.11 | Code mode | `loki -c "fibonacci in python"` | Only code output |
---
## 4. CLI — File Input
| # | Test | Command | Expected |
|---|---|---|---|
| 4.1 | File + text | `loki -f /etc/hostname "summarize"` | File content included |
| 4.2 | File only | `loki -f /etc/hostname` | File sent as input |
| 4.3 | Multiple files | `loki -f /etc/hostname -f /etc/os-release "compare"` | Both files included |
| 4.4 | Stdin pipe | `echo "hello" \| loki "summarize"` | Stdin included |
---
## 5. CLI — Shell Execute
| # | Test | Command | Expected |
|---|---|---|---|
| 5.1 | Generate command | `loki -e "list files in /tmp"` | Shell command generated |
| 5.2 | Describe mode | Press 'd' when prompted | Explanation shown |
| 5.3 | Execute mode | Press 'y' when prompted | Command executed |
| 5.4 | Dry run | `loki -e --dry-run "list files"` | Input shown, no execution |
---
## 6. CLI — Agent (non-interactive)
| # | Test | Command | Expected |
|---|---|---|---|
| 6.1 | Agent chat | `loki -a coder "write hello world in python"` | Agent tools available, response |
| 6.2 | Agent + session | `loki -a coder -s test "hello"` | Agent with specific session |
| 6.3 | Agent variables | `loki -a demo --agent-variable key val "hello"` | Variable injected |
| 6.4 | Agent MCP | `loki -a <mcp-agent> "use the server"` | MCP servers start, tools work |
| 6.5 | Build tools | `loki -a coder --build-tools` | Tools compiled, exits |
---
## 7. CLI — Macros
| # | Test | Command | Expected |
|---|---|---|---|
| 7.1 | Execute macro | `loki --macro generate-commit-message` | Macro executes |
---
## 8. CLI — Vault (early-exit)
| # | Test | Command | Expected |
|---|---|---|---|
| 8.1 | Add secret | `loki --add-secret test-secret` | Prompts for value, saves |
| 8.2 | Get secret | `loki --get-secret test-secret` | Prints decrypted value |
| 8.3 | List secrets | `loki --list-secrets` | Lists all secret names |
| 8.4 | Delete secret | `loki --delete-secret test-secret` | Deletes, confirms |
---
## 9. REPL — Startup and Exit
| # | Test | Steps | Expected |
|---|---|---|---|
| 9.1 | Start REPL | `loki` | Welcome message shown |
| 9.2 | Exit command | Type `.exit` | Clean exit |
| 9.3 | Ctrl+D | Press Ctrl+D | Clean exit |
| 9.4 | Ctrl+C | Press Ctrl+C | Hint message, stays in REPL |
| 9.5 | Prelude role | Set `repl_prelude: "role:coder"` in config, start REPL | Role auto-loaded, prompt changes |
| 9.6 | Prelude session | Set `repl_prelude: "mysession:coder"`, start | Session+role auto-loaded |
---
## 10. REPL — Basic Chat
| # | Test | Steps | Expected |
|---|---|---|---|
| 10.1 | Chat message | Type `hello` | Response streamed |
| 10.2 | Continue | Type `.continue` after response | Continuation generated |
| 10.3 | Regenerate | Type `.regenerate` | New response generated |
| 10.4 | Copy | Type `.copy` | Last response copied to clipboard |
| 10.5 | Multi-line | Type `:::`, then multi-line, then `:::` | Multi-line sent as one message |
| 10.6 | Empty input | Press Enter on empty line | No action |
| 10.7 | Help | Type `.help` | Help text shown |
| 10.8 | Info | Type `.info` | System info printed |
---
## 11. REPL — Roles
| # | Test | Steps | Expected |
|---|---|---|---|
| 11.1 | Enter role | `.role coder` | Prompt changes, role active |
| 11.2 | One-shot role | `.role coder write hello world` | Response with role, then returns to no-role |
| 11.3 | Role info | `.info role` (while in role) | Role details shown |
| 11.4 | Edit role | `.edit role` (while in role) | Editor opens |
| 11.5 | Save role | `.save role myname` | Role saved to file |
| 11.6 | Exit role | `.exit role` | Prompt resets, role cleared |
| 11.7 | Create new role | `.role newname` (non-existent) | Editor opens for new role |
| 11.8 | Role + MCP | `.role <mcp-role>` | MCP servers start with spinner, tools available |
| 11.9 | Exit role + MCP | `.exit role` (from MCP role) | MCP servers stop, global MCP restored |
| 11.10 | Role in session | `.session test` then `.role coder` | Role applied within session |
---
## 12. REPL — Sessions
| # | Test | Steps | Expected |
|---|---|---|---|
| 12.1 | Temp session | `.session` | Temp session started |
| 12.2 | Named session | `.session mytest` | Named session created/resumed |
| 12.3 | Session info | `.info session` | Session details shown |
| 12.4 | Edit session | `.edit session` | Editor opens |
| 12.5 | Save session | `.save session myname` | Session saved |
| 12.6 | Empty session | `.empty session` | Messages cleared |
| 12.7 | Compress session | `.compress session` | Compression runs with spinner |
| 12.8 | Exit session | `.exit session` | Session exited |
| 12.9 | Carry-over prompt | Send message, then `.session test` | "incorporate last Q&A?" prompt |
| 12.10 | Session + MCP | `.session <mcp-session>` | MCP servers start |
| 12.11 | Already in session | `.session` while in session | Error: "Already in a session" |
---
## 13. REPL — Agents
| # | Test | Steps | Expected |
|---|---|---|---|
| 13.1 | Start agent | `.agent coder` | Tools compiled, prompt changes, agent active |
| 13.2 | Agent + session | `.agent coder mysession` | Agent with specific session |
| 13.3 | Agent variables | `.agent demo key=value` | Variable set, available in tools |
| 13.4 | Agent info | `.info agent` | Agent details shown |
| 13.5 | Starter list | `.starter` | Conversation starters listed |
| 13.6 | Starter select | `.starter 1` | Starter message sent |
| 13.7 | Edit agent config | `.edit agent-config` | Editor opens |
| 13.8 | Exit agent | `.exit agent` | Agent cleared, prompt resets |
| 13.9 | Agent + MCP | `.agent <mcp-agent>` | MCP servers start, tools available |
| 13.10 | MCP disabled | `.agent <mcp-agent>` with mcp_server_support=false | Error, agent blocked [IMPROVED] |
| 13.11 | Tool execution | Send message that triggers tool call | Tool executes, result returned |
| 13.12 | Global tools | Agent with `global_tools` configured | Global tools available alongside agent tools |
| 13.13 | Tool file priority | Delete .ts, have .sh | .sh used [IMPROVED] |
| 13.14 | Clear todo | `.clear todo` (in agent with auto-continue) | Todo list cleared |
| 13.15 | Auto-continuation | Agent with auto_continue=true, create todos | Agent continues until todos done |
| 13.16 | Already in agent | `.agent coder` while agent active | Error: "Already in an agent" |
---
## 14. REPL — Sub-Agent Spawning and Escalation
| # | Test | Steps | Expected |
|---|---|---|---|
| 14.1 | Spawn sub-agent | Use agent with can_spawn_agents=true, trigger spawn | Sub-agent starts in background |
| 14.2 | Check sub-agent | Call agent__check with agent ID | Returns PENDING or result |
| 14.3 | Collect sub-agent | Call agent__collect with agent ID | Blocks until done, returns output |
| 14.4 | List sub-agents | Call agent__list | Shows all spawned agents + status |
| 14.5 | Cancel sub-agent | Call agent__cancel with agent ID | Agent cancelled |
| 14.6 | Escalation | Sub-agent calls user__ask | Parent gets notification |
| 14.7 | Reply escalation | Parent calls agent__reply_escalation | Sub-agent unblocked |
| 14.8 | Max depth | Spawn beyond max_agent_depth | Error: "Max agent depth exceeded" |
| 14.9 | Max concurrent | Spawn beyond max_concurrent_agents | Error: capacity reached |
| 14.10 | Teammate messaging | Sub-agent sends message to sibling | Message delivered via inbox |
---
## 15. REPL — RAG
| # | Test | Steps | Expected |
|---|---|---|---|
| 15.1 | Init RAG | `.rag <name>` | RAG initialized/loaded |
| 15.2 | RAG info | `.info rag` | RAG details shown |
| 15.3 | RAG sources | `.sources rag` (after a query) | Citation sources listed |
| 15.4 | Edit RAG docs | `.edit rag-docs` | Editor opens |
| 15.5 | Rebuild RAG | `.rebuild rag` | RAG rebuilt |
| 15.6 | Exit RAG | `.exit rag` | RAG cleared |
| 15.7 | RAG embeddings | Send query with RAG active | Embeddings included in context |
---
## 16. REPL — MCP Servers
| # | Test | Steps | Expected |
|---|---|---|---|
| 16.1 | Global MCP start | Start REPL with `enabled_mcp_servers` configured | Servers start |
| 16.2 | MCP search | LLM calls `mcp__search_<server>` | Tools found and ranked |
| 16.3 | MCP describe | LLM calls `mcp__describe_<server>` tool_name | Schema returned |
| 16.4 | MCP invoke | LLM calls `mcp__invoke_<server>` tool args | Tool executed, result returned |
| 16.5 | Change servers | `.set enabled_mcp_servers <other>` | Old stopped, new started |
| 16.6 | Disable MCP | `.set mcp_server_support false` | MCP tools removed |
| 16.7 | Enable MCP | `.set mcp_server_support true` | MCP tools restored |
| 16.8 | Role MCP switch | Enter role with MCP X, exit, enter role with MCP Y | X stops, Y starts |
| 16.9 | Null servers | `.set enabled_mcp_servers null` | All MCP servers stop, tools removed |
---
## 17. REPL — Settings (.set)
| # | Test | Steps | Expected |
|---|---|---|---|
| 17.1 | Temperature | `.set temperature 0.5` | Temperature changed |
| 17.2 | Top-p | `.set top_p 0.9` | Top-p changed |
| 17.3 | Model | `.set model <name>` | Model switched |
| 17.4 | Dry run | `.set dry_run true` | Dry run enabled |
| 17.5 | Stream | `.set stream false` | Streaming disabled |
| 17.6 | Save | `.set save false` | Auto-save disabled |
| 17.7 | Highlight | `.set highlight false` | Syntax highlighting disabled |
| 17.8 | Save session | `.set save_session true` | Session auto-save enabled |
| 17.9 | Null value | `.set temperature null` | Temperature reset to default |
| 17.10 | Compression threshold | `.set compression_threshold 2000` | Threshold changed |
| 17.11 | Max output tokens | `.set max_output_tokens 4096` | Max tokens set |
| 17.12 | Enabled tools | `.set enabled_tools all` | All tools enabled |
| 17.13 | Function calling | `.set function_calling_support false` | Function calling disabled |
---
## 18. REPL — Tab Completion
| # | Test | Steps | Expected |
|---|---|---|---|
| 18.1 | Role completion | `.role<TAB>` | Shows role names |
| 18.2 | Agent completion | `.agent<TAB>` | Shows agent names (no .shared) [IMPROVED] |
| 18.3 | Session completion | `.session<TAB>` | Shows session names |
| 18.4 | RAG completion | `.rag<TAB>` | Shows RAG names |
| 18.5 | Macro completion | `.macro<TAB>` | Shows macro names |
| 18.6 | Model completion | `.model<TAB>` | Shows model names with descriptions |
| 18.7 | Set keys | `.set <TAB>` | Shows all setting names |
| 18.8 | Set values | `.set temperature <TAB>` | Shows current/suggested value |
| 18.9 | Enabled tools | `.set enabled_tools <TAB>` | Shows tools (no user__/mcp_/todo__/agent__) [IMPROVED] |
| 18.10 | MCP servers | `.set enabled_mcp_servers <TAB>` | Shows configured servers + mappings [IMPROVED] |
| 18.11 | Delete types | `.delete <TAB>` | Shows: role, session, rag, macro, agent-data |
| 18.12 | Vault cmds | `.vault <TAB>` | Shows: add, get, update, delete, list |
---
## 19. REPL — Delete
| # | Test | Steps | Expected |
|---|---|---|---|
| 19.1 | Delete role | `.delete role` | Shows role picker, deletes selected |
| 19.2 | Delete session | `.delete session` | Shows session picker, deletes |
| 19.3 | Delete RAG | `.delete rag` | Shows RAG picker, deletes |
| 19.4 | Delete macro | `.delete macro` | Shows macro picker, deletes |
| 19.5 | Delete agent data | `.delete agent-data` | Shows agent picker, deletes data |
---
## 20. REPL — Vault
| # | Test | Steps | Expected |
|---|---|---|---|
| 20.1 | Add secret | `.vault add mysecret` | Prompts for value, saves |
| 20.2 | Get secret | `.vault get mysecret` | Prints decrypted value |
| 20.3 | Update secret | `.vault update mysecret` | Prompts for new value |
| 20.4 | Delete secret | `.vault delete mysecret` | Deletes |
| 20.5 | List secrets | `.vault list` | Lists all secret names |
---
## 21. REPL — Macros and File
| # | Test | Steps | Expected |
|---|---|---|---|
| 21.1 | Execute macro | `.macro generate-commit-message` | Macro runs |
| 21.2 | Create macro | `.macro newname` (non-existent) | Editor opens |
| 21.3 | File include | `.file /etc/hostname -- summarize this` | File included, query sent |
| 21.4 | URL include | `.file https://example.com -- summarize` | URL fetched, content included |
---
## 22. REPL — Edit Commands
| # | Test | Steps | Expected |
|---|---|---|---|
| 22.1 | Edit config | `.edit config` | Config file opens in editor |
| 22.2 | Edit role | `.edit role` (in role) | Role file opens in editor |
| 22.3 | Edit session | `.edit session` (in session) | Session file opens in editor |
| 22.4 | Edit agent config | `.edit agent-config` (in agent) | Agent config opens in editor |
| 22.5 | Edit RAG docs | `.edit rag-docs` (in RAG) | RAG docs opens in editor |
---
## 23. Session Compression and Autoname
| # | Test | Steps | Expected |
|---|---|---|---|
| 23.1 | Auto-compress | Set low compression_threshold, send many messages | "Compressing the session." shown |
| 23.2 | Manual compress | `.compress session` | Compression runs with spinner |
| 23.3 | Auto-name | Start temp session, send messages | Session auto-named |
---
## 24. Error Handling
| # | Test | Steps | Expected |
|---|---|---|---|
| 24.1 | Invalid role | `.role nonexistent_role_xxxxxxx` | Error shown, REPL continues |
| 24.2 | Invalid model | `.set model nonexistent_model` | Error shown, REPL continues |
| 24.3 | No session active | `.info session` (no session) | Error or empty |
| 24.4 | No agent active | `.info agent` (no agent) | Error or empty |
| 24.5 | Already in session | `.session` then `.session` again | Error: "Already in a session" |
| 24.6 | Already in agent | `.agent coder` then `.agent coder` | Error: "Already in an agent" |
| 24.7 | Unknown command | `.nonexistent` | Error message shown |
| 24.8 | Tool failure | Trigger tool that fails | Error returned to LLM as tool result |
---
## 25. MCP Lifecycle State Transitions (Critical)
These test the most bug-prone area of the migration.
| # | Test | Steps | Expected |
|---|---|---|---|
| 25.1 | Role A→B MCP swap | Enter role with MCP-A, exit, enter role with MCP-B | A stops, B starts, B tools work |
| 25.2 | Role MCP→no MCP | Enter role with MCP, exit role | MCP stops, global MCP restored |
| 25.3 | No MCP→Role MCP | Start REPL (no MCP), enter role with MCP | MCP starts, tools work |
| 25.4 | Agent MCP lifecycle | Start agent with MCP, use tools, exit agent | Agent MCP starts, works, stops on exit |
| 25.5 | Session MCP | Start session with MCP config | MCP starts for session |
| 25.6 | Global→Agent→Global | Start with global MCP-A, enter agent with MCP-B, exit agent | A→B→A transitions clean |
| 25.7 | MCP mapping resolution | Role has `enabled_mcp_servers: alias`, mapping configured | Alias resolved, correct servers start |
| 25.8 | MCP disabled + agent | Agent requires MCP, mcp_server_support=false | Error blocks agent start [IMPROVED] |
---
## Intentional Improvements (NEW ≠ OLD, by design)
| # | What changed | Old behavior | New behavior |
|---|---|---|---|
| I.1 | Agent list hides `.shared` | `.shared` shown in completions | `.shared` hidden |
| I.2 | Tool file priority | Filesystem order (non-deterministic) | Priority: .sh > .py > .ts > .js |
| I.3 | MCP disabled + agent | Warning printed, agent starts anyway | Error, agent blocked |
| I.4 | Role MCP disabled warning | Warning always shown (even if role has no MCP) | Warning only when role actually has MCP |
| I.5 | Enabled tools completions | Shows internal tools (user__, mcp_, etc.) | Internal tools hidden |
| I.6 | MCP server completions | Only mapping aliases | Both configured servers + aliases |
---
## Test Execution Notes
- Run tests in order — some depend on state from previous tests
(e.g., session tests create sessions that later tests reference)
- For MCP tests, ensure at least one MCP server is configured in
`~/.config/loki/functions/mcp.json`
- For agent tests, use built-in agents (coder, demo, explore)
- For sub-agent tests, use the sisyphus agent (has can_spawn_agents)
- For RAG tests, configure a RAG with test documents
- For vault tests, use temporary secret names to avoid polluting
the real vault
- Compare error messages between old and new — they may differ
slightly in wording but should convey the same meaning
File diff suppressed because it is too large Load Diff
@@ -0,0 +1,727 @@
# Phase 2 Implementation Plan: Engine + Emitter
## Overview
Phase 1 splits `Config` into `AppState` + `RequestContext`. Phase 2 takes the unified state and introduces the **Engine** — a single core function that replaces CLI's `start_directive()` and REPL's `ask()` — plus an **Emitter trait** that abstracts output away from direct stdout writes. After this phase, CLI and REPL both call `Engine::run()` with different `Emitter` implementations and behave identically to today. The API server in Phase 4 will plug in without touching core logic.
**Estimated effort:** ~1 week
**Risk:** Low-medium. The work is refactoring existing well-tested code paths into a shared shape. Most of the risk is in preserving exact terminal rendering behavior.
**Depends on:** Phase 1 Steps 010 complete (`GlobalConfig` eliminated, `RequestContext` wired through all entry points).
---
## Why Phase 2 Exists
Today's CLI and REPL have two near-identical pipelines that diverge in five specific places. The divergences are accidents of history, not intentional design:
1. **Streaming flag handling.** `start_directive` forces non-streaming when extracting code; `ask` never extracts code.
2. **Auto-continuation loop.** `ask` has complex logic for `auto_continue_count`, todo inspection, and continuation prompt injection. `start_directive` has none.
3. **Session compression.** `ask` triggers `maybe_compress_session` and awaits completion; `start_directive` never compresses.
4. **Session autoname.** `ask` calls `maybe_autoname_session` after each turn; `start_directive` doesn't.
5. **Cleanup on exit.** `start_directive` calls `exit_session()` at the end; `ask` lets the REPL loop handle it.
Four of these five divergences are bugs waiting to happen — they mean agents behave differently in CLI vs REPL mode, sessions don't get compressed in CLI even when they should, and auto-continuation is silently unavailable from the CLI. Phase 2 collapses both pipelines into one `Engine::run()` that handles all five behaviors uniformly, with per-request flags to control what's active (e.g., `auto_continue: bool` on `RunRequest`).
The Emitter trait exists to decouple the rendering pipeline from its destination. Today, streaming output is hardcoded to write to the terminal via `crossterm`. An `Emitter` implementation can also feed an axum SSE stream, collect events for a JSON response, or capture everything for a test. The Engine sends semantic events; Emitters decide how to present them.
---
## The Architecture After Phase 2
```
┌─────────┐ ┌─────────┐ ┌─────────┐
│ CLI │ │ REPL │ │ API │ (Phase 4)
└────┬────┘ └────┬────┘ └────┬────┘
│ │ │
▼ ▼ ▼
┌──────────────────────────────────────────────────┐
│ Engine::run(ctx, req, emitter) │
│ ┌────────────────────────────────────────────┐ │
│ │ 1. Apply CoreCommand (if any) │ │
│ │ 2. Build Input from req │ │
│ │ 3. apply_prelude (first turn only) │ │
│ │ 4. before_chat_completion │ │
│ │ 5. Stream or buffered LLM call │ │
│ │ ├─ emit Started │ │
│ │ ├─ emit AssistantDelta (per chunk) │ │
│ │ ├─ emit ToolCall │ │
│ │ ├─ execute tool │ │
│ │ ├─ emit ToolResult │ │
│ │ └─ loop on tool results │ │
│ │ 6. after_chat_completion │ │
│ │ 7. maybe_compress_session │ │
│ │ 8. maybe_autoname_session │ │
│ │ 9. Auto-continuation (if applicable) │ │
│ │ 10. emit Finished │ │
│ └────────────────────────────────────────────┘ │
└──────────────────────────────────────────────────┘
│ │ │
▼ ▼ ▼
TerminalEmitter TerminalEmitter JsonEmitter / SseEmitter
```
---
## Core Types
### `Engine`
```rust
pub struct Engine {
pub app: Arc<AppState>,
}
impl Engine {
pub fn new(app: Arc<AppState>) -> Self { Self { app } }
pub async fn run(
&self,
ctx: &mut RequestContext,
req: RunRequest,
emitter: &dyn Emitter,
) -> Result<RunOutcome, CoreError>;
}
```
`Engine` is intentionally a thin wrapper around `Arc<AppState>`. All per-turn state lives on `RequestContext`, so the engine itself has no per-call fields. This makes it cheap to clone and makes `Engine::run` trivially testable.
### `RunRequest`
```rust
pub struct RunRequest {
pub input: Option<UserInput>,
pub command: Option<CoreCommand>,
pub options: RunOptions,
}
pub struct UserInput {
pub text: String,
pub files: Vec<FileInput>,
pub media: Vec<MediaInput>,
pub continuation: Option<ContinuationKind>,
}
pub enum ContinuationKind {
Continue,
Regenerate,
}
pub struct RunOptions {
pub stream: Option<bool>,
pub extract_code: bool,
pub auto_continue: bool,
pub compress_session: bool,
pub autoname_session: bool,
pub apply_prelude: bool,
pub with_embeddings: bool,
pub cancel: CancellationToken,
}
impl RunOptions {
pub fn cli() -> Self { /* today's start_directive defaults */ }
pub fn repl_turn() -> Self { /* today's ask defaults */ }
pub fn api_oneshot() -> Self { /* API one-shot defaults */ }
pub fn api_session() -> Self { /* API session defaults */ }
}
```
Two things to notice:
1. **`input` is `Option`.** A `RunRequest` can carry just a `command` (e.g., `.role explain`) with no user text, just an input (a plain prompt), or both (the `.role <name> <text>` form that activates a role and immediately sends a prompt through it). The engine handles all three shapes with one code path.
2. **`RunOptions` is the knob panel that replaces the five divergences.** CLI today has `auto_continue: false, compress_session: false, autoname_session: false`; REPL has all three `true`. Phase 2 exposes these as explicit options with factory constructors for each frontend's conventional defaults. This also means you can now run a CLI one-shot with auto-continuation by constructing `RunOptions::cli()` and flipping `auto_continue = true` — a capability that doesn't exist today.
### `CoreCommand`
```rust
pub enum CoreCommand {
// State setters
SetModel(String),
UsePrompt(String),
UseRole { name: String, trailing_text: Option<String> },
UseSession(Option<String>),
UseAgent { name: String, session: Option<String>, variables: Vec<(String, String)> },
UseRag(Option<String>),
// Exit commands
ExitRole,
ExitSession,
ExitRag,
ExitAgent,
// State queries
Info(InfoScope),
RagSources,
// Config mutation
Set { key: String, value: String },
// Session actions
CompressSession,
EmptySession,
SaveSession { name: Option<String> },
EditSession,
// Role actions
SaveRole { name: Option<String> },
EditRole,
// RAG actions
EditRagDocs,
RebuildRag,
// Agent actions
EditAgentConfig,
ClearTodo,
StarterList,
StarterRun(usize),
// File input shortcut
IncludeFiles { paths: Vec<String>, trailing_text: Option<String> },
// Macro execution
Macro { name: String, args: Vec<String> },
// Vault
VaultAdd(String),
VaultGet(String),
VaultUpdate(String),
VaultDelete(String),
VaultList,
// Miscellaneous
EditConfig,
Authenticate,
Delete(DeleteKind),
Copy,
Help,
}
pub enum InfoScope {
System,
Role,
Session,
Rag,
Agent,
}
pub enum DeleteKind {
Role(String),
Session(String),
Rag(String),
Macro(String),
AgentData(String),
}
```
This enum captures all 37 dot-commands identified in the explore. Three categories deserve special attention:
- **LLM-triggering commands** (`UsePrompt`, `UseRole` with trailing_text, `IncludeFiles` with trailing_text, `StarterRun`, `Macro` that contains LLM calls, and the continuation variants `Continue`/`Regenerate` expressed via `UserInput.continuation`) — these don't just mutate state; they produce a full run through the LLM pipeline. The engine treats them as `RunRequest { command: Some(_), input: Some(_), .. }` — command runs first, then input flows through.
- **Asynchronous commands that return immediately** (`EditConfig`, `EditRole`, `EditRagDocs`, `EditAgentConfig`, most `Vault*`, `Delete`) — these are side-effecting but don't produce an LLM interaction. The engine handles them, emits a `Result` event, and returns without invoking the LLM path.
- **Context-dependent commands** (`ClearTodo`, `StarterList`, `StarterRun`, `EditAgentConfig`, etc.) — these require a specific scope (e.g., active agent). The engine validates the precondition before executing and returns a `CoreError::InvalidState { expected: "active agent" }` if the precondition fails.
### `Emitter` trait and `Event` enum
```rust
#[async_trait]
pub trait Emitter: Send + Sync {
async fn emit(&self, event: Event<'_>) -> Result<(), EmitError>;
}
pub enum Event<'a> {
// Lifecycle
Started { request_id: Uuid, session_id: Option<SessionId>, agent: Option<&'a str> },
Finished { outcome: &'a RunOutcome },
// Assistant output
AssistantDelta(&'a str),
AssistantMessageEnd { full_text: &'a str },
// Tool calls
ToolCall { id: &'a str, name: &'a str, args: &'a str },
ToolResult { id: &'a str, name: &'a str, result: &'a str, is_error: bool },
// Auto-continuation
AutoContinueTriggered { count: usize, max: usize, remaining_todos: usize },
// Session lifecycle signals
SessionCompressing,
SessionCompressed { tokens_saved: Option<usize> },
SessionAutonamed(&'a str),
// Informational
Info(&'a str),
Warning(&'a str),
// Errors
Error(&'a CoreError),
}
pub enum EmitError {
ClientDisconnected,
WriteFailed(std::io::Error),
}
```
Three implementations ship in Phase 2; two are stubs, one is real:
- **`TerminalEmitter`** (real) — wraps today's `SseHandler``markdown_stream`/`raw_stream` path. This is the bulk of Phase 2's work; see "Terminal rendering details" below.
- **`NullEmitter`** (stub, for tests) — drops all events on the floor.
- **`CollectingEmitter`** (stub, for tests and future JSON API) — appends events to a `Vec<OwnedEvent>` for later inspection.
The `JsonEmitter` and `SseEmitter` implementations land in **Phase 4** when the API server comes online.
### `RunOutcome`
```rust
pub struct RunOutcome {
pub request_id: Uuid,
pub session_id: Option<SessionId>,
pub final_message: Option<String>,
pub tool_call_count: usize,
pub turns: usize,
pub compressed: bool,
pub autonamed: Option<String>,
pub auto_continued: usize,
}
```
`RunOutcome` is what CLI/REPL ignore but the future API returns as JSON. It records everything the caller might want to know about what happened during the run.
### `CoreError`
```rust
pub enum CoreError {
InvalidRequest { msg: String },
InvalidState { expected: String, found: String },
NotFound { what: String, name: String },
Cancelled,
ProviderError { provider: String, msg: String },
ToolError { tool: String, msg: String },
EmitterError(EmitError),
Io(std::io::Error),
Other(anyhow::Error),
}
impl CoreError {
pub fn is_retryable(&self) -> bool { /* ... */ }
pub fn http_status(&self) -> u16 { /* for future API use */ }
pub fn terminal_message(&self) -> String { /* for TerminalEmitter */ }
}
```
---
## Terminal Rendering Details
The `TerminalEmitter` is the most delicate part of Phase 2 because it has to preserve every pixel of today's REPL/CLI behavior. Here's the mental model:
**Today's flow:**
```
LLM client → mpsc::Sender<SseEvent> → SseHandler → render_stream
├─ markdown_stream (if highlight)
└─ raw_stream (else)
```
Both `markdown_stream` and `raw_stream` write directly to stdout via `crossterm`, managing cursor positions, line clears, and incremental markdown parsing themselves.
**Target flow:**
```
LLM client → mpsc::Sender<SseEvent> → SseHandler → TerminalEmitter::emit(Event::AssistantDelta)
├─ (internal) markdown_stream state machine
└─ (internal) raw_stream state machine
```
The `TerminalEmitter` owns a `RefCell<StreamRenderState>` (or `Mutex` if we need `Send`) that wraps the existing `markdown_stream`/`raw_stream` state. Each `emit(AssistantDelta)` call feeds the chunk into this state machine exactly as `SseHandler`'s receive loop does today. The result is that the exact same crossterm calls happen in the exact same order — we've just moved them behind a trait.
**Things that migrate 1:1 into `TerminalEmitter`:**
- Spinner start/stop on first delta
- Cursor positioning for line reprint during code block growth
- Syntax highlighting invocation via `MarkdownRender`
- Color/dim output for tool call banners
- Final newline + cursor reset on `AssistantMessageEnd`
**Things that the engine handles, not the emitter:**
- Tool call *execution* (still lives in the engine loop)
- Session state mutations (engine calls `before_chat_completion` / `after_chat_completion` on `RequestContext`)
- Auto-continuation decisions (engine inspects agent runtime)
- Compression and autoname decisions (engine)
**Things the emitter decides, not the engine:**
- Whether to suppress ToolCall rendering (sub-agents in today's code suppress their own output; TerminalEmitter respects a `verbose: bool` flag)
- How to format errors (TerminalEmitter uses colored stderr; JsonEmitter will use structured JSON)
- Whether to show a spinner at all (disabled for non-TTY output)
**One gotcha:** today's `SseHandler` itself produces the `mpsc` channel that LLM clients push into. In the new model, `SseHandler` becomes an internal helper inside the engine's streaming path that converts `mpsc::Receiver<SseEvent>` into `Emitter::emit(Event::AssistantDelta(...))` calls. No LLM client code changes — they still push into the same channel type. Only the consumer side of the channel changes.
---
## The Engine::run Pipeline
Here's the full pipeline in pseudocode, annotated with which frontend controls each behavior via `RunOptions`:
```rust
impl Engine {
pub async fn run(
&self,
ctx: &mut RequestContext,
req: RunRequest,
emitter: &dyn Emitter,
) -> Result<RunOutcome, CoreError> {
let request_id = Uuid::new_v4();
let mut outcome = RunOutcome::new(request_id);
emitter.emit(Event::Started { request_id, session_id: ctx.session_id(), agent: ctx.agent_name() }).await?;
// 1. Execute command (if any). Commands may be LLM-triggering, mutating, or informational.
if let Some(command) = req.command {
self.dispatch_command(ctx, command, emitter, &req.options).await?;
}
// 2. Early return if there's no user input (pure command)
let Some(user_input) = req.input else {
emitter.emit(Event::Finished { outcome: &outcome }).await?;
return Ok(outcome);
};
// 3. Apply prelude on first turn of a fresh context (CLI/REPL only)
if req.options.apply_prelude && !ctx.prelude_applied {
apply_prelude(ctx, &req.options.cancel).await?;
ctx.prelude_applied = true;
}
// 4. Build Input from user_input + ctx
let input = build_input(ctx, user_input, &req.options).await?;
// 5. Wait for any in-progress compression to finish (REPL-style block)
while ctx.is_compressing_session() {
tokio::time::sleep(Duration::from_millis(100)).await;
}
// 6. Enter the turn loop
self.run_turn(ctx, input, &req.options, emitter, &mut outcome).await?;
// 7. Maybe compress session
if req.options.compress_session && ctx.session_needs_compression() {
emitter.emit(Event::SessionCompressing).await?;
compress_session(ctx).await?;
outcome.compressed = true;
emitter.emit(Event::SessionCompressed { tokens_saved: None }).await?;
}
// 8. Maybe autoname session
if req.options.autoname_session {
if let Some(name) = maybe_autoname_session(ctx).await? {
outcome.autonamed = Some(name.clone());
emitter.emit(Event::SessionAutonamed(&name)).await?;
}
}
// 9. Auto-continuation (agents only)
if req.options.auto_continue {
if let Some(continuation) = self.check_auto_continue(ctx) {
emitter.emit(Event::AutoContinueTriggered { .. }).await?;
outcome.auto_continued += 1;
// Recursive call with continuation prompt
let next_req = RunRequest {
input: Some(UserInput::from_continuation(continuation)),
command: None,
options: req.options.clone(),
};
return Box::pin(self.run(ctx, next_req, emitter)).await;
}
}
emitter.emit(Event::Finished { outcome: &outcome }).await?;
Ok(outcome)
}
async fn run_turn(
&self,
ctx: &mut RequestContext,
mut input: Input,
options: &RunOptions,
emitter: &dyn Emitter,
outcome: &mut RunOutcome,
) -> Result<(), CoreError> {
loop {
outcome.turns += 1;
before_chat_completion(ctx, &input);
let client = input.create_client(ctx)?;
let (output, tool_results) = if should_stream(&input, options) {
stream_chat_completion(ctx, &input, client, emitter, &options.cancel).await?
} else {
buffered_chat_completion(ctx, &input, client, options.extract_code, &options.cancel).await?
};
after_chat_completion(ctx, &input, &output, &tool_results);
outcome.tool_call_count += tool_results.len();
if tool_results.is_empty() {
outcome.final_message = Some(output);
return Ok(());
}
// Emit each tool call and result
for result in &tool_results {
emitter.emit(Event::ToolCall { .. }).await?;
emitter.emit(Event::ToolResult { .. }).await?;
}
// Loop: feed tool results back in
input = input.merge_tool_results(output, tool_results);
}
}
}
```
**Key design decisions in this pipeline:**
1. **Command dispatch happens first.** A `RunRequest` that carries both a command and input runs the command first (mutating `ctx`), then the input flows through the now-updated context. This lets `.role explain "tell me about X"` work as a single atomic operation — the role is activated, then the prompt is sent under the new role.
2. **Tool loop is iterative, not recursive.** Today both `start_directive` and `ask` recursively call themselves after tool results. The new `run_turn` uses a `loop` instead, which is cleaner, avoids stack growth on long tool chains, and makes cancellation handling simpler. Auto-continuation remains recursive because it's a full new turn with a new prompt, not just a tool-result continuation.
3. **Cancellation is checked at every await point.** `options.cancel: CancellationToken` is threaded into every async call. On cancellation, the engine emits `Event::Error(CoreError::Cancelled)` and returns. Today's `AbortSignal` pattern gets wrapped in a `CancellationToken` adapter during the migration.
4. **Session state hooks fire at the same points as today.** `before_chat_completion` and `after_chat_completion` continue to exist on `RequestContext`, called from the same places in the same order. The refactor doesn't change their semantics.
5. **Emitter errors don't abort the run.** If the emitter's output destination disconnects (client closes browser tab), the engine keeps running to completion so session state is correctly persisted, but it stops emitting events. The `EmitError::ClientDisconnected` case is special-cased to swallow subsequent emits. Session save + tool execution still happen.
---
## Migration Strategy
This phase is structured as **extract, unify, rewrite frontends** — similar to Phase 1's facade pattern. The old functions stay in place until the new Engine is proven by tests and manual verification.
### Step 1: Create the core types
Add the new files without wiring them into anything:
- `src/engine/mod.rs` — module root
- `src/engine/engine.rs``Engine` struct + `run` method (initially `unimplemented!()`)
- `src/engine/request.rs``RunRequest`, `UserInput`, `RunOptions`, `ContinuationKind`, `RunOutcome`
- `src/engine/command.rs``CoreCommand` enum + sub-enums
- `src/engine/error.rs``CoreError` enum
- `src/engine/emitter.rs``Emitter` trait + `Event` enum + `EmitError`
- `src/engine/emitters/mod.rs` — emitter module
- `src/engine/emitters/null.rs``NullEmitter` (test stub)
- `src/engine/emitters/collecting.rs``CollectingEmitter` (test stub)
- `src/engine/emitters/terminal.rs``TerminalEmitter` (initially `unimplemented!()`)
Register `pub mod engine;` in `src/main.rs`. Code compiles but nothing calls it yet.
**Verification:** `cargo check` clean, `cargo test` passes.
### Step 2: Implement `TerminalEmitter` against existing render code
Before wiring the engine, build the `TerminalEmitter` by wrapping today's `SseHandler` + `markdown_stream` + `raw_stream` + `MarkdownRender` + `Spinner` code. Don't change any of those modules — just construct a `TerminalEmitter` that holds the state they need and forwards `emit(Event::AssistantDelta(...))` into them.
```rust
pub struct TerminalEmitter {
render_state: Mutex<StreamRenderState>,
options: TerminalEmitterOptions,
}
pub struct TerminalEmitterOptions {
pub highlight: bool,
pub theme: Option<String>,
pub verbose_tool_calls: bool,
pub show_spinner: bool,
}
impl TerminalEmitter {
pub fn new_from_app(app: &AppState, working_mode: WorkingMode) -> Self { /* ... */ }
}
```
Implement `Emitter` for it, mapping each `Event` variant to the appropriate crossterm operation:
| Event | TerminalEmitter action |
|---|---|
| `Started` | Start spinner |
| `AssistantDelta(chunk)` | Stop spinner (if first), feed chunk into render state |
| `AssistantMessageEnd { full_text }` | Flush render state, emit trailing newline |
| `ToolCall { name, args }` | Print dimmed `⚙ Using <name>` banner if verbose |
| `ToolResult { .. }` | Print dimmed result summary if verbose |
| `AutoContinueTriggered` | Print yellow `⟳ Continuing (N/M, R todos remaining)` to stderr |
| `SessionCompressing` | Print `Compressing session...` to stderr |
| `SessionCompressed` | Print `Session compressed.` to stderr |
| `SessionAutonamed` | Print `Session auto-named: <name>` to stderr |
| `Info(msg)` | Print to stdout |
| `Warning(msg)` | Print yellow to stderr |
| `Error(e)` | Print red to stderr |
| `Finished` | No-op (ensures trailing newline is flushed) |
**Verification:** write integration tests that construct a `TerminalEmitter`, feed it a sequence of events manually, and compare captured stdout/stderr to golden outputs. Use `assert_cmd` or similar to snapshot the rendered output of each event variant.
### Step 3: Implement `Engine::run` without wiring it
Implement `Engine::run` and `Engine::run_turn` following the pseudocode above. Use the existing helper functions (`before_chat_completion`, `after_chat_completion`, `apply_prelude`, `create_client`, `call_chat_completions`, `call_chat_completions_streaming`, `maybe_compress_session`, `maybe_autoname_session`) unchanged, just called through `ctx` instead of `&GlobalConfig`.
**Implementing `dispatch_command`** is the largest sub-task here because it needs to match all 37 `CoreCommand` variants and invoke the right `ctx` methods. Most variants are straightforward one-liners that call a corresponding method on `RequestContext`. A few need special handling:
- `CoreCommand::UseRole { name, trailing_text }` — activate role, then if `trailing_text` is `Some`, the outer `run` will flow through with the trailing text as `UserInput.text`.
- `CoreCommand::IncludeFiles` — reads files, converts to `FileInput` list, attaches to `ctx`'s next input (or fails if no input is provided).
- `CoreCommand::StarterRun(id)` — looks up the starter text on the active agent, fails if no agent.
- `CoreCommand::Macro` — delegates to `macro_execute`, which may itself call `Engine::run` internally for LLM-triggering macros.
**Verification:** write unit tests for `dispatch_command` using `NullEmitter`. Each test activates a command and asserts the expected state mutation on `ctx`. This is ~37 tests, one per variant, and they catch the bulk of regressions early.
Then write a handful of integration tests for `Engine::run` with `CollectingEmitter`, asserting the expected event sequence for:
- Plain prompt, no tools, streaming
- Plain prompt, no tools, non-streaming
- Prompt that triggers 2 tool calls
- Prompt that triggers auto-continuation (mock the LLM response)
- Prompt on a session that crosses the compression threshold
- Command-only request (`.info`)
- Command + prompt request (`.role explain "..."`)
### Step 4: Wire CLI to `Engine::run`
Replace `main.rs::start_directive` with a thin wrapper:
```rust
async fn start_directive(
app: Arc<AppState>,
ctx: &mut RequestContext,
input_text: String,
files: Vec<String>,
code_mode: bool,
) -> Result<()> {
let engine = Engine::new(app.clone());
let emitter = TerminalEmitter::new_from_app(&app, WorkingMode::Cmd);
let req = RunRequest {
input: Some(UserInput::from_text_and_files(input_text, files)),
command: None,
options: {
let mut o = RunOptions::cli();
o.extract_code = code_mode && !*IS_STDOUT_TERMINAL;
o
},
};
match engine.run(ctx, req, &emitter).await {
Ok(_outcome) => Ok(()),
Err(CoreError::Cancelled) => Ok(()),
Err(e) => Err(e.into()),
}
}
```
**Verification:** manual smoke test. Run `loki "hello"`, `loki --code "write a rust hello world"`, `loki --role explain "what is TCP"`. All should produce identical output to before the change.
### Step 5: Wire REPL to `Engine::run`
Replace `repl/mod.rs::ask` with a wrapper that calls the engine. The REPL's outer loop that reads lines and calls `run_repl_command` stays. `run_repl_command` for non-dot-command lines constructs a `RunRequest { input: Some(...), .. }` and calls `Engine::run`. Dot-commands get parsed into `CoreCommand` and called as `RunRequest { command: Some(...), input: None, .. }` (or with input if they carry trailing text).
```rust
// In Repl:
async fn handle_line(&mut self, line: &str) -> Result<()> {
let req = if let Some(rest) = line.strip_prefix('.') {
parse_dot_command_to_run_request(rest, &self.ctx)?
} else {
RunRequest {
input: Some(UserInput::from_text(line.to_string())),
command: None,
options: RunOptions::repl_turn(),
}
};
match self.engine.run(&mut self.ctx, req, &self.emitter).await {
Ok(_) => Ok(()),
Err(CoreError::Cancelled) => Ok(()),
Err(e) => {
self.emitter.emit(Event::Error(&e)).await.ok();
Ok(())
}
}
}
```
**Verification:** manual smoke test of the REPL. Run through a typical session:
1. `loki` → REPL starts
2. `hello` → plain prompt works
3. `.role explain` → role activates
4. `what is TCP` → responds under the role
5. `.session` → session starts
6. Several messages → conversation continues
7. `.info session` → info prints
8. `.compress session` → compression runs
9. `.agent sisyphus` → agent activates with sub-agents
10. `write a hello world in rust` → tool calls + output
11. `.exit agent` → agent exits, previous session still active
12. `.exit` → REPL exits
Every interaction should behave identically to pre-Phase-2. Any visual difference is a bug.
### Step 6: Delete the old `start_directive` and `ask`
Once CLI and REPL both route through `Engine::run` and all tests/smoke tests pass, delete the old function bodies. Remove any now-unused imports. Run `cargo check` and `cargo test`.
**Verification:** full test suite green, no dead code warnings.
### Step 7: Tidy and document
- Add rustdoc comments on `Engine`, `RunRequest`, `RunOptions`, `Emitter`, `Event`, `CoreCommand`, `CoreError`.
- Add an `examples/` subdirectory under `src/engine/` showing how to call the engine with each emitter.
- Update `docs/AGENTS.md` with a note that CLI now supports auto-continuation (since it's no longer a REPL-only feature).
- Update `docs/REST-API-ARCHITECTURE.md` to remove any "in Phase 2" placeholders.
---
## Risks and Watch Items
| Risk | Severity | Mitigation |
|---|---|---|
| **Terminal rendering regressions** | High | Golden-file snapshot tests for every `Event` variant. Manual smoke tests across all common REPL flows. Keep `TerminalEmitter` as a thin wrapper — no logic changes in the render code itself. |
| **Auto-continuation recursion limits** | Medium | The new `Engine::run` uses `Box::pin` for the auto-continuation recursive call. Verify with a mock LLM that `max_auto_continues = 100` doesn't blow the stack. |
| **Cancellation during tool execution** | Medium | Tool execution currently uses `AbortSignal`; the new path uses `CancellationToken`. Write a shim that translates. Write a test that cancels mid-tool-call and verifies graceful cleanup (no orphaned subprocesses, no leaked file descriptors). |
| **Command parsing fidelity** | Medium | The dot-command parser in today's REPL is hand-written and has edge cases. Port the parsing code verbatim into a dedicated `parse_dot_command_to_run_request` function with unit tests for every edge case found in today's code. |
| **Macro execution recursion** | Medium | `.macro` can invoke LLM calls, which now go through `Engine::run`, which can invoke more macros. Verify there's a recursion depth limit or cycle detection; add one if missing. |
| **Emitter error propagation** | Low | Emitter errors (ClientDisconnected) should NOT abort session save logic. Engine must continue executing after the first `EmitError::ClientDisconnected` — just stop emitting. Write a test that simulates a disconnected emitter mid-response and asserts the session is still correctly persisted. |
| **Spinner interleaving with tool output** | Low | Today's spinner is tightly coupled to the stream handler. If the new order of operations fires a tool call before the spinner is stopped, you'll get garbled output. Test this specifically. |
| **Feature flag: `auto_continue` in CLI** | Low | After Phase 2, CLI *could* support auto-continuation but it's not exposed. Decision: leave it off by default in `RunOptions::cli()`, add a `--auto-continue` flag in a separate follow-up if desired. Don't sneak behavior changes into this refactor. |
---
## What Phase 2 Does NOT Do
- **No new features.** Everything that worked before works the same way after.
- **No API server.** `JsonEmitter` and `SseEmitter` are placeholders — Phase 4 implements them.
- **No `SessionStore` abstraction.** That's Phase 3.
- **No `ToolScope` unification.** That landed in Phase 1 Step 6.5.
- **No changes to LLM client code.** `call_chat_completions` and `call_chat_completions_streaming` keep their existing signatures.
- **No MCP factory pooling.** That's Phase 5.
- **No dot-command syntax changes.** The REPL still accepts exactly the same dot-commands; they just parse into `CoreCommand` instead of being hand-dispatched in `run_repl_command`.
The sole goal of Phase 2 is: **extract the pipeline into Engine::run, route CLI and REPL through it, and prove via tests and smoke tests that nothing regressed.**
---
## Entry Criteria (from Phase 1)
Before starting Phase 2, Phase 1 must be complete:
- [ ] `GlobalConfig` type alias is removed
- [ ] `AppState` and `RequestContext` are the only state holders
- [ ] All 91 callsites in the original migration table have been updated
- [ ] `cargo test` passes with no `Config`-based tests remaining
- [ ] CLI and REPL manual smoke tests pass identically to pre-Phase-1
## Exit Criteria (Phase 2 complete)
- [ ] `src/engine/` module exists with Engine, Emitter, Event, CoreCommand, RunRequest, RunOutcome, CoreError
- [ ] `TerminalEmitter` implemented and wrapping all existing render paths
- [ ] `NullEmitter` and `CollectingEmitter` implemented
- [ ] `start_directive` in main.rs is a thin wrapper around `Engine::run`
- [ ] REPL's per-line handler routes through `Engine::run`
- [ ] All 37 `CoreCommand` variants implemented with unit tests
- [ ] Integration tests for the 7 engine scenarios listed in Step 3
- [ ] Manual smoke tests for CLI and REPL match pre-Phase-2 behavior
- [ ] `cargo check`, `cargo test`, `cargo clippy` all clean
- [ ] Phase 3 (SessionStore abstraction) can begin
@@ -0,0 +1,607 @@
# Phase 3 Implementation Plan: SessionStore Abstraction
## Overview
Phase 3 extracts session persistence behind a trait so that CLI, REPL, and the future API server all resolve sessions through the same interface. The file-based YAML storage that exists today remains the only implementation in Phase 3 — no database, no schema migration, no new on-disk format. What changes is that session identity becomes **UUID-primary with optional name-based aliases**, direct `std::fs::write` calls disappear from `Session::save()`, and concurrent access to the same session is properly serialized.
After Phase 3, Phase 4 (REST API) can plug in without touching any persistence code: `POST /v1/sessions` returns a UUID, subsequent requests address sessions by that UUID, and CLI/REPL users continue typing `.session my-project` without noticing the internal change.
**Estimated effort:** ~35 days
**Risk:** Low. Storage semantics don't change; we're re-shaping the API surface around existing YAML files.
**Depends on:** Phase 1 complete, Phase 2 complete (Engine needs to call through the new store, not raw `Session::load`).
---
## Why This Phase Exists
Today's `Session::load()` and `Session::save()` embed the file layout, the filename-is-the-identity assumption, and the absence of concurrency control directly in the type. Three things break when you try to run this in a multi-tenant server:
1. **No UUID identity.** Two API clients both start a "project" session and collide on the filename. You can't safely let clients name sessions freely.
2. **No concurrency control.** Two concurrent requests to the same session do `load → mutate → save` with no coordination. The later save clobbers the earlier one's changes.
3. **No abstraction seam.** Every callsite computes paths itself via `Config::session_file(name)` and calls `Session::load()` / `.save()` directly. There's no single place to swap in alternate storage, add caching, or instrument persistence.
Phase 3 fixes all three without breaking anything users currently do.
---
## The Architecture After Phase 3
```
┌────────┐ ┌────────┐ ┌────────┐
│ CLI │ │ REPL │ │ API │ (Phase 4)
└───┬────┘ └───┬────┘ └───┬────┘
└──────────┼──────────┘
┌──────────────────────┐
│ Engine │
└──────────┬───────────┘
┌──────────────────────┐
│ SessionStore trait │
└──────────┬───────────┘
┌──────────────────────┐
│ FileSessionStore │ (Phase 3: the only impl)
│ — UUID primary │
│ — name alias index │
│ — per-session mutex │
│ — atomic writes │
└──────────┬───────────┘
~/.config/loki/sessions/
by-id/<uuid>/state.yaml
by-name/<alias> → <uuid> (text file containing the UUID)
agents/<agent>/sessions/
by-id/<uuid>/state.yaml
by-name/<alias> → <uuid>
```
---
## Core Types
### `SessionId`
```rust
#[derive(Copy, Clone, Eq, PartialEq, Hash, Debug, Serialize, Deserialize)]
pub struct SessionId(Uuid);
impl SessionId {
pub fn new() -> Self { Self(Uuid::new_v4()) }
pub fn as_uuid(&self) -> Uuid { self.0 }
pub fn to_string(&self) -> String { self.0.to_string() }
pub fn parse(s: &str) -> Result<Self, SessionIdError> { /* ... */ }
}
```
UUID v4 by default. Newtype so we can't accidentally pass arbitrary strings where a session ID is expected, and so the on-disk format can evolve without breaking callers.
### `SessionAlias`
```rust
#[derive(Clone, Eq, PartialEq, Hash, Debug)]
pub struct SessionAlias(String);
impl SessionAlias {
pub fn new(s: impl Into<String>) -> Result<Self, AliasError>;
pub fn as_str(&self) -> &str { &self.0 }
}
```
Wraps the human-readable names users type in `.session my-project`. Validation rejects path traversal (`..`), slashes, null bytes, and anything that would produce an invalid filename. This is the CLI/REPL compatibility layer — existing `sessions/my-project.yaml` files continue to work, the alias system just maps them to auto-generated UUIDs on first access.
### `SessionHandle`
```rust
pub struct SessionHandle {
id: SessionId,
alias: Option<SessionAlias>,
is_agent: Option<String>,
state: Arc<tokio::sync::Mutex<Session>>,
store: Arc<dyn SessionStore>,
dirty: Arc<AtomicBool>,
}
impl SessionHandle {
pub fn id(&self) -> SessionId { self.id }
pub fn alias(&self) -> Option<&SessionAlias> { self.alias.as_ref() }
pub async fn lock(&self) -> SessionGuard<'_>;
pub fn mark_dirty(&self);
pub async fn save(&self) -> Result<(), StoreError>;
pub async fn rename(&mut self, new_alias: SessionAlias) -> Result<(), StoreError>;
}
pub struct SessionGuard<'a> {
session: MutexGuard<'a, Session>,
handle: &'a SessionHandle,
}
impl SessionGuard<'_> {
pub fn get(&self) -> &Session { &self.session }
pub fn get_mut(&mut self) -> &mut Session {
self.handle.mark_dirty();
&mut self.session
}
}
```
A `SessionHandle` is what callers pass around. It wraps:
- The stable `SessionId` (never changes after creation)
- An optional `SessionAlias` (can be renamed; users see this in `.info session`)
- An optional `is_agent` marker so the store knows which directory to read/write
- A shared `Arc<Mutex<Session>>` that serializes access within the process
- A backpointer to the store so `save()`, `rename()`, etc. work without the caller knowing the storage type
- A dirty flag that auto-sets on `get_mut()` and clears after successful save
The `lock()` / `SessionGuard` pattern is important: it makes the "you must lock before touching state" rule compiler-enforced. Today's code mutates `Config.session` freely because the whole `Config` is behind an `RwLock`. After Phase 3, mutating a session requires going through `handle.lock().await.get_mut()`, which acquires the per-session mutex. Two concurrent requests to the same session serialize automatically.
### `SessionStore` trait
```rust
#[async_trait]
pub trait SessionStore: Send + Sync {
/// Create a new session. If `alias` is provided, register it in the
/// alias index. Fails with AliasInUse if the alias already exists.
async fn create(
&self,
agent: Option<&str>,
alias: Option<SessionAlias>,
initial: Session,
) -> Result<SessionHandle, StoreError>;
/// Open an existing session by UUID.
async fn open(
&self,
agent: Option<&str>,
id: SessionId,
) -> Result<SessionHandle, StoreError>;
/// Open an existing session by alias, or create it if it doesn't exist.
/// This is the CLI/REPL compatibility path.
async fn open_or_create_by_alias(
&self,
agent: Option<&str>,
alias: SessionAlias,
initial_factory: impl FnOnce() -> Session + Send,
) -> Result<SessionHandle, StoreError>;
/// Resolve an alias to its UUID without loading the session.
async fn resolve_alias(
&self,
agent: Option<&str>,
alias: &SessionAlias,
) -> Result<Option<SessionId>, StoreError>;
/// Persist the current in-memory state of a handle back to storage.
/// Atomically — no torn writes.
async fn save(&self, handle: &SessionHandle) -> Result<(), StoreError>;
/// Rename a session's alias. The UUID and session state are unchanged.
async fn rename(
&self,
handle: &SessionHandle,
new_alias: SessionAlias,
) -> Result<(), StoreError>;
/// Delete a session permanently. Both the state file and any alias
/// pointing at it are removed.
async fn delete(
&self,
agent: Option<&str>,
id: SessionId,
) -> Result<(), StoreError>;
/// List all sessions in a scope (global or per-agent). Returns UUIDs
/// paired with their aliases if any.
async fn list(
&self,
agent: Option<&str>,
) -> Result<Vec<SessionMeta>, StoreError>;
}
pub struct SessionMeta {
pub id: SessionId,
pub alias: Option<SessionAlias>,
pub last_modified: SystemTime,
pub is_autoname: bool,
}
pub enum StoreError {
NotFound { id: Option<SessionId>, alias: Option<String> },
AliasInUse(String),
InvalidAlias(String),
Io(std::io::Error),
Serde(serde_yaml::Error),
Concurrent, // best-effort optimistic check
Other(anyhow::Error),
}
```
### `FileSessionStore`
```rust
pub struct FileSessionStore {
root: PathBuf, // ~/.config/loki/
agents_root: PathBuf, // ~/.config/loki/agents/
handles: Mutex<HashMap<(Option<String>, SessionId), Weak<Mutex<Session>>>>,
}
```
The `handles` map is the in-process cache that enforces "one `Arc<Mutex<Session>>` per live session per process." If two callers `open()` the same session, they get two `SessionHandle`s pointing at the same underlying mutex, so their locks serialize. When the last handle drops, the weak ref fails on the next lookup and the store re-reads from disk.
---
## The On-Disk Layout
### New layout (Phase 3 target)
```
~/.config/loki/sessions/
by-id/
<uuid>/
state.yaml
by-name/
my-project → text file containing the UUID
another-chat → text file containing the UUID
```
Agent sessions mirror this inside each agent's directory:
```
~/.config/loki/agents/sisyphus/sessions/
by-id/
<uuid>/
state.yaml
by-name/
my-project → UUID
```
### Backward compatibility
The migration is lazy and non-destructive. On `FileSessionStore` startup, we do NOT rewrite the directory. On the first `open_or_create_by_alias("my-project")` call, the store checks:
1. **New layout hit:** is there a `by-name/my-project` alias file? Read the UUID, open `by-id/<uuid>/state.yaml`.
2. **Legacy layout hit:** is there a `sessions/my-project.yaml`? Generate a fresh UUID, create `by-id/<uuid>/state.yaml` from the legacy content (atomic copy), write `by-name/my-project` pointing to the new UUID, and leave the legacy file in place. The legacy file becomes stale but untouched.
3. **Neither:** create fresh.
This means users upgrading from pre-Phase-3 builds never lose data, and they can downgrade during the migration window (their old files are still readable by the old code because we haven't deleted them). A `loki migrate sessions` command can later do a clean sweep to remove the legacy files — but that's an operational convenience, not a requirement of Phase 3.
**Deleting a migrated session** (the `.delete` REPL command) also deletes the legacy file if it still exists, so users don't see orphan entries in `list_sessions()`.
**Autoname temp sessions** (today: `sessions/_/20231201T123456-autoname.yaml`) map cleanly to the new layout — they get UUIDs like any other session, and their alias is the generated `20231201T123456-autoname` string. The `_/` prefix from today's path becomes a flag on `SessionMeta::is_autoname: true` set by the store when it recognizes the naming pattern during migration.
### Atomic writes
Today's `Session::save()` is `std::fs::write(path, yaml)` — if the process dies mid-write, you get a truncated YAML file that can't be loaded. The new `FileSessionStore::save()` uses the standard tempfile-and-rename pattern:
```rust
async fn save(&self, handle: &SessionHandle) -> Result<(), StoreError> {
let session = handle.state.lock().await;
let yaml = serde_yaml::to_string(&*session)?;
let target = self.state_path(handle.is_agent.as_deref(), handle.id);
let tmp = target.with_extension("yaml.tmp");
tokio::fs::write(&tmp, yaml).await?;
tokio::fs::rename(&tmp, &target).await?;
handle.dirty.store(false, Ordering::Release);
Ok(())
}
```
`rename` is atomic on POSIX filesystems and on Windows NTFS (via `MoveFileEx`). Either the old content or the new content is visible to readers; never a half-written file.
---
## Concurrency Model
Three layers, each with a clear responsibility:
1. **Process-level: per-session `Arc<Mutex<Session>>`.** Two handles to the same session share one mutex. Inside one process, concurrent access to the same session is serialized automatically. This is enough for CLI (single request) and REPL (single user, but multiple async tasks like background compression).
2. **Inter-process: filesystem rename atomicity.** Two separate Loki processes (unlikely today but possible for someone running CLI and REPL simultaneously on the same state) can't corrupt files because writes go through tempfile+rename. The later writer wins cleanly; the earlier writer's changes are lost but the file is always readable.
3. **Optimistic conflict detection (optional, Phase 5+):** If we later decide to add "you edited this session somewhere else, please reload" UX, we can add an `mtime` check on load/save and surface `StoreError::Concurrent` when the on-disk mtime doesn't match the value we read at `open()` time. This is deliberately not built in Phase 3 — it's a UX improvement for later, not a correctness requirement.
For Phase 3, layers 1 and 2 together are sufficient for everything up through "many concurrent API sessions, each addressing different UUIDs." The one gap they don't cover is "multiple API requests on the same session UUID at the same time" — but the per-session mutex in layer 1 handles that by serializing them, which is the desired behavior. The second request waits its turn and sees the first request's updates.
---
## Engine and Callsite Changes
### Before Phase 3
```rust
// In REPL command handler:
Config::use_session_safely(&config, Some("my-project"), abort_signal)?;
// later:
config.write().session.as_mut().unwrap().add_message(...);
// later:
Config::save_session_safely(&config, None)?;
```
### After Phase 3
```rust
// In CoreCommand::UseSession handler inside Engine::dispatch_command:
let alias = SessionAlias::new("my-project")?;
let handle = self.app.sessions.open_or_create_by_alias(
ctx.agent_name(),
alias,
|| Session::new_default(ctx.model_id(), ctx.role_name()),
).await?;
ctx.session = Some(handle);
// later, during the chat loop:
{
let mut guard = handle.lock().await;
guard.get_mut().add_message(input, output);
}
handle.save().await?; // fires when the turn completes
```
The `RequestContext.session: Option<Session>` field becomes `RequestContext.session: Option<SessionHandle>`. All 13 session-touching callsites from the explore get rewritten to go through the handle instead of direct access.
### The 13 callsites and their new shapes
| Current location | Current call | New call |
|---|---|---|
| `Config::use_session` | `Session::load` or `Session::new` | `store.open_or_create_by_alias(...)` |
| `Config::use_session_safely` | take/replace pattern on `config.session` | `ctx.session = Some(handle)` |
| `Config::exit_session` | `session.exit()` (maybe saves) | `if ctx.session.dirty() { handle.save().await? }; ctx.session = None` |
| `Config::empty_session` | `session.clear_messages()` | `handle.lock().await.get_mut().clear_messages()` |
| `Config::save_session` | `session.save()` with name logic | `handle.rename(alias)?; handle.save().await?` |
| `Config::compress_session` | mutates session, relies on dirty flag | `handle.lock().await.get_mut().compress(...)?; handle.save().await?` |
| `Config::maybe_autoname_session` | spawns task, mutates session | same, but via handle |
| `Config::delete` (kind="session") | `remove_file` on path | `store.delete(agent, id).await?` |
| `Config::after_chat_completion` | `session.add_message(...)` | via handle |
| `Config::apply_prelude` | may `use_session` | via store |
| `Agent::init` / `use_agent` | may load agent session | via store, with `agent=Some(name)` |
| `.session` REPL command | via `use_session_safely` | via store |
| `.delete session` REPL command | via `Config::delete` | via store |
Most of these are one-liner changes since the store's API mirrors the semantics of today's methods. The subtle ones are:
- **`exit_session`** has "save if dirty and `save_session != Some(false)`" logic plus "prompt for name if temp session" UX. The prompt lives in the REPL layer (it calls `inquire::Text`), not in the store. After the refactor, the REPL reads the dirty flag from the handle, prompts for a name if needed, calls `handle.rename()` if the user provided one, then calls `handle.save()`.
- **`compress_session`** runs asynchronously today — it spawns a task that holds a clone of `GlobalConfig` and writes back via `config.write()`. After the refactor, the task holds an `Arc<SessionHandle>` and does `handle.lock().await.get_mut().compress(...)` followed by `handle.save().await`. The per-session mutex prevents the compression task from clobbering concurrent turn writes.
- **`maybe_autoname_session`** is the same story as compression: spawn task, mutate through handle, save through store.
---
## Migration Strategy
### Step 1: Create the types without wiring
Add new files:
- `src/session/mod.rs` — module root
- `src/session/id.rs``SessionId`, `SessionAlias`
- `src/session/store.rs``SessionStore` trait, `StoreError`, `SessionMeta`
- `src/session/handle.rs``SessionHandle`, `SessionGuard`
- `src/session/file_store.rs``FileSessionStore` implementation
Move the existing `Session` struct from `src/config/session.rs` to `src/session/session.rs`. Keep the pub re-export at `src/config::Session` so no external callers break during the migration. The struct itself is unchanged — same fields, same YAML format, same methods. This is purely a module reorganization.
Register `pub mod session;` in `src/main.rs` and add `pub sessions: Arc<dyn SessionStore>` to `AppState`. Initialize it in `AppState::init()` with `FileSessionStore::new(config_dir)`.
**Verification:** `cargo check` clean, `cargo test` passes. Nothing uses the new types yet.
### Step 2: Implement `FileSessionStore` against the new layout
Build the file-based implementation:
- `state_path(agent, id) → ~/.config/loki/[agents/<agent>/]sessions/by-id/<uuid>/state.yaml`
- `alias_path(agent, alias) → ~/.config/loki/[agents/<agent>/]sessions/by-name/<alias>`
- `legacy_path(agent, alias) → ~/.config/loki/[agents/<agent>/]sessions/<alias>.yaml`
Implement `create`, `open`, `open_or_create_by_alias`, `resolve_alias`, `save`, `rename`, `delete`, `list`. The `open_or_create_by_alias` method is the most complex — it has the lazy-migration logic that checks new layout, then legacy layout, then falls through to creation.
**Unit tests for `FileSessionStore`:**
- Create + open roundtrip
- Create with alias + open_or_create_by_alias finds it
- Lazy migration from legacy `.yaml` file
- Delete removes both new and legacy paths
- Rename updates alias index without touching state file
- List returns both new-layout and legacy-layout sessions
- Atomic write: kill the process mid-write (simulated by injected failure) and verify no torn YAML
These tests use `tempfile::TempDir` so they don't touch the real config directory.
**Verification:** Unit tests pass. `cargo check` clean.
### Step 3: Add `SessionHandle` and integrate with `RequestContext`
Change `RequestContext.session` from `Option<Session>` to `Option<SessionHandle>`. This is a mass rename across the codebase — every callsite that does `ctx.session.as_ref()` needs to become `ctx.session.as_ref().map(|h| h.lock().await.get())` or similar.
The cleanest way to minimize the blast radius is to add a thin compatibility layer on `RequestContext`:
```rust
impl RequestContext {
pub async fn session_read<F, R>(&self, f: F) -> Option<R>
where F: FnOnce(&Session) -> R {
let handle = self.session.as_ref()?;
let guard = handle.lock().await;
Some(f(guard.get()))
}
pub async fn session_write<F, R>(&mut self, f: F) -> Option<R>
where F: FnOnce(&mut Session) -> R {
let handle = self.session.as_ref()?;
let mut guard = handle.lock().await;
Some(f(guard.get_mut()))
}
}
```
Most callsites become `ctx.session_read(|s| s.model_id.clone()).await` or `ctx.session_write(|s| s.add_message(...)).await`. A few that need to hold the guard across await points (e.g., compression) use `handle.lock()` directly.
**Verification:** `cargo check` clean. Existing REPL functions still work because the old method names get forwarded through the compatibility helpers.
### Step 4: Rewrite the 13 session callsites to use the store
Go through each callsite in the inventory table and rewrite it:
1. `Config::use_session``Engine::dispatch_command` for `CoreCommand::UseSession`
2. `Config::use_session_safely` → same, with extra ctx reset logic
3. `Config::exit_session``Engine::dispatch_command` for `CoreCommand::ExitSession`
4. ... and so on
Where possible, move the logic INTO `Engine::dispatch_command` rather than leaving it on `Config`. This is consistent with Phase 2's direction — core logic lives in the engine, not on state containers.
For each rewrite:
- Delete the old method from `Config`
- Add the new handler in `Engine::dispatch_command`
- Update any callers that still reference the old method name
- Run `cargo check` after each file to catch issues incrementally
**Verification:** After each rewrite, `cargo check` + the relevant integration tests from Phase 2. The Phase 2 `CollectingEmitter` tests for session-touching scenarios are especially important here — they're the regression net.
### Step 5: Remove the compatibility helpers from `RequestContext`
Once all 13 callsites are rewritten, the `session_read` / `session_write` helpers are only used by the old session methods we just deleted. Remove them. Any remaining compile errors point at callsites we missed.
**Verification:** `cargo check` clean, all of Phase 2's tests still pass, plus the new `FileSessionStore` unit tests.
### Step 6: Add the integration tests for concurrent access
These are the tests that prove Phase 3 actually solved the concurrency problem:
```rust
#[tokio::test]
async fn concurrent_opens_share_one_mutex() {
let store = FileSessionStore::new(tempdir);
let id = SessionId::new();
// ... create initial session ...
let h1 = store.open(None, id).await.unwrap();
let h2 = store.open(None, id).await.unwrap();
// Both handles should point at the same Arc<Mutex<Session>>
let lock1 = h1.lock().await;
// Try to lock h2 — should block
let try_lock = tokio::time::timeout(
Duration::from_millis(50),
h2.lock(),
).await;
assert!(try_lock.is_err(), "h2 should block while h1 holds the lock");
drop(lock1);
let _lock2 = h2.lock().await;
}
#[tokio::test]
async fn concurrent_writes_serialize_without_loss() {
let store = Arc::new(FileSessionStore::new(tempdir));
let id = create_initial_session(&store).await;
let tasks: Vec<_> = (0..100).map(|i| {
let store = store.clone();
tokio::spawn(async move {
let handle = store.open(None, id).await.unwrap();
{
let mut guard = handle.lock().await;
guard.get_mut().add_message(
Input::from_str(format!("msg-{i}")),
format!("reply-{i}"),
);
}
handle.save().await.unwrap();
})
}).collect();
for t in tasks { t.await.unwrap(); }
let handle = store.open(None, id).await.unwrap();
let guard = handle.lock().await;
assert_eq!(guard.get().messages.len(), 200); // 100 user + 100 assistant
}
```
The second test specifically verifies that the per-session mutex serialization prevents lost updates — the flaw in today's code.
**Verification:** Both tests pass. `cargo test` green overall.
### Step 7: Legacy migration smoke test
Copy a real user's `sessions/my-project.yaml` file into a test fixture directory. Run `FileSessionStore::open_or_create_by_alias("my-project")` and assert:
- A new `by-id/<uuid>/state.yaml` exists with identical content
- A new `by-name/my-project` file exists containing the UUID
- The original `sessions/my-project.yaml` is still there, untouched
- A second `open_or_create_by_alias("my-project")` call reuses the same UUID (idempotent)
**Verification:** Test passes with real fixture data including a session that has compressed messages and agent variables.
### Step 8: Manual smoke test
Run through a full REPL session covering every session-touching command:
1. `loki` → REPL starts, `.session foo` → new session created, check `by-id/` and `by-name/foo` exist
2. Several messages → check `state.yaml` updates atomically
3. `.save session bar` → check alias renamed, UUID unchanged
4. `.empty session` → messages cleared, file still exists
5. `.exit session` → session closed
6. `loki --session bar` from command line → same UUID resumes
7. `.delete` then choose session → both new and legacy files gone
8. Agent with `.agent sisyphus my-work` → agent-scoped session in `agents/sisyphus/sessions/`
9. Auto-continuation in an agent → compression fires, concurrent writes serialize cleanly
Every interaction should behave identically to pre-Phase-3.
---
## Risks and Watch Items
| Risk | Severity | Mitigation |
|---|---|---|
| **Legacy file discovery** | Medium | The migration path must handle every legacy layout: `sessions/<name>.yaml`, `sessions/_/<timestamp>-<autoname>.yaml`, and agent-scoped `agents/<agent>/sessions/<name>.yaml`. Write a fixture test for each variant. |
| **Alias collisions during migration** | Medium | If two processes simultaneously migrate the same legacy session, they could create two different UUIDs. Mitigation: the `open_or_create_by_alias` path should acquire a file lock on the alias file itself during creation, not just rely on the store's in-memory map. |
| **`RequestContext.session` type change blast radius** | Medium | Using the compatibility helpers (`session_read` / `session_write`) in Step 3 contains the blast radius. Only remove them in Step 5 once everything compiles. |
| **Session::save deadlock via re-entry** | Medium | If `Session::compress()` or `add_message()` internally trigger anything that tries to re-lock the session's mutex, we get a deadlock. Audit every `Session` method called inside a `guard.get_mut()` scope to make sure none of them take the lock again. Document the invariant in `SessionHandle` rustdoc. |
| **Tempfile cleanup on crash** | Low | If the process dies after writing `.yaml.tmp` but before the rename, we leave a stray file. On startup, `FileSessionStore::new` should sweep `by-id/*/state.yaml.tmp` files and remove them. |
| **Alias index corruption** | Low | If `by-name/foo` contains garbage (not a valid UUID), treat it as a missing alias and log a warning. Don't crash the process. |
| **Serde compatibility with old files** | Low | The `Session` struct's serde shape doesn't change in Phase 3, so old YAML files deserialize identically. Verify with a fixture test that includes every optional field set. |
| **CLI `--session <uuid>` vs `--session <alias>` ambiguity** | Low | `SessionId::parse` recognizes UUID format; fall back to treating the argument as an alias if parsing fails. Document in `--help`. |
| **Concurrent delete while handle held** | Low | If one task is using a handle while another deletes the session, the first task's save will fail (file missing). This is acceptable behavior — log a warning and return `StoreError::NotFound`. Tests should cover this. |
---
## What Phase 3 Does NOT Do
- **No schema migration.** YAML format stays identical. `Session` struct unchanged.
- **No database.** `FileSessionStore` is the only implementation.
- **No session TTL / eviction.** Sessions live until explicitly deleted.
- **No cross-process locking.** Two Loki processes can still race, but writes are atomic so files never corrupt.
- **No session encryption.** Vault handles secrets; sessions are plain YAML.
- **No session sharing between users.** Each process has its own config directory.
- **No optimistic concurrency (mtime check).** Deferred to Phase 5+ as a UX enhancement.
- **No session versioning / rollback.** Deferred.
- **No changes to `Session::build_messages()`, compression logic, or autoname generation.** The behaviors that read/mutate `Session` stay the same — only how they're reached changes.
The sole goal of Phase 3 is: **route all session persistence through a `SessionStore` trait with UUID-primary identity, lazy migration from the legacy layout, per-session mutex serialization, and atomic writes.**
---
## Entry Criteria (from Phase 2)
- [ ] `Engine::run` is the only path to the LLM pipeline
- [ ] `CoreCommand::UseSession`, `ExitSession`, `EmptySession`, `CompressSession`, `SaveSession`, `EditSession` are all implemented and tested
- [ ] `CollectingEmitter` integration tests cover session-touching scenarios
- [ ] `cargo check`, `cargo test`, `cargo clippy` all clean
- [ ] CLI and REPL manual smoke tests match pre-Phase-2 behavior
## Exit Criteria (Phase 3 complete)
- [ ] `src/session/` module exists with `SessionStore` trait, `FileSessionStore`, `SessionId`, `SessionAlias`, `SessionHandle`, `SessionGuard`
- [ ] `AppState.sessions: Arc<dyn SessionStore>` is wired in
- [ ] `RequestContext.session: Option<SessionHandle>` (not `Option<Session>`)
- [ ] All 13 session callsites go through the store; no direct `Session::load` or `Session::save` calls remain outside `FileSessionStore`
- [ ] Legacy layout files are lazily migrated on first access
- [ ] New layout (`by-id/<uuid>/state.yaml` + `by-name/<alias>`) is the canonical on-disk format for all new sessions
- [ ] Atomic writes via tempfile+rename
- [ ] Per-session mutex serialization verified by concurrent-write integration tests
- [ ] Legacy fixture test passes (existing user data still loads)
- [ ] Full REPL smoke test covers every session command
- [ ] `cargo check`, `cargo test`, `cargo clippy` all clean
- [ ] Phase 4 (REST API) can address sessions by UUID without touching persistence code
@@ -0,0 +1,824 @@
# Phase 4 Implementation Plan: REST API Server
## Overview
Phase 4 introduces a `--serve` mode that starts an HTTP server exposing Loki's functionality as a RESTful API. The server is a thin axum layer on top of `Engine::run()` — most of the work is mapping HTTP requests into `RunRequest`s, mapping `Emitter` events into JSON or Server-Sent Events, and providing baseline auth, cancellation, and graceful shutdown. By the end of this phase, Loki can run as a backend service that multiple clients can talk to simultaneously, each with their own session.
**Estimated effort:** ~12 weeks
**Risk:** Lowmedium. The core pipeline (Engine) is unchanged; the risk is in the HTTP layer's correctness around streaming, cancellation, and concurrent session handling.
**Depends on:** Phases 13 complete. `SessionStore` with UUID identity, `Engine::run()` as the pipeline entrypoint, `Emitter` trait with working `TerminalEmitter` + `CollectingEmitter`.
---
## Why Phase 4 Exists
After Phase 3, everything the API server needs is already in place:
- `AppState` is a clonable `Arc` holding global services, safe to share across concurrent HTTP handlers.
- `RequestContext` is per-request mutable state with no hidden global singletons.
- `Engine::run()` is the single pipeline entrypoint that works for any frontend.
- `SessionStore` serves sessions by UUID with per-session mutex serialization.
- `Emitter` trait decouples output from destination.
What's missing is the last mile: accepting HTTP requests, routing them to `Engine::run()`, and turning `Event`s into HTTP responses. This phase builds exactly that.
The mental model is "Loki as a backend service." A frontend developer should be able to `curl -X POST http://localhost:3400/v1/completions -d '{"prompt":"hello"}'` and get a sensible response. A JavaScript app should be able to open an EventSource to `/v1/sessions/:id/completions?stream=true` and get live token streaming. An automation script should be able to maintain session state across many requests by passing back the same session UUID.
---
## The Architecture After Phase 4
```
┌─────────────────────────────────────────────┐
│ loki --serve --port 3400 │
│ ┌───────────────────────────────────────┐ │
│ │ axum Router │ │
│ │ ┌─────────────┐ ┌────────────────┐ │ │
│ │ │ Middleware│ │ Handlers │ │ │
│ │ │ - Auth │ │ /v1/* │ │ │
│ │ │ - Trace │ │ │ │ │
│ │ │ - CORS │ │ │ │ │
│ │ │ - Limit │ │ │ │ │
│ │ └──────┬──────┘ └────────┬───────┘ │ │
│ └─────────┼──────────────────┼──────────┘ │
│ ▼ ▼ │
│ ┌───────────────────────────────────┐ │
│ │ Arc<AppState> (shared) │ │
│ └────────────────┬──────────────────┘ │
│ ▼ │
│ ┌───────────────────────────────────┐ │
│ │ Per-request RequestContext + │ │
│ │ JsonEmitter or SseEmitter │ │
│ └────────────────┬──────────────────┘ │
│ ▼ │
│ ┌───────────────────────────────────┐ │
│ │ Engine::run() │ │
│ └───────────────────────────────────┘ │
└─────────────────────────────────────────────┘
```
---
## API Surface
### Versioning
All endpoints live under `/v1/`. The version prefix lets us ship breaking changes later without breaking existing clients. `/v2/` endpoints can coexist with `/v1/` indefinitely.
### Endpoint summary
```
Authentication
POST /v1/auth/check # validate API key, returns subject info
Metadata
GET /v1/models # list available LLM models
GET /v1/agents # list installed agents
GET /v1/roles # list installed roles
GET /v1/rags # list standalone RAGs
GET /v1/info # server build info, health
One-shot completions
POST /v1/completions # stateless completion (no session)
Sessions
POST /v1/sessions # create a new session (returns UUID)
GET /v1/sessions # list sessions visible to this caller
GET /v1/sessions/:id # get session metadata + message history
DELETE /v1/sessions/:id # delete a session
POST /v1/sessions/:id/completions # send a prompt into a session
POST /v1/sessions/:id/compress # manually trigger compression
POST /v1/sessions/:id/empty # clear messages (keep session record)
Role attachment
POST /v1/sessions/:id/role # activate role on session
DELETE /v1/sessions/:id/role # detach role
Agent attachment
POST /v1/sessions/:id/agent # activate agent on session
DELETE /v1/sessions/:id/agent # deactivate agent
RAG attachment
POST /v1/sessions/:id/rag # attach standalone RAG
DELETE /v1/sessions/:id/rag # detach RAG
POST /v1/rags/:name/rebuild # rebuild a RAG index
```
### Request/response shapes
**One-shot completion:**
```
POST /v1/completions
Content-Type: application/json
Authorization: Bearer <api-key>
{
"prompt": "Explain TCP handshake",
"model": "openai:gpt-4o", // optional: overrides default
"role": "explain", // optional: apply role for this one request
"agent": "oracle", // optional: run through an agent (no session retention)
"stream": false, // optional: SSE vs JSON
"files": [ // optional: file attachments
{"path": "/abs/path/doc.pdf"},
{"url": "https://example.com/x"}
],
"temperature": 0.7, // optional override
"auto_continue": false // optional: enable agent auto-continuation
}
```
**Non-streaming response (default):**
```json
{
"request_id": "7a1b...",
"session_id": null,
"final_message": "The TCP handshake is a three-way protocol ...",
"tool_calls": [
{"id": "tc_1", "name": "web_search", "args": "...", "result": "...", "is_error": false}
],
"turns": 2,
"compressed": false,
"auto_continued": 0,
"usage": {
"input_tokens": 120,
"output_tokens": 458
}
}
```
**Streaming response** (`Accept: text/event-stream` or `stream: true`):
```
event: started
data: {"request_id":"7a1b...","session_id":null}
event: assistant_delta
data: {"text":"The TCP "}
event: assistant_delta
data: {"text":"handshake is "}
event: tool_call
data: {"id":"tc_1","name":"web_search","args":"..."}
event: tool_result
data: {"id":"tc_1","name":"web_search","result":"...","is_error":false}
event: assistant_delta
data: {"text":" a three-way protocol..."}
event: finished
data: {"outcome":{"turns":2,"tool_calls":1,"compressed":false}}
```
**Create session:**
```
POST /v1/sessions
{
"alias": "my-project", // optional; UUID-only if omitted
"role": "explain", // optional: pre-attach a role
"agent": "sisyphus", // optional: pre-attach an agent
"rag": "mydocs", // optional: pre-attach a RAG
"model": "openai:gpt-4o" // optional: pre-set model
}
```
**Response:**
```json
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"alias": "my-project",
"agent": "sisyphus",
"role": "explain",
"rag": "mydocs",
"model": "openai:gpt-4o",
"created_at": "2026-04-10T15:32:11Z"
}
```
**Session completion:**
```
POST /v1/sessions/550e8400-.../completions
{
"prompt": "what was the bug we found yesterday?",
"stream": true,
"auto_continue": true
}
```
Returns the same shape as `/v1/completions`, but with `session_id` populated and agent runtime state preserved across calls.
**Error responses** (standard across all endpoints):
```json
{
"error": {
"code": "session_not_found",
"message": "No session with id 550e8400-...",
"request_id": "7a1b..."
}
}
```
HTTP status codes map from `CoreError::http_status()` (defined in Phase 2):
- `InvalidRequest` → 400
- `Unauthorized` → 401
- `NotFound` → 404
- `InvalidState` → 409 (expected state doesn't match)
- `Cancelled` → 499 (client-closed request, borrowed from nginx)
- `ProviderError` → 502 (upstream LLM failed)
- `ToolError` → 500
- `Other` → 500
---
## Core Types
### `ApiConfig`
```rust
#[derive(Clone, Deserialize)]
pub struct ApiConfig {
pub enabled: bool,
pub listen_addr: SocketAddr,
pub auth: AuthConfig,
pub cors: CorsConfig,
pub limits: LimitsConfig,
pub request_timeout_seconds: u64,
pub shutdown_grace_seconds: u64,
}
#[derive(Clone, Deserialize)]
pub enum AuthConfig {
Disabled, // dev only
StaticKeys { keys: Vec<AuthKeyEntry> }, // simple key list
// future: JwtIssuer { ... }, OAuthIntrospect { ... }
}
#[derive(Clone, Deserialize)]
pub struct AuthKeyEntry {
pub subject: String, // for logs
pub key_hash: String, // bcrypt or argon2 hash
pub scopes: Vec<String>,
}
#[derive(Clone, Deserialize)]
pub struct CorsConfig {
pub allowed_origins: Vec<String>, // empty = no CORS
pub allow_credentials: bool,
}
#[derive(Clone, Deserialize)]
pub struct LimitsConfig {
pub max_body_bytes: usize, // request body limit
pub max_concurrent_requests: usize, // semaphore
pub rate_limit_per_minute: Option<usize>, // optional per-subject
}
```
`ApiConfig` loads from `config.yaml` under a new top-level `api:` block. It's NOT part of `AppConfig` because it only matters in `--serve` mode; in CLI/REPL mode it's ignored.
```yaml
# config.yaml
api:
enabled: false # false = --serve refuses to start without explicit enable
listen_addr: "127.0.0.1:3400"
auth:
mode: StaticKeys
keys:
- subject: "alice"
key_hash: "$argon2id$..."
scopes: ["read", "write"]
cors:
allowed_origins: []
allow_credentials: false
limits:
max_body_bytes: 1048576 # 1 MiB
max_concurrent_requests: 64
rate_limit_per_minute: null
request_timeout_seconds: 300 # 5 minutes default
shutdown_grace_seconds: 30
```
### `ApiState`
```rust
#[derive(Clone)]
pub struct ApiState {
pub app: Arc<AppState>,
pub engine: Arc<Engine>,
pub config: Arc<ApiConfig>,
pub request_counter: Arc<AtomicU64>,
pub active_requests: Arc<Semaphore>,
}
```
`ApiState` is the axum-friendly wrapper that every handler receives via the `State` extractor. It's clonable (cheap — all fields are `Arc` or atomic) and thread-safe. Handlers get a clone per request.
### `JsonEmitter`
Phase 2 promised `JsonEmitter` and `SseEmitter` as deferred deliverables. Phase 4 implements them.
```rust
pub struct JsonEmitter {
events: Mutex<Vec<OwnedEvent>>,
tool_calls: Mutex<Vec<ToolCallRecord>>,
final_message: Mutex<Option<String>>,
outcome: Mutex<Option<RunOutcome>>,
}
impl JsonEmitter {
pub fn new() -> Self { /* ... */ }
/// Consume the emitter and return the JSON response body.
pub fn into_response(self) -> serde_json::Value { /* ... */ }
}
#[async_trait]
impl Emitter for JsonEmitter {
async fn emit(&self, event: Event<'_>) -> Result<(), EmitError> {
match event {
Event::AssistantDelta(text) => { /* accumulate */ }
Event::AssistantMessageEnd { full_text } => { /* set final_message */ }
Event::ToolCall { .. } | Event::ToolResult { .. } => { /* record */ }
Event::Finished { outcome } => { /* store */ }
_ => { /* record as event */ }
}
Ok(())
}
}
```
The non-streaming HTTP handler creates a `JsonEmitter`, calls `Engine::run`, and then calls `.into_response()` to get the final JSON body.
### `SseEmitter`
```rust
pub struct SseEmitter {
sender: mpsc::Sender<Result<axum::response::sse::Event, axum::Error>>,
client_disconnected: Arc<AtomicBool>,
}
#[async_trait]
impl Emitter for SseEmitter {
async fn emit(&self, event: Event<'_>) -> Result<(), EmitError> {
if self.client_disconnected.load(Ordering::Relaxed) {
return Err(EmitError::ClientDisconnected);
}
let sse_event = to_sse_event(&event)?;
self.sender
.send(Ok(sse_event))
.await
.map_err(|_| {
self.client_disconnected.store(true, Ordering::Relaxed);
EmitError::ClientDisconnected
})?;
Ok(())
}
}
fn to_sse_event(event: &Event<'_>) -> Result<axum::response::sse::Event, serde_json::Error> {
let (name, data) = match event {
Event::Started { .. } => ("started", serde_json::to_string(event)?),
Event::AssistantDelta(text) => ("assistant_delta", json!({ "text": text }).to_string()),
Event::AssistantMessageEnd { .. } => ("assistant_message_end", serde_json::to_string(event)?),
Event::ToolCall { .. } => ("tool_call", serde_json::to_string(event)?),
Event::ToolResult { .. } => ("tool_result", serde_json::to_string(event)?),
Event::AutoContinueTriggered { .. } => ("auto_continue_triggered", serde_json::to_string(event)?),
Event::SessionCompressing => ("session_compressing", "{}".to_string()),
Event::SessionCompressed { .. } => ("session_compressed", serde_json::to_string(event)?),
Event::SessionAutonamed(_) => ("session_autonamed", serde_json::to_string(event)?),
Event::Info(msg) => ("info", json!({ "message": msg }).to_string()),
Event::Warning(msg) => ("warning", json!({ "message": msg }).to_string()),
Event::Error(err) => ("error", serde_json::to_string(err)?),
Event::Finished { outcome } => ("finished", serde_json::to_string(outcome)?),
};
Ok(axum::response::sse::Event::default().event(name).data(data))
}
```
The streaming handler creates an mpsc channel, hands the sender half to an `SseEmitter`, and returns an `axum::response::sse::Sse` wrapping the receiver half. axum streams each event as it's emitted, with automatic flushing. If the client disconnects, the send fails, `client_disconnected` is set, and subsequent emits return `ClientDisconnected` — which the engine respects by continuing to completion without emitting further (Phase 2 designed this behavior in).
---
## Middleware Stack
The axum router wraps handlers in a layered middleware stack. Order matters because middleware is applied outside-in on requests, inside-out on responses.
```rust
let router = Router::new()
.route("/v1/auth/check", post(handlers::auth_check))
.route("/v1/models", get(handlers::list_models))
.route("/v1/agents", get(handlers::list_agents))
.route("/v1/roles", get(handlers::list_roles))
.route("/v1/rags", get(handlers::list_rags))
.route("/v1/info", get(handlers::info))
.route("/v1/completions", post(handlers::one_shot_completion))
.route("/v1/sessions", post(handlers::create_session).get(handlers::list_sessions))
.route("/v1/sessions/:id", get(handlers::get_session).delete(handlers::delete_session))
.route("/v1/sessions/:id/completions", post(handlers::session_completion))
.route("/v1/sessions/:id/compress", post(handlers::compress_session))
.route("/v1/sessions/:id/empty", post(handlers::empty_session))
.route("/v1/sessions/:id/role", post(handlers::set_role).delete(handlers::clear_role))
.route("/v1/sessions/:id/agent", post(handlers::set_agent).delete(handlers::clear_agent))
.route("/v1/sessions/:id/rag", post(handlers::set_rag).delete(handlers::clear_rag))
.route("/v1/rags/:name/rebuild", post(handlers::rebuild_rag))
.layer(middleware::from_fn_with_state(state.clone(), middleware::auth))
.layer(middleware::from_fn(middleware::request_id))
.layer(middleware::from_fn_with_state(state.clone(), middleware::concurrency_limit))
.layer(middleware::from_fn(middleware::tracing))
.layer(middleware::from_fn(middleware::error_handler))
.layer(tower_http::timeout::TimeoutLayer::new(Duration::from_secs(
state.config.request_timeout_seconds,
)))
.layer(tower_http::limit::RequestBodyLimitLayer::new(state.config.limits.max_body_bytes))
.layer(cors_layer(&state.config.cors))
.with_state(state);
```
### Middleware responsibilities
**auth** — Validates `Authorization: Bearer <key>` header against the configured auth provider. Compares against stored hashes (bcrypt/argon2), never plaintext. On success, attaches an `AuthContext { subject, scopes }` to request extensions. On failure, returns 401 immediately without calling the handler. If `AuthConfig::Disabled`, synthesizes an `AuthContext { subject: "anonymous", scopes: vec!["*"] }` for local dev.
**request_id** — Generates a UUID request ID, attaches it to request extensions for downstream correlation, emits it as `X-Request-Id` in the response headers. Used by tracing and error handlers.
**concurrency_limit** — Acquires a permit from `state.active_requests` semaphore with a short timeout. If the server is saturated, returns 503 Service Unavailable immediately. This protects against runaway connection counts exhausting resources.
**tracing** — Wraps the request in a `tracing::Span` carrying the request ID, subject, method, path, and session ID if present. Every log line and every tool call emitted during the request carries this span context. Essential for debugging production issues.
**error_handler** — Catches `CoreError` from handler results and maps to proper HTTP responses using `CoreError::http_status()` and a JSON error body. Ensures no handler leaks an `anyhow::Error` or raw `?` into an axum 500.
**timeout** — Overall request deadline. After N seconds (default 300), the request is aborted. This is a backstop — the engine's per-request cancellation token is the primary cancellation mechanism.
**body limit** — Rejects requests larger than the configured max. Default 1 MiB is enough for prompts with several files attached; adjustable in config.
**cors** — Attaches `Access-Control-Allow-Origin` headers for cross-origin browsers. Empty allowed origins = no CORS headers emitted (safe default). `allow_credentials: true` enables cookie/auth forwarding.
### What's NOT in middleware
- **Rate limiting per subject** — deferred. The `rate_limit_per_minute` config option is wired through but the middleware is a stub in Phase 4. Real rate limiting with sliding windows lands in a follow-up.
- **Request/response logging** — use the tracing middleware's output; don't add a separate HTTP log layer.
- **Metrics** — deferred to Phase 4.5 (Prometheus endpoint). Phase 4 just exposes counters in `ApiState`.
- **Content negotiation** — Phase 4 assumes JSON requests. `Accept: text/event-stream` is the only alternate content type we handle, and only on completion endpoints.
---
## Handler Pattern
Every handler follows the same shape:
```rust
pub async fn session_completion(
State(state): State<ApiState>,
Extension(auth): Extension<AuthContext>,
Extension(request_id): Extension<Uuid>,
Path(session_id): Path<String>,
Json(req): Json<CompletionRequest>,
) -> Result<Response, ApiError> {
// 1. Parse domain types
let session_id = SessionId::parse(&session_id)
.map_err(|_| ApiError::bad_request("invalid session id"))?;
// 2. Open the session handle
let handle = state.app.sessions.open(None, session_id).await
.map_err(|e| match e {
StoreError::NotFound { .. } => ApiError::not_found("session", &session_id.to_string()),
other => ApiError::from(other),
})?;
// 3. Build RequestContext from AppState + session
let mut ctx = RequestContext::new(state.app.clone(), WorkingMode::Api);
ctx.session = Some(handle);
ctx.auth = Some(auth);
// 4. Build cancellation token that fires on client disconnect
let cancel = CancellationToken::new();
// 5. Convert the HTTP request to a RunRequest
let run_req = RunRequest {
input: Some(UserInput::from_api(req.prompt, req.files)?),
command: None,
options: {
let mut o = if req.session_active {
RunOptions::api_session()
} else {
RunOptions::api_oneshot()
};
o.stream = req.stream;
o.auto_continue = req.auto_continue.unwrap_or(false);
o.cancel = cancel.clone();
o
},
};
// 6. Branch on streaming vs JSON
if req.stream {
// Create SseEmitter + channel, spawn engine task, return Sse response
let (tx, rx) = mpsc::channel(32);
let emitter = SseEmitter::new(tx);
let engine = state.engine.clone();
tokio::spawn(async move {
let _ = engine.run(&mut ctx, run_req, &emitter).await;
// Emitter Drop closes the channel; Sse stream ends naturally
});
Ok(Sse::new(ReceiverStream::new(rx))
.keep_alive(KeepAlive::default())
.into_response())
} else {
// Use JsonEmitter synchronously, return JSON body
let emitter = JsonEmitter::new();
state.engine.run(&mut ctx, run_req, &emitter).await
.map_err(ApiError::from)?;
Ok(Json(emitter.into_response()).into_response())
}
}
```
The streaming path spawns a background task because axum needs to return the `Response` (with the SSE stream) before the engine finishes its work. The task owns the `ctx` and `emitter`, runs to completion, and naturally terminates when the engine returns. The channel closing signals the end of the stream to axum.
The non-streaming path runs synchronously in the handler task because we need the full result before returning the response body.
---
## Cancellation and Client Disconnect
Two cancellation sources, one unified mechanism:
1. **Client disconnect during streaming.** axum signals this by dropping the SSE receiver. The next `SseEmitter::emit` call fails with `ClientDisconnected`, which the engine handles by stopping further emits but continuing to completion so session state is persisted correctly.
2. **Request timeout.** The outer tower timeout layer fires after N seconds, dropping the handler's future. This cancels any pending awaits in the engine, which propagates through tokio cancellation. Active tool calls (especially bash/python/typescript subprocesses) need to be killed cleanly — this is the same concern as Phase 2's Ctrl-C handling.
The engine's `CancellationToken` handles both cases uniformly. For streaming, the handler watches the SSE sender's `closed()` signal and triggers `cancel.cancel()` when the client goes away. For timeout, tower's dropped future causes the handler task to be aborted, which drops `cancel` and fires any `cancelled()` waiters in the engine.
```rust
// Inside the streaming handler:
let cancel_for_disconnect = cancel.clone();
let send_tx = tx.clone();
tokio::spawn(async move {
send_tx.closed().await; // resolves when receiver drops
cancel_for_disconnect.cancel();
});
```
**Tool call cancellation** is the interesting case. A running bash/python/typescript subprocess must be killed when `cancel` fires. The existing tool execution code uses `AbortSignal` from the `abort_on_ctrlc` crate; Phase 2's shim layer adapts it to `CancellationToken`. Phase 4 doesn't need to change this — it just needs to verify that the adapter is still firing correctly when cancellation comes from HTTP disconnect instead of Ctrl-C.
---
## Per-Request State Isolation
The critical correctness property: **two concurrent requests must not share mutable state.** The architecture from Phases 13 makes this structural rather than something we have to police:
- `AppState` is `Arc`-wrapped and contains only immutable config and shared services (vault, RAG cache, MCP factory, session store).
- `RequestContext` is constructed fresh in each handler — two requests get two independent contexts.
- `SessionHandle` uses per-session `Mutex` serialization — two concurrent requests on the *same* session wait their turn (by design).
- `McpFactory` acquires handles via per-key sharing — two requests using the same MCP server share one process; two using different servers get independent processes.
- `RagCache` shares `Arc<Rag>` via weak refs — same sharing property.
The one place where the architecture can't help us is **agent runtime isolation**. Two concurrent API requests on two different sessions, both running agents, must get two fully independent `AgentRuntime`s with their own supervisors, inboxes, todo lists, and escalation queues. Phase 1 Step 6.5 made this work by putting `AgentRuntime` on `RequestContext`, which is already per-request. Phase 4 just needs to verify nothing regresses.
**Integration test for this:** spin up 10 concurrent requests, each running a different agent with tools, and assert that each one gets its own tool call history, its own todo list, and its own eventual response. Use a mock LLM so the test is deterministic.
---
## Migration Strategy
### Step 1: Add dependencies and scaffolding
Add to `Cargo.toml`:
```toml
axum = { version = "0.8", features = ["macros"] }
tower = "0.5"
tower-http = { version = "0.6", features = ["cors", "limit", "timeout", "trace"] }
argon2 = "0.5"
```
`hyper` is already present. `tokio-stream` for SSE.
Create module structure:
- `src/api/mod.rs` — module root, `serve()` entrypoint
- `src/api/config.rs``ApiConfig`, `AuthConfig`, etc.
- `src/api/state.rs``ApiState`
- `src/api/auth.rs` — middleware + `AuthContext`
- `src/api/middleware.rs` — other middlewares (request_id, tracing, concurrency_limit, error_handler)
- `src/api/error.rs``ApiError` + conversion from `CoreError`
- `src/api/emitters/json.rs``JsonEmitter`
- `src/api/emitters/sse.rs``SseEmitter`
- `src/api/handlers/mod.rs` — handler module root
- `src/api/handlers/completions.rs` — one-shot and session completions
- `src/api/handlers/sessions.rs` — session CRUD
- `src/api/handlers/metadata.rs` — list models/agents/roles/rags
- `src/api/handlers/scope.rs` — role/agent/rag attachment endpoints
- `src/api/handlers/rag.rs` — rebuild endpoint
Register `pub mod api;` in `src/main.rs`. Add a `--serve` CLI flag that calls `api::serve(app_state).await`.
**Verification:** `cargo check` clean with empty handler stubs returning 501 Not Implemented.
### Step 2: Implement auth middleware and error handling
Build the auth middleware against `AuthConfig::StaticKeys` using argon2 for verification. Implement `ApiError` with `IntoResponse` that produces the JSON error body. Implement `From<CoreError>` for `ApiError` using `CoreError::http_status()` and `CoreError::message()` (add those methods to `CoreError` in Phase 2 if they don't exist yet; otherwise add here).
Write unit tests:
- Valid key → handler runs, `AuthContext` is attached
- Invalid key → 401
- Missing key → 401
- `AuthConfig::Disabled` → anonymous context synthesized
**Verification:** Auth tests pass. `curl -H "Authorization: Bearer <valid-key>" http://localhost:3400/v1/info` returns info; without the header returns 401.
### Step 3: Implement `JsonEmitter` and `SseEmitter`
Both are relatively mechanical. `JsonEmitter` accumulates events into a buffer and exposes `into_response()`. `SseEmitter` converts each event to an axum SSE frame and pushes into an mpsc channel.
Write unit tests using `NullEmitter` → feed a scripted sequence of events → assert the resulting JSON or SSE frames.
**Verification:** Both emitters have unit tests that drive a scripted `Event` sequence and compare to golden outputs.
### Step 4: Implement metadata handlers
Start with the easy endpoints: `GET /v1/models`, `/v1/agents`, `/v1/roles`, `/v1/rags`, `/v1/info`. These don't call the engine — they just read from `AppState` and return JSON.
**Verification:** `curl` each endpoint and inspect output. Write integration tests that spin up the router and hit each endpoint.
### Step 5: Implement session CRUD handlers
`POST /v1/sessions` creates via `SessionStore::create`. `GET /v1/sessions` lists via `SessionStore::list`. `GET /v1/sessions/:id` reads metadata + message history via `SessionStore::open` + handle lock. `DELETE /v1/sessions/:id` calls `SessionStore::delete`.
These handlers don't call the engine either. They're thin wrappers around `SessionStore`.
**Verification:** Create a session via POST, list it, read it, delete it, confirm 404 after delete. All through `curl`.
### Step 6: Implement one-shot completion handler
`POST /v1/completions` is the first engine-calling handler. It constructs a fresh `RequestContext` with no session, builds a `RunRequest` from the HTTP body, and calls `Engine::run` with either `JsonEmitter` or `SseEmitter` based on the `stream` flag.
This is where the streaming infrastructure first gets exercised end-to-end. Test both modes:
```bash
# Non-streaming
curl -X POST http://localhost:3400/v1/completions \
-H "Authorization: Bearer <key>" \
-H "Content-Type: application/json" \
-d '{"prompt":"hello"}'
# Streaming
curl -N -X POST http://localhost:3400/v1/completions \
-H "Authorization: Bearer <key>" \
-H "Content-Type: application/json" \
-H "Accept: text/event-stream" \
-d '{"prompt":"hello","stream":true}'
```
**Verification:** Both modes work with a real LLM. Disconnect the streaming client mid-response (Ctrl-C on curl) and verify the engine task gets cancelled cleanly — no orphaned MCP subprocesses, no hung tool executions.
### Step 7: Implement session completion handler
`POST /v1/sessions/:id/completions` is the same as one-shot but with a session attached. The handler calls `store.open(id)`, builds a context with `ctx.session = Some(handle)`, and proceeds as before. Session state is automatically persisted by the engine at the end of the turn.
Concurrent request test: spin up 10 concurrent `curl` commands all hitting the same session. Assert:
- All 10 complete successfully
- The session has 10 message pairs appended in some order (serialized by the per-session mutex)
- No lost updates, no corrupted YAML
**Verification:** Concurrent test passes reliably. Run it 100 times in a loop to catch races.
### Step 8: Implement scope attachment handlers
`POST /v1/sessions/:id/role`, `/agent`, `/rag` and their `DELETE` counterparts. Each one opens the session handle, constructs a `RunRequest` with a `CoreCommand` variant (`UseRole`, `UseAgent`, `UseRag`), and calls the engine with no input — just the command. The engine dispatches the command, mutates state, and the session is persisted.
**Verification:** `POST /v1/sessions/<id>/role {"name":"explain"}` activates the role. Subsequent completion on the session uses the role. `DELETE /v1/sessions/<id>/role` clears it.
### Step 9: Implement miscellaneous handlers
`POST /v1/sessions/:id/compress`, `/empty`, `POST /v1/rags/:name/rebuild`. Same pattern: translate to `CoreCommand` and dispatch.
**Verification:** All endpoints respond correctly.
### Step 10: Graceful shutdown
axum's graceful shutdown requires a signal future. Wire it up:
```rust
pub async fn serve(app: Arc<AppState>, config: ApiConfig) -> Result<()> {
let state = ApiState::new(app, config);
let router = build_router(state.clone());
let listener = tokio::net::TcpListener::bind(state.config.listen_addr).await?;
let shutdown_signal = async {
tokio::signal::ctrl_c().await.ok();
info!("Received shutdown signal, draining requests...");
};
axum::serve(listener, router)
.with_graceful_shutdown(shutdown_signal)
.await?;
info!("Draining active sessions...");
tokio::time::timeout(
Duration::from_secs(state.config.shutdown_grace_seconds),
drain_active_requests(&state),
).await.ok();
info!("Shutdown complete.");
Ok(())
}
```
`drain_active_requests` waits for the semaphore to return to full capacity, bounded by `shutdown_grace_seconds`. After the grace period, any remaining requests are force-cancelled.
**Verification:** Start server, send a long streaming request, hit Ctrl-C. The server should finish the in-flight request (up to the grace period) before exiting, not cut it off mid-stream.
### Step 11: Configuration loading and docs
Wire `ApiConfig` through `config.yaml` parsing. Add a default `api.enabled: false` so the server refuses to start without explicit opt-in. Document the config shape, endpoint schemas, and auth setup in `docs/REST-API-SERVER.md`.
**Verification:** Start with `api.enabled: false` → fatal error with helpful message. Start with `api.enabled: true` + no auth keys → fatal error demanding at least one key (unless `AuthConfig::Disabled` is explicit).
### Step 12: Integration test suite
Write a comprehensive integration test suite in `tests/api/` that exercises the full HTTP surface with a mock LLM:
- Auth: valid, invalid, missing, disabled
- Metadata: list each resource type
- Session lifecycle: create → list → read → delete
- One-shot completion: JSON + SSE
- Session completion: single + concurrent
- Scope attachment: role, agent, rag (set + clear)
- Cancellation: client disconnect mid-stream, timeout expiry
- Graceful shutdown: in-flight requests complete within grace period
- Concurrent sessions: 20 sessions, each with a few turns, all running at once
Use `reqwest` as the test client. Spin up the server on a random port per test. The mock LLM lives as a fake `Client` implementation that returns scripted responses.
**Verification:** All tests pass. CI runs them on every PR.
---
## Risks and Watch Items
| Risk | Severity | Mitigation |
|---|---|---|
| **SSE client disconnect detection lag** | High | The mpsc channel's `closed()` signal is the primary disconnect detector. Verify it fires within <1s of a real client disconnect. Add integration test with `reqwest` that opens a stream, sends a few events, drops the connection, and asserts the engine's cancellation token fires within 2s. |
| **Concurrent session writes losing data** | High | Phase 3's per-session mutex handles this structurally. Verify with the 100-concurrent-writers integration test from Phase 3 adapted to hit the HTTP layer. |
| **Orphaned tool subprocesses on timeout** | High | Tool execution must respect the cancellation token. Test: start a completion that triggers a bash tool running `sleep 60`, timeout at 5s, verify the `sleep` process is killed (not reparented to init). |
| **Auth key storage** | High | Store argon2 hashes, never plaintext. Rotate via config reload (future). Log subject (not key) on every request. Audit: no `println!` of any part of the key anywhere. |
| **Streaming body size growth** | Medium | A long session with many tool calls produces a lot of SSE frames. Verify the mpsc channel size (32) is enough; if not, backpressure causes the engine task to block on emit. Document in the emitter: `emit()` can await. |
| **CORS misconfiguration** | Medium | Default to no CORS. Require explicit origin allowlist. Log warnings on wildcard usage. Browser-accessible deployments should use a reverse proxy to terminate CORS. |
| **Auth bypass via malformed header** | Medium | Use axum's `Authorization` typed header extractor, not raw string parsing. Reject unknown schemes (only Bearer accepted). |
| **Rate limit stub** | Low | Document that `rate_limit_per_minute` is not yet implemented. Add an issue for follow-up. Protect against DoS with `max_concurrent_requests` in the meantime. |
| **Session metadata leak across users** | Low | `GET /v1/sessions` lists all sessions regardless of caller identity in Phase 4. Document this limitation: Phase 4's auth is coarse-grained (anyone with a valid key sees all sessions). Per-subject session ownership lands in a follow-up phase. Treat Phase 4 as single-tenant-per-key for now. |
| **Body size abuse** | Low | `max_body_bytes` caps payload. File uploads (not yet supported) would need separate multipart handling. |
| **Port binding failure** | Low | Fail fast with clear error if the configured port is in use or unreachable. Don't silently retry. |
---
## What Phase 4 Does NOT Do
- **No WebSocket support.** SSE is sufficient for server-to-client streaming; WebSockets would add bidirectional complexity we don't need. Client-to-server commands use regular HTTP POST.
- **No multi-tenancy.** All sessions are visible to any authenticated caller. Per-subject session ownership is a follow-up.
- **No rate limiting.** `rate_limit_per_minute` config exists but is a stub.
- **No metrics endpoint.** Counters are in memory; Prometheus scraping lands later.
- **No API versioning beyond `/v1/`.** Breaking changes would introduce `/v2/`.
- **No JWT or OAuth.** Static API keys only. JWT introspection can extend `AuthConfig` later.
- **No request signing.** Bearer tokens over HTTPS (users provide their own TLS termination via reverse proxy).
- **No admin endpoints.** Server management (reload config, view metrics, kill sessions) is not exposed.
- **No file upload.** File references in requests use absolute paths or URLs that the server fetches; no multipart uploads in Phase 4.
- **No MCP tool exposure over API.** The API calls the engine, which runs tools internally. Direct "execute this tool" API endpoints don't exist and are not planned.
---
## Entry Criteria (from Phase 3)
- [ ] `SessionStore` trait is the only path to session persistence
- [ ] `FileSessionStore` is wired into `AppState.sessions`
- [ ] Concurrent-write integration test from Phase 3 passes
- [ ] All session-touching callsites go through the store
- [ ] `Engine::run` handles `RunOptions::api_oneshot()` and `RunOptions::api_session()` modes
- [ ] `cargo check`, `cargo test`, `cargo clippy` all clean
## Exit Criteria (Phase 4 complete)
- [ ] `--serve` flag starts an HTTP server on the configured port
- [ ] `src/api/` module exists with all handlers, middleware, emitters
- [ ] `JsonEmitter` and `SseEmitter` implemented and tested
- [ ] Auth middleware validates argon2-hashed API keys
- [ ] All 19 endpoints listed in the API surface are implemented and return sensible responses
- [ ] Concurrent-session integration test passes (20 sessions, multiple turns, parallel)
- [ ] Client disconnect during streaming triggers engine cancellation within 2s
- [ ] Request timeout fires at the configured deadline
- [ ] Graceful shutdown drains in-flight requests within the grace period
- [ ] Tool subprocesses are killed on cancellation, not orphaned
- [ ] `docs/REST-API-SERVER.md` documents config, endpoints, and auth setup
- [ ] Full integration test suite in `tests/api/` passes
- [ ] `cargo check`, `cargo test`, `cargo clippy` all clean
- [ ] Phase 5 (Tool Scope Pooling) can optimize the hot path without changing the API surface
@@ -0,0 +1,755 @@
# Phase 5 Implementation Plan: Tool Scope Pooling and Lifecycle
## Overview
Phase 5 turns the trivial no-pool `McpFactory` from Phase 1 Step 6.5 into a production-grade pooling layer with idle timeouts, a background reaper, health checks, and graceful shutdown integration. The architecture doesn't change — `McpFactory::acquire()` is still the only entry point, `Arc<McpServerHandle>` is still the reference type — but the factory now aggressively shares MCP subprocesses across scopes to keep warm-path latency near zero.
**Estimated effort:** ~1 week
**Risk:** Medium. The pooling logic has subtle ordering concerns (handle Drop → idle pool vs teardown → reaper eviction). Get those wrong and you leak processes or double-free.
**Depends on:** Phases 14 complete. Phase 4 is important because it's the first workload where pooling actually matters — CLI and REPL don't generate enough concurrent scope transitions to justify the complexity.
---
## Why Phase 5 Exists
After Phase 4 lands, the API server works correctly but has a performance problem: every API session activates its own MCP processes, and when the session closes, those processes tear down immediately. A realistic production workload — 20 concurrent users each sending a burst of requests — spawns and kills MCP subprocesses at an unsustainable rate. For servers like `github` that take 12 seconds to start (subprocess + stdio handshake + OAuth + `tools/list`), every API call adds visible cold-start latency.
The architectural framing for the fix was already designed in Phase 1 Step 6.5 and Phase 1's "MCP Lifecycle Policy" section:
1. **Layer 1: active Arc reference counting.** Already done in Phase 1. Scopes hold `Arc<McpServerHandle>`; the last drop triggers teardown.
2. **Layer 2: idle grace period.** Not yet implemented. After the last Arc drops, the handle moves to an idle pool with a timestamp instead of tearing down. A background reaper evicts entries that have been idle past the configured threshold.
3. **Acquisition order.** `acquire(key)` checks the active map first, then the idle pool (revival = zero latency), then spawns fresh.
Phase 5 implements Layer 2 + the reaper + the revival logic + the health check + graceful shutdown integration. No changes to the caller API. No changes to any other phase's code.
**This is a pure optimization phase.** Correctness is unchanged; only performance improves.
---
## The Architecture After Phase 5
```
┌─────────────────────────────────────────────────┐
│ McpFactory │
│ │
│ ┌──────────────┐ ┌──────────────────┐ │
│ │ active: │ │ idle: │ │
│ │ HashMap<K, │ │ HashMap<K, │ │
│ │ Weak<H>> │ │ IdleEntry> │ │
│ └──────┬───────┘ └────────┬─────────┘ │
│ │ │ │
│ │ upgrade() │ remove() │
│ │ │ │
│ ▼ ▼ │
│ ┌──────────────────────────────────────┐ │
│ │ acquire(key): │ │
│ │ 1. Try active.upgrade() → share │ │
│ │ 2. Try idle.remove() → revive │ │
│ │ 3. Spawn fresh subprocess │ │
│ └──────────────────────────────────────┘ │
│ │
│ ┌──────────────────────────────────────┐ │
│ │ Background reaper (tokio::spawn): │ │
│ │ every cleanup_interval: │ │
│ │ walk idle, evict stale entries │ │
│ │ (optional: health check) │ │
│ └──────────────────────────────────────┘ │
└─────────────────────────────────────────────────┘
│ Arc<McpServerHandle>
┌────────────────────────┐
│ scope's ToolScope │
│ (CLI/REPL/API request)│
└────────────────────────┘
```
---
## Core Types
### `McpFactory` (expanded)
```rust
pub struct McpFactory {
active: Mutex<HashMap<McpServerKey, Weak<McpServerHandleInner>>>,
idle: Mutex<HashMap<McpServerKey, IdleEntry>>,
config: McpFactoryConfig,
shutdown: Arc<AtomicBool>,
reaper_handle: Mutex<Option<JoinHandle<()>>>,
}
struct IdleEntry {
handle: Arc<McpServerHandleInner>,
idle_since: Instant,
last_health_check: Option<Instant>,
}
pub struct McpFactoryConfig {
pub idle_timeout: Duration,
pub cleanup_interval: Duration,
pub max_idle_servers: Option<usize>,
pub health_check: Option<HealthCheckPolicy>,
}
pub struct HealthCheckPolicy {
pub interval: Duration,
pub timeout: Duration,
pub on_failure: HealthFailureAction,
}
pub enum HealthFailureAction {
Evict,
EvictAndLog,
LogOnly,
}
```
The factory grows three new pieces of state compared to Phase 1's stub:
- **`idle` map** — stores handles that nobody currently owns but that we've decided to keep warm.
- **`shutdown` flag** — tells the reaper to exit and prevents new inserts into `idle` during drain.
- **`reaper_handle`** — the `JoinHandle` of the background task, awaited during graceful shutdown.
### `McpServerHandle` (refined)
Phase 1's `Arc<McpServerHandle>` becomes `Arc<McpServerHandleInner>`, and we add a `Drop` impl on the inner type that handles the "return to idle pool" logic:
```rust
pub struct McpServerHandleInner {
key: McpServerKey,
service: RwLock<RunningService<RoleClient, ()>>,
factory: Weak<McpFactory>,
spawned_at: Instant,
returning_to_pool: AtomicBool,
}
impl Drop for McpServerHandleInner {
fn drop(&mut self) {
// If we're already returning to pool (revived from idle),
// don't re-insert — the factory is handling it.
if self.returning_to_pool.load(Ordering::Acquire) {
return;
}
let Some(factory) = self.factory.upgrade() else {
// Factory is gone — just let the service die via its own drop.
return;
};
if factory.shutdown.load(Ordering::Acquire) {
// Shutting down — don't put it back in idle, just die.
return;
}
// Take ownership of self.service and move to idle pool.
// This requires unsafe or a different ownership structure — see
// "The Drop trick" section below.
factory.return_to_idle(self);
}
}
```
**The Drop trick** — the issue is that `Drop::drop` can't actually move `self`'s fields out without `unsafe`, but we need to move the `RunningService` into the idle pool. The clean solution is to wrap the service in an `Option<RunningService>`:
```rust
pub struct McpServerHandleInner {
key: McpServerKey,
service: Mutex<Option<RunningService<RoleClient, ()>>>, // Option so we can take() in Drop
factory: Weak<McpFactory>,
spawned_at: Instant,
}
impl Drop for McpServerHandleInner {
fn drop(&mut self) {
let Some(factory) = self.factory.upgrade() else { return; };
if factory.shutdown.load(Ordering::Acquire) { return; }
// Take the service out. After this, self.service is None.
let service = match self.service.get_mut().take() {
Some(s) => s,
None => return, // Already taken — e.g., by shutdown drain.
};
// Spawn a task to move it into the idle pool (can't await in Drop).
let key = self.key.clone();
let factory = factory.clone();
tokio::spawn(async move {
factory.accept_returning_handle(key, service).await;
});
}
}
```
This has the right shape but introduces a subtle race: the `tokio::spawn` inside `Drop` runs asynchronously, so if a new `acquire(key)` arrives between the Drop and the spawned task completing, it won't find the handle in `idle` yet and will spawn a fresh subprocess. That's acceptable — it's slightly wasteful but not incorrect, and the race window is microseconds.
An alternative that avoids the race: use a dedicated `return_tx: mpsc::UnboundedSender<ReturningHandle>` on the factory, push synchronously into it from Drop, and a single "idle manager" task owns the idle map. This is cleaner because the idle map only mutates from one task, but it adds a coordination point. **Recommendation: start with the `tokio::spawn` approach; switch to the mpsc pattern only if the race causes visible issues.**
### `McpServerHandle` (the public Arc wrapper)
```rust
pub struct McpServerHandle(Arc<McpServerHandleInner>);
impl McpServerHandle {
pub async fn call_tool(&self, tool: &str, args: Value) -> Result<ToolResult> {
let guard = self.0.service.lock().await;
let service = guard.as_ref().ok_or(McpError::HandleDrained)?;
service.call_tool(tool, args).await
}
pub async fn list_tools(&self) -> Result<Vec<ToolSpec>> {
let guard = self.0.service.lock().await;
let service = guard.as_ref().ok_or(McpError::HandleDrained)?;
service.list_tools().await
}
}
impl Clone for McpServerHandle {
fn clone(&self) -> Self { Self(self.0.clone()) }
}
```
Callers get a `McpServerHandle` (which is `Arc<Inner>` internally) from `acquire()`. Cloning is cheap. Dropping the last clone fires the `Drop` on `Inner`, which returns the underlying service to the idle pool or kills it.
---
## The `acquire` Path
Three cases in order:
```rust
impl McpFactory {
pub async fn acquire(&self, key: &McpServerKey) -> Result<McpServerHandle> {
// Case 1: Active share
{
let active = self.active.lock();
if let Some(weak) = active.get(key) {
if let Some(inner) = weak.upgrade() {
metrics::mcp_acquire_hit_active();
return Ok(McpServerHandle(inner));
}
// Weak is dangling; let it fall through.
}
}
// Case 2: Revive from idle
{
let mut idle = self.idle.lock();
if let Some(entry) = idle.remove(key) {
metrics::mcp_acquire_hit_idle(entry.idle_since.elapsed());
let inner = self.revive_idle_entry(entry);
// Re-register in active map.
self.active.lock().insert(key.clone(), Arc::downgrade(&inner));
return Ok(McpServerHandle(inner));
}
}
// Case 3: Spawn fresh
metrics::mcp_acquire_miss();
let inner = self.spawn_new(key).await?;
self.active.lock().insert(key.clone(), Arc::downgrade(&inner));
Ok(McpServerHandle(inner))
}
fn revive_idle_entry(&self, entry: IdleEntry) -> Arc<McpServerHandleInner> {
// Wrap the handle in a fresh Arc. The IdleEntry held an Arc; we're
// just transferring ownership here.
entry.handle
}
async fn spawn_new(&self, key: &McpServerKey) -> Result<Arc<McpServerHandleInner>> {
let spec = self.resolve_spec(key)?;
let service = McpServer::start(&spec).await?;
let inner = Arc::new(McpServerHandleInner {
key: key.clone(),
service: Mutex::new(Some(service)),
factory: Arc::downgrade(&self.weak_self()),
spawned_at: Instant::now(),
});
Ok(inner)
}
}
```
**Concurrency in `acquire`:** the `active.lock()` critical section is short — just a hashmap lookup and maybe an insert. It never holds across an `.await`. The `idle.lock()` critical section is equally short. The `spawn_new` path is the expensive one (subprocess spawn + stdio handshake + `tools/list`), and it runs OUTSIDE any lock. This means two concurrent `acquire(key)` calls that both miss can both spawn fresh, producing two subprocesses for the same key briefly. Once both register themselves in `active`, the second insert clobbers the first, and the first handle's Drop returns it to the idle pool. The net effect is one "wasted" spawn per race, which is acceptable.
If you want to eliminate the race entirely, add a per-key `OnceCell`-style coordinator:
```rust
pending: Mutex<HashMap<McpServerKey, broadcast::Receiver<Arc<McpServerHandleInner>>>>,
```
A caller that misses both active and idle checks `pending` — if another task is already spawning, it subscribes to the broadcast and waits. The first spawner publishes the result. Clean but adds a layer of complexity. Start simple; add this if races become a problem in practice.
---
## The Reaper Task
```rust
async fn reaper_loop(factory: Arc<McpFactory>) {
let mut ticker = interval(factory.config.cleanup_interval);
loop {
ticker.tick().await;
if factory.shutdown.load(Ordering::Acquire) {
info!("Reaper exiting (shutdown requested)");
return;
}
factory.evict_stale_idle().await;
if let Some(policy) = &factory.config.health_check {
factory.run_health_checks(policy).await;
}
}
}
impl McpFactory {
async fn evict_stale_idle(&self) {
let now = Instant::now();
let timeout = self.config.idle_timeout;
// Phase 1: collect stale keys while holding the lock briefly.
let stale: Vec<McpServerKey> = {
let idle = self.idle.lock();
idle.iter()
.filter(|(_, entry)| now.duration_since(entry.idle_since) >= timeout)
.map(|(k, _)| k.clone())
.collect()
};
// Phase 2: remove them from the idle map and terminate.
for key in stale {
let entry = {
let mut idle = self.idle.lock();
idle.remove(&key)
};
if let Some(entry) = entry {
self.terminate_idle_handle(entry).await;
metrics::mcp_idle_evicted();
}
}
// Phase 3: enforce max_idle_servers cap via LRU.
if let Some(max) = self.config.max_idle_servers {
self.enforce_max_idle(max).await;
}
}
async fn enforce_max_idle(&self, max: usize) {
let victims: Vec<(McpServerKey, Instant)> = {
let idle = self.idle.lock();
if idle.len() <= max {
return;
}
let mut entries: Vec<_> = idle.iter()
.map(|(k, v)| (k.clone(), v.idle_since))
.collect();
entries.sort_by_key(|(_, t)| *t); // oldest first
entries.into_iter().take(idle.len() - max).collect()
};
for (key, _) in victims {
let entry = self.idle.lock().remove(&key);
if let Some(entry) = entry {
self.terminate_idle_handle(entry).await;
metrics::mcp_lru_evicted();
}
}
}
async fn terminate_idle_handle(&self, entry: IdleEntry) {
// Take the service out of the Arc<Inner> and cancel it.
// At this point, there are no other Arc refs — it's just us.
if let Ok(inner) = Arc::try_unwrap(entry.handle) {
if let Some(service) = inner.service.into_inner().take() {
service.cancel().await.ok();
}
}
// If try_unwrap fails, something else grabbed a ref — skip, it'll
// return to idle on its own Drop.
}
}
```
**Ordering:** `cleanup_interval` runs on a tokio `interval` ticker. Default is 30 seconds. Setting it too low wastes CPU; too high means idle servers linger slightly longer than `idle_timeout`. A tolerance of `idle_timeout + cleanup_interval` worst case is the tradeoff.
**`Arc::try_unwrap`** is the key to safe teardown. By the time the reaper decides to evict an entry, the only Arc to that `Inner` is the one in the `IdleEntry`. Any subsequent `acquire(key)` would have removed it from the idle map first. So `try_unwrap` should always succeed — but if it doesn't (e.g., because of the Drop-race described earlier), we just skip this eviction and catch it next cycle.
---
## The Health Check Path
```rust
impl McpFactory {
async fn run_health_checks(&self, policy: &HealthCheckPolicy) {
let now = Instant::now();
let candidates: Vec<McpServerKey> = {
let idle = self.idle.lock();
idle.iter()
.filter(|(_, entry)| {
entry.last_health_check
.map(|t| now.duration_since(t) >= policy.interval)
.unwrap_or(true)
})
.map(|(k, _)| k.clone())
.collect()
};
for key in candidates {
let handle = {
let idle = self.idle.lock();
idle.get(&key).map(|e| e.handle.clone())
};
let Some(handle) = handle else { continue };
let result = tokio::time::timeout(
policy.timeout,
self.ping_handle(&handle),
).await;
match result {
Ok(Ok(())) => {
let mut idle = self.idle.lock();
if let Some(entry) = idle.get_mut(&key) {
entry.last_health_check = Some(now);
}
metrics::mcp_health_ok();
}
Ok(Err(e)) | Err(_) => {
metrics::mcp_health_failed();
match policy.on_failure {
HealthFailureAction::Evict | HealthFailureAction::EvictAndLog => {
let entry = self.idle.lock().remove(&key);
if let Some(entry) = entry {
self.terminate_idle_handle(entry).await;
}
if matches!(policy.on_failure, HealthFailureAction::EvictAndLog) {
warn!(key = ?key, error = ?e, "evicted unhealthy MCP server");
}
}
HealthFailureAction::LogOnly => {
warn!(key = ?key, error = ?e, "MCP server failed health check");
}
}
}
}
}
}
async fn ping_handle(&self, handle: &Arc<McpServerHandleInner>) -> Result<()> {
let guard = handle.service.lock().await;
let service = guard.as_ref().ok_or(McpError::HandleDrained)?;
// `list_tools` is cheap and standard across all MCP servers.
service.list_tools().await?;
Ok(())
}
}
```
Health checks are optional (`health_check: None` disables them). When enabled, they run on the same interval as the reaper and only check idle entries whose last check was more than `policy.interval` ago. This avoids hammering servers that are currently in active use.
---
## Graceful Shutdown Integration
The factory coordinates with the process shutdown signal (Ctrl-C for CLI, SIGTERM for server mode). When shutdown fires:
1. Set `factory.shutdown = true`. Any subsequent `acquire()` still works but new handles won't be returned to idle on Drop.
2. Cancel the reaper's `JoinHandle`.
3. Drain the idle pool: walk it, call `terminate_idle_handle` for each entry.
4. Wait for active handles to drop naturally as their scopes finish. If there's a shutdown grace period (Phase 4's `shutdown_grace_seconds`), bound the wait with that.
```rust
impl McpFactory {
pub async fn shutdown(&self, grace: Duration) {
info!("McpFactory entering shutdown");
self.shutdown.store(true, Ordering::Release);
// Stop the reaper.
if let Some(handle) = self.reaper_handle.lock().take() {
handle.abort();
let _ = handle.await;
}
// Drain the idle pool immediately.
let idle_entries: Vec<IdleEntry> = {
let mut idle = self.idle.lock();
idle.drain().map(|(_, v)| v).collect()
};
for entry in idle_entries {
self.terminate_idle_handle(entry).await;
}
// Wait for active scopes to release their handles.
let deadline = Instant::now() + grace;
while Instant::now() < deadline {
if self.active_count() == 0 {
break;
}
tokio::time::sleep(Duration::from_millis(100)).await;
}
// Force-terminate any remaining active handles.
let remaining = self.active_count();
if remaining > 0 {
warn!(count = remaining, "force-terminating MCP servers after grace period");
self.force_terminate_active().await;
}
info!("McpFactory shutdown complete");
}
fn active_count(&self) -> usize {
let active = self.active.lock();
active.values().filter(|w| w.strong_count() > 0).count()
}
async fn force_terminate_active(&self) {
// Walk the active map, upgrade the weak refs, and call cancel
// directly on the underlying service. This is a last resort.
let handles: Vec<Arc<McpServerHandleInner>> = {
let active = self.active.lock();
active.values().filter_map(|w| w.upgrade()).collect()
};
for handle in handles {
if let Ok(inner) = Arc::try_unwrap(handle) {
if let Some(service) = inner.service.into_inner().take() {
service.cancel().await.ok();
}
}
// If try_unwrap fails, we can't force-kill without leaking
// the service. Log and move on.
}
}
}
```
Phase 4's `serve()` function calls `factory.shutdown(grace)` after the axum server has stopped accepting new requests. This chains cleanly: axum drains requests → factory drains scopes → factory drains idle pool → process exits.
---
## Configuration
Add to `config.yaml`:
```yaml
mcp_pool:
idle_timeout_seconds: 300 # how long idle servers stay warm (default: 300 for --serve, 0 for CLI/REPL)
cleanup_interval_seconds: 30 # how often the reaper runs
max_idle_servers: 50 # LRU cap (null = unbounded)
health_check:
interval_seconds: 60
timeout_seconds: 5
on_failure: EvictAndLog # or Evict, LogOnly
```
Per-server overrides live in `functions/mcp.json`:
```json
{
"github": { "command": "...", "idle_timeout_seconds": 900 },
"filesystem": { "command": "...", "idle_timeout_seconds": 60 },
"jira": { "command": "...", "idle_timeout_seconds": 300 }
}
```
The per-server override wins over the global config. The resolution is: look up the server spec, check if it has `idle_timeout_seconds`, use that if present, else use `mcp_pool.idle_timeout_seconds`, else use the mode default (0 for CLI/REPL, 300 for `--serve`).
**Mode defaults** are critical because they preserve Phase 1 Step 6.5's behavior. CLI and REPL users get `idle_timeout = 0`, which means the factory behaves exactly like the no-pool version — drop = terminate. The pool is inert for single-user scenarios. Only `--serve` mode turns it on by default. This avoids regressing REPL users who don't want MCP subprocess churn quirks.
```rust
pub fn default_idle_timeout(mode: WorkingMode) -> Duration {
match mode {
WorkingMode::Cmd | WorkingMode::Repl => Duration::ZERO,
WorkingMode::Api => Duration::from_secs(300),
}
}
```
---
## Metrics
Phase 5 is the right time to add basic observability counters. They're cheap and the factory is where the interesting operational questions live.
```rust
mod metrics {
use std::sync::atomic::{AtomicU64, Ordering};
pub static MCP_SPAWNED: AtomicU64 = AtomicU64::new(0);
pub static MCP_ACQUIRE_ACTIVE_HIT: AtomicU64 = AtomicU64::new(0);
pub static MCP_ACQUIRE_IDLE_HIT: AtomicU64 = AtomicU64::new(0);
pub static MCP_ACQUIRE_MISS: AtomicU64 = AtomicU64::new(0);
pub static MCP_IDLE_EVICTED: AtomicU64 = AtomicU64::new(0);
pub static MCP_LRU_EVICTED: AtomicU64 = AtomicU64::new(0);
pub static MCP_HEALTH_OK: AtomicU64 = AtomicU64::new(0);
pub static MCP_HEALTH_FAILED: AtomicU64 = AtomicU64::new(0);
pub fn mcp_acquire_hit_active() { MCP_ACQUIRE_ACTIVE_HIT.fetch_add(1, Ordering::Relaxed); }
pub fn mcp_acquire_hit_idle(age: Duration) {
MCP_ACQUIRE_IDLE_HIT.fetch_add(1, Ordering::Relaxed);
// In a real metrics system, record a histogram of age for revival latency.
}
pub fn mcp_acquire_miss() { MCP_ACQUIRE_MISS.fetch_add(1, Ordering::Relaxed); }
pub fn mcp_spawned() { MCP_SPAWNED.fetch_add(1, Ordering::Relaxed); }
pub fn mcp_idle_evicted() { MCP_IDLE_EVICTED.fetch_add(1, Ordering::Relaxed); }
pub fn mcp_lru_evicted() { MCP_LRU_EVICTED.fetch_add(1, Ordering::Relaxed); }
pub fn mcp_health_ok() { MCP_HEALTH_OK.fetch_add(1, Ordering::Relaxed); }
pub fn mcp_health_failed() { MCP_HEALTH_FAILED.fetch_add(1, Ordering::Relaxed); }
pub fn snapshot() -> MetricsSnapshot {
MetricsSnapshot {
spawned: MCP_SPAWNED.load(Ordering::Relaxed),
acquire_active_hit: MCP_ACQUIRE_ACTIVE_HIT.load(Ordering::Relaxed),
acquire_idle_hit: MCP_ACQUIRE_IDLE_HIT.load(Ordering::Relaxed),
acquire_miss: MCP_ACQUIRE_MISS.load(Ordering::Relaxed),
idle_evicted: MCP_IDLE_EVICTED.load(Ordering::Relaxed),
lru_evicted: MCP_LRU_EVICTED.load(Ordering::Relaxed),
health_ok: MCP_HEALTH_OK.load(Ordering::Relaxed),
health_failed: MCP_HEALTH_FAILED.load(Ordering::Relaxed),
}
}
}
```
Expose the snapshot via `GET /v1/info/mcp` in the API server (piggybacks on Phase 4's `/v1/info`). CLI/REPL users can inspect via a new `.info mcp` dot-command.
**Derived metrics worth computing:**
- Hit rate = `(active_hit + idle_hit) / (active_hit + idle_hit + miss)` — should be >0.9 for a well-tuned pool.
- Revival latency distribution — how old were idle entries when revived? Informs tuning of `idle_timeout`.
- Eviction rate — how often is the pool churning?
None of this is Prometheus-compatible yet; that integration is a follow-up. For Phase 5, plain counters are enough to diagnose issues.
---
## Migration Strategy
### Step 1: Expand `McpFactory` to support the idle pool
Add the `idle` map, `shutdown` flag, and `reaper_handle` fields. Keep the existing `active` map. Don't change any caller code yet.
Implement `acquire()` with the three-case logic (active → idle → spawn). At this point the idle pool is always empty because nothing puts anything in it, so the logic reduces to Phase 1's behavior. Tests should still pass.
**Verification:** `cargo check` + existing Phase 1 tests pass.
### Step 2: Implement `Drop` on `McpServerHandleInner` with return-to-idle
Switch `service` to `Mutex<Option<RunningService>>`. Implement `Drop` that spawns a task to call `factory.accept_returning_handle(key, service)`. The factory method inserts into `idle`.
At this point, dropped handles start populating the idle pool. The reaper isn't running yet, so idle entries accumulate without bound.
**Verification:** Manual test: acquire a handle, drop it, assert the idle map now has the entry. Then acquire the same key again and assert it comes from idle (not a fresh spawn).
### Step 3: Implement the reaper task
Add `reaper_loop` and `evict_stale_idle`. Start the reaper in `McpFactory::new()` via `tokio::spawn`, store the `JoinHandle`. Default `idle_timeout` based on working mode.
**Verification:** Unit test with a tiny timeout (e.g., 100ms) — acquire, drop, wait 200ms, assert the idle map is empty. Use a mock MCP server (or a no-op `RunningService` for tests).
### Step 4: Add configuration plumbing
Parse `mcp_pool` from `config.yaml` into `McpFactoryConfig`. Parse per-server `idle_timeout_seconds` overrides from `functions/mcp.json`. Wire everything through `AppState::init()`.
**Verification:** Config tests that verify defaults, overrides, and mode-specific behavior.
### Step 5: Implement health checks
Add `run_health_checks`, `ping_handle`, and the `HealthCheckPolicy` config. Wire into the reaper loop. Default is `None` (disabled).
**Verification:** Unit test with a mock MCP server that returns an error on `list_tools` after N calls — verify the factory evicts it and logs.
### Step 6: Implement graceful shutdown
Add `McpFactory::shutdown(grace)`. Wire into Phase 4's `serve()` shutdown sequence and into the CLI/REPL exit path (for clean subprocess termination).
**Verification:** Start the API server, send several requests to warm up the pool, send SIGTERM, verify all MCP subprocesses terminate within the grace period (use `ps` or process tree inspection).
### Step 7: Expose metrics
Add the atomic counters, the snapshot function, and the `.info mcp` dot-command. Add `GET /v1/info/mcp` handler in the API server.
**Verification:** `.info mcp` shows sensible numbers after a few REPL turns. `/v1/info/mcp` returns JSON. Hit rate climbs over time as the pool warms.
### Step 8: Load testing
Write a test harness that spins up `--serve` mode and fires 100 concurrent completion requests, each using a mix of 23 MCP servers, across a pool of 10 different server configurations. Assert:
- No test failures
- No orphaned subprocesses (check `ps` before and after)
- MCP spawn count stays low (hit rate >80%)
- p99 latency for the warm path is <200ms (allowing for LLM latency)
This is the practical validation that Phase 5 delivered on its performance promise.
**Verification:** Load test passes. Metrics snapshot shows expected hit rate.
### Step 9: Document tuning knobs
Update `docs/function-calling/MCP-SERVERS.md` with the new config options and tuning guidance:
- How to choose `idle_timeout` for different workloads
- When to enable health checks
- How to read the metrics
- What the `max_idle_servers` cap protects against
Add an "MCP Pool Lifecycle" section to `docs/REST-API-ARCHITECTURE.md` describing the production topology.
---
## Risks and Watch Items
| Risk | Severity | Mitigation |
|---|---|---|
| **Drop-race between `acquire` and `return_to_idle`** | Medium | The `tokio::spawn` inside Drop runs asynchronously. If an `acquire(key)` fires between Drop and the spawned task completing, it misses the idle pool and spawns fresh. Acceptable for correctness; monitor hit rate metrics, switch to the mpsc coordinator pattern if races show up in production. |
| **`Arc::try_unwrap` failing in `terminate_idle_handle`** | Medium | If something holds an extra Arc to an idle entry (shouldn't happen under normal flow), `try_unwrap` returns `Err` and we skip eviction. The entry stays in the idle map forever. Mitigation: log every such failure with a WARN. Write a test that verifies the shape never produces such extra refs. |
| **`tokio::time::interval` drift** | Low | `interval` drifts if the system is under load — a tick can be delayed. This means `cleanup_interval` is a lower bound, not a guarantee. For a 30-second interval this is irrelevant; document it. |
| **Reaper task panic** | Medium | If the reaper task panics (unreachable under normal flow, but possible under library bugs), the pool stops cleaning up. Mitigation: wrap the reaper body in `tokio::task::JoinHandle` inspection, restart on failure. Add a metric for reaper restarts. |
| **MCP server state on revival** | High | Reviving a server from idle assumes it's still in the same state it was when it went idle. Most MCP servers are stateless (they reload config on each tool call), but some might maintain in-memory state that's stale after 5 minutes of idle. Mitigation: health checks during idle provide an early warning; document that pool idle is only safe for stateless servers. |
| **Credential rotation** | High | If the user rotates their GitHub token (or any MCP-server-side credential), the idle pool entries hold the old credential baked into the subprocess env. A rotation requires restarting affected MCP servers. Mitigation: expose a `.reload mcp` REPL command and `POST /v1/mcp/reload` API that clears the idle pool, forcing fresh spawns with the new credentials on next acquire. |
| **Per-server timeout resolution** | Low | The `idle_timeout` lookup (per-server override → pool default → mode default) happens at `return_to_idle` time. Changing config at runtime won't affect already-idle entries. Document this; config reload flushes idle pool. |
| **`max_idle_servers` thrashing** | Medium | If the cap is set too low relative to the working set, every new `acquire` evicts an old idle entry, destroying the hit rate. Default to 50, document the signal: rising eviction rate + falling hit rate = raise the cap. |
| **Subprocess leak on factory drop** | High | If `AppState` (which owns `McpFactory`) drops without calling `shutdown()`, the idle pool Arc holds die, their Drops run, but the factory's Weak self-ref is already dead so nothing puts them back in idle — they just terminate via `RunningService::drop`. Verify this actually fires cleanly (not via the tokio::spawn hack). Add a test. |
---
## What Phase 5 Does NOT Do
- **No LLM response caching.** The factory pools MCP subprocesses, not LLM responses.
- **No distributed pooling.** A single factory instance owns its pool. Running multiple Loki server instances means each has its own pool; MCP processes are not shared across hosts.
- **No background server restart on crash.** If an MCP subprocess dies while idle, the reaper's health check evicts it; the next `acquire` spawns fresh. There's no "always keep N warm" preflight.
- **No OAuth token refresh for MCP.** If a server uses OAuth and its token expires during an idle period, the next `acquire` gets an expired handle. The server must handle its own refresh, or the user must rotate and `.reload mcp`.
- **No Prometheus integration.** Plain atomic counters; Prometheus support is a follow-up.
- **No adaptive tuning.** `idle_timeout` is a fixed config value, not auto-adjusted based on usage patterns.
- **No cross-process coordination.** Two Loki processes running `--serve` on the same host each have independent pools. They can't share MCP subprocesses across processes.
- **No changes to the factory's public API.** `acquire()` still takes `&McpServerKey`, still returns `McpServerHandle`. Callers don't notice Phase 5 happened.
The sole goal of Phase 5 is: **make the warm path free by keeping recently-used MCP subprocesses alive, with automatic eviction of stale ones, a background reaper, health checks, and graceful shutdown integration.**
---
## Entry Criteria (from Phase 4)
- [ ] API server runs in production-like conditions
- [ ] Concurrent request handling verified by integration tests
- [ ] `McpFactory::acquire()` is the only MCP acquisition path
- [ ] Phase 4's integration test suite passes
- [ ] `cargo check`, `cargo test`, `cargo clippy` all clean
## Exit Criteria (Phase 5 complete)
- [ ] `McpFactory` has the idle map and reaper task
- [ ] `McpServerHandleInner::Drop` returns handles to the idle pool instead of terminating
- [ ] Reaper evicts idle entries past `idle_timeout`
- [ ] `max_idle_servers` LRU cap enforced
- [ ] Optional health checks working and configurable
- [ ] Per-server `idle_timeout_seconds` overrides parsed and respected
- [ ] Mode-specific defaults (CLI/REPL = 0, API = 300) preserve pre-Phase-5 behavior
- [ ] Graceful shutdown drains the pool within the grace period
- [ ] Metrics counters exposed via `.info mcp` and `GET /v1/info/mcp`
- [ ] Load test shows hit rate >0.8 and no orphaned subprocesses
- [ ] `docs/function-calling/MCP-SERVERS.md` documents the pool config
- [ ] `docs/REST-API-ARCHITECTURE.md` "MCP Pool Lifecycle" section updated
- [ ] `cargo check`, `cargo test`, `cargo clippy` all clean
- [ ] Phase 6 (production hardening) can proceed
@@ -0,0 +1,744 @@
# Phase 6 Implementation Plan: Production Hardening
## Overview
Phase 6 closes out the refactor by picking up every "deferred to production hardening" item from Phases 15 and delivering a Loki build that's safe to run as a multi-tenant service. The preceding phases made Loki *functionally* a server — Phase 6 makes it *operationally* a server. That means real rate limiting instead of a stub, per-subject session ownership instead of flat visibility, Prometheus metrics instead of in-memory counters, structured JSON logging, deployment manifests, security headers, config validation, and operational runbooks.
This is the final phase. After it lands, Loki v1 is production-ready: you can run `loki --serve` in a container behind a reverse proxy, scrape its metrics from Prometheus, route requests through a rate limiter, and have multiple tenants share the same instance without seeing each other's data.
**Estimated effort:** ~1 week
**Risk:** Low. Most of the work is applying well-known patterns (sliding-window rate limiting, row-level authz, Prometheus, structured logging) on top of the architecture the previous phases already built. No new core types, no new pipelines.
**Depends on:** Phases 15 complete. The API server runs, MCP pool works, sessions are UUID-keyed.
---
## Why Phase 6 Exists
Phases 4 and 5 got the API server running with correct semantics, but several explicit gaps were called out as "stubs" or "follow-ups." A Phase 4 deployment is usable for a trusted single-tenant context (an internal tool, a personal server) but unsafe for anything else:
- **Anyone with a valid API key can see every session.** Phase 4 flagged this as "single-tenant-per-key." In a multi-tenant deployment where Alice and Bob both have keys, Alice can list Bob's sessions and read their messages. This is a security issue, not a feature gap.
- **No real rate limiting.** Phase 4's `max_concurrent_requests` semaphore caps parallelism but doesn't throttle per-subject request rates. A single runaway client can exhaust the whole concurrency budget.
- **No metrics for external observability.** Phase 5 added in-memory counters, but they're only reachable via the `.info mcp` dot-command or a one-shot JSON endpoint. Production needs Prometheus scraping so alerting and dashboards work.
- **Logs aren't structured.** The `tracing` spans from Phase 4 middleware emit human-readable text. Aggregators like Loki (the other one), Datadog, or CloudWatch want JSON with correlation IDs.
- **No deployment story.** There's no Dockerfile, no systemd unit, no documented way to actually run the thing in production. Every deploying team has to reinvent this.
- **Security headers missing.** Phase 4's CORS handles cross-origin; it doesn't set `X-Content-Type-Options`, `X-Frame-Options`, or similar defaults that a browser-facing endpoint should have.
- **No config validation at startup.** Mistyped config values produce runtime errors hours after deployment instead of failing fast at startup.
- **Operational procedures are undocumented.** How do you rotate auth keys? How do you reload MCP credentials? What's the runbook when the MCP hit rate drops? None of this is written down.
Phase 6 delivers answers to all of the above. It's the "you can actually deploy this" phase.
---
## What Phase 6 Delivers
Grouped by theme rather than by dependency order. Each item is independently valuable and can be worked in parallel.
### Security and isolation
1. **Per-subject session ownership** — every session records the authenticated subject that created it; reads/writes are authz-checked against the caller's subject.
2. **Scope-based authorization**`AuthContext.scopes` are enforced per endpoint (e.g., `read:sessions`, `write:sessions`, `admin:mcp`). Phase 4's middleware already populates scopes; Phase 6 adds the enforcement.
3. **JWT support** — extends `AuthConfig` with a `Jwt { issuer, audience, jwks_url }` variant that validates tokens against a JWKS endpoint and extracts subject + scopes from claims.
4. **Security headers middleware**`X-Content-Type-Options: nosniff`, `X-Frame-Options: DENY`, `Referrer-Policy: strict-origin`, optional HSTS when behind HTTPS.
5. **Audit logging** — structured audit events for every authenticated request (subject, action, target, result), written to a dedicated sink so they survive log rotation.
### Throughput and fairness
6. **Per-subject rate limiting** — sliding-window limiter keyed by subject. Enforces `rate_limit_per_minute` and related config. Returns `429 Too Many Requests` with a `Retry-After` header.
7. **Per-subject concurrency limit** — subject-scoped semaphore so one noisy neighbor can't exhaust the global concurrency budget.
8. **Backpressure signal** — expose a `/healthz/ready` endpoint that returns 503 when the server is saturated, so upstream load balancers can drain traffic.
### Observability
9. **Structured JSON logging** — every log line is JSON with `timestamp`, `level`, `target`, `request_id`, `subject`, `session_id`, and `fields`. Routes through `tracing_subscriber` with `fmt::layer().json()`.
10. **Prometheus metrics endpoint**`/metrics` exposing the existing Phase 5 counters plus new HTTP metrics (`http_requests_total`, `http_request_duration_seconds`, `http_requests_in_flight`), MCP metrics (`mcp_pool_size`, `mcp_acquire_latency_seconds` histogram), and session metrics (`sessions_active_total`, `sessions_created_total`).
11. **Liveness and readiness probes**`/healthz/live` for process liveness (always 200 unless shutting down), `/healthz/ready` for dependency readiness (config loaded, MCP pool initialized, storage writable).
### Operability
12. **Config validation at startup** — a dedicated `ApiConfig::validate()` that checks every field against a schema and fails fast with a readable error message listing *all* problems, not just the first one.
13. **SIGHUP config reload** — reloads auth keys, log level, and rate limit settings without restarting the server. Does NOT reload MCP pool config (requires restart because the pool holds live subprocesses).
14. **Dockerfile + multi-stage build** — minimal runtime image based on `debian:bookworm-slim` with the compiled binary, config directory, and non-root user.
15. **systemd service unit** — with `Type=notify`, sandboxing directives, and resource limits.
16. **docker-compose example** — for local development with nginx-as-TLS-terminator in front.
17. **Kubernetes manifests** — Deployment, Service, ConfigMap, Secret, HorizontalPodAutoscaler.
### Documentation
18. **Operational runbook** (`docs/RUNBOOK.md`) — documented procedures for common scenarios.
19. **Deployment guide** (`docs/DEPLOYMENT.md`) — end-to-end instructions for each deployment target.
20. **Security guide** (`docs/SECURITY.md`) — threat model, hardening checklist, key rotation procedures.
---
## Core Type Additions
Most of Phase 6 hangs off existing types. A few new concepts need introducing.
### `AuthContext` enrichment
Phase 4 defined `AuthContext { subject: String, scopes: Vec<String> }`. Phase 6 extends it:
```rust
pub struct AuthContext {
pub subject: String,
pub scopes: Scopes,
pub key_id: Option<String>, // for audit log correlation
pub claims: Option<JwtClaims>, // present when auth mode is Jwt
}
pub struct Scopes(HashSet<String>);
impl Scopes {
pub fn has(&self, scope: &str) -> bool;
pub fn has_any(&self, required: &[&str]) -> bool;
pub fn has_all(&self, required: &[&str]) -> bool;
}
pub enum Scope {
ReadSessions, // "read:sessions"
WriteSessions, // "write:sessions"
ReadAgents, // "read:agents"
RunAgents, // "run:agents"
ReadModels, // "read:models"
AdminMcp, // "admin:mcp"
AdminSessions, // "admin:sessions" — can see all users' sessions
}
```
The `Scope` enum provides typed constants for the well-known scope strings used in the handlers. Custom scopes (for callers to define their own access tiers) continue to work as raw strings.
### `SessionOwnership` in the session store
The session metadata needs to record who owns each session so reads/writes can be authorized:
```rust
pub struct SessionMeta {
pub id: SessionId,
pub alias: Option<SessionAlias>,
pub owner: Option<String>, // subject that created it; None = legacy
pub last_modified: SystemTime,
pub is_autoname: bool,
}
```
On disk, the ownership field goes into the session's YAML file under a reserved `_meta` block:
```yaml
_meta:
owner: "alice"
created_at: "2026-04-10T15:32:11Z"
created_by_key_id: "key_3f2a..."
# ... rest of session fields unchanged
```
The `SessionStore` trait gets two new methods and an enriched `open` signature:
```rust
#[async_trait]
pub trait SessionStore: Send + Sync {
// existing methods unchanged except:
async fn open(
&self,
agent: Option<&str>,
id: SessionId,
caller: Option<&AuthContext>, // NEW: for authz check
) -> Result<SessionHandle, StoreError>;
async fn list(
&self,
agent: Option<&str>,
caller: Option<&AuthContext>, // NEW: for filtering
) -> Result<Vec<SessionMeta>, StoreError>;
// NEW: transfer ownership (e.g., admin reassignment)
async fn set_owner(
&self,
id: SessionId,
new_owner: Option<String>,
) -> Result<(), StoreError>;
}
```
`caller: None` means internal or legacy access (CLI/REPL) — skip authz entirely. `caller: Some(...)` means an API call — enforce ownership.
**Authz rules:**
- Own session: full access.
- Other subject's session: denied unless caller has `admin:sessions` scope.
- Legacy sessions with `owner: None`: accessible to anyone (grandfathered); every mutation attempts to set the owner to the current caller so they get claimed forward.
- `list`: returns only sessions owned by the caller (or all if they have `admin:sessions`).
### `RateLimiter` and `ConcurrencyLimiter`
```rust
pub struct RateLimiter {
windows: DashMap<String, SlidingWindow>,
config: RateLimitConfig,
}
struct SlidingWindow {
bucket_a: AtomicU64,
bucket_b: AtomicU64,
last_reset: AtomicU64,
}
pub struct RateLimitConfig {
pub per_minute: u32,
pub burst: u32,
}
impl RateLimiter {
pub fn check(&self, subject: &str) -> Result<(), RateLimitError>;
}
pub struct RateLimitError {
pub retry_after: Duration,
pub limit: u32,
pub remaining: u32,
}
pub struct SubjectConcurrencyLimiter {
semaphores: DashMap<String, Arc<Semaphore>>,
per_subject: usize,
}
impl SubjectConcurrencyLimiter {
pub async fn acquire(&self, subject: &str) -> OwnedSemaphorePermit;
}
```
Both live in `ApiState` and are applied via middleware. Rate limiting runs first (cheap atomic operations), then concurrency acquisition (may block briefly).
### `MetricsRegistry`
```rust
pub struct MetricsRegistry {
pub http_requests_total: IntCounterVec,
pub http_request_duration: HistogramVec,
pub http_requests_in_flight: IntGaugeVec,
pub sessions_active: IntGauge,
pub sessions_created_total: IntCounter,
pub mcp_pool_size: IntGaugeVec,
pub mcp_acquire_latency: HistogramVec,
pub mcp_spawns_total: IntCounter,
pub mcp_idle_evictions_total: IntCounter,
pub auth_failures_total: IntCounterVec,
pub rate_limit_rejections_total: IntCounterVec,
}
```
Built on top of the `prometheus` crate. Exposed via `GET /metrics` with the Prometheus text exposition format. The registry bridges Phase 5's atomic counters into the Prometheus types without requiring Phase 5's code to change — Phase 5 keeps its simple counters, and Phase 6 reads them on each scrape to populate the Prometheus gauges.
### `AuditLogger`
```rust
pub struct AuditLogger {
sink: AuditSink,
}
pub enum AuditSink {
Stderr, // default
File { path: PathBuf, rotation: Rotation },
Syslog { facility: String },
}
pub struct AuditEvent<'a> {
pub timestamp: OffsetDateTime,
pub request_id: Uuid,
pub subject: Option<&'a str>,
pub action: AuditAction,
pub target: Option<&'a str>,
pub result: AuditResult,
pub details: Option<serde_json::Value>,
}
pub enum AuditAction {
SessionCreate,
SessionRead,
SessionUpdate,
SessionDelete,
AgentActivate,
ToolExecute,
McpReload,
ConfigReload,
AuthFailure,
RateLimitRejection,
}
pub enum AuditResult {
Success,
Denied { reason: String },
Error { message: String },
}
impl AuditLogger {
pub fn log(&self, event: AuditEvent<'_>);
}
```
Audit events are emitted from handler middleware after request completion. The audit stream is deliberately separate from the regular tracing logs because audit logs have stricter retention/integrity requirements in regulated environments — you want to be able to pipe them to a WORM storage or SIEM without mixing in debug logs.
---
## Migration Strategy
### Step 1: Per-subject session ownership
The highest-impact security fix. No new deps, no new config — just enriching existing types.
1. Add `owner: Option<String>` and `created_by_key_id: Option<String>` to the session YAML `_meta` block. Serde skip if absent (backward compat for legacy files).
2. Update `SessionStore::create` to record the caller's subject.
3. Update `SessionStore::open` to take `caller: Option<&AuthContext>` and enforce ownership.
4. Update `SessionStore::list` to filter by caller subject (unless caller has `admin:sessions` scope).
5. Add `SessionStore::set_owner` for admin reassignment.
6. Implement the "claim on first mutation" behavior for legacy sessions.
7. Update all API handlers to pass the `AuthContext` through to store calls.
8. Add integration tests: Alice creates a session, Bob tries to read it (403), admin Claire can read it (200), Alice's `list` returns only her own, Claire's `list` with `admin:sessions` scope returns everything.
**Verification:** all new authz tests pass. CLI/REPL tests still pass because they pass `caller: None`.
### Step 2: Scope-based authorization for endpoints
Phase 4's middleware attaches `AuthContext` with a `scopes: Vec<String>` field but handlers don't check it. Phase 6 adds the enforcement.
1. Change `AuthContext.scopes` from `Vec<String>` to a `Scopes(HashSet<String>)` newtype with `has`/`has_any`/`has_all` methods.
2. Define the `Scope` enum with well-known constants.
3. Add a `require_scope` helper and a `#[require_scope("read:sessions")]` proc macro (or a handler-side check if proc macros add too much complexity).
4. Annotate every handler with the required scope(s):
- `GET /v1/sessions``read:sessions`
- `POST /v1/sessions``write:sessions`
- `GET /v1/sessions/:id``read:sessions`
- `DELETE /v1/sessions/:id``write:sessions`
- `POST /v1/sessions/:id/completions``write:sessions` + `run:agents` (if the session has an agent)
- `POST /v1/rags/:name/rebuild``admin:mcp`
- `GET /v1/agents`, `/v1/roles`, `/v1/rags`, `/v1/models``read:agents`, `read:roles`, etc.
- `/metrics``admin:metrics` (or unauthenticated if the endpoint is bound to a private network)
5. Document the scope model in `docs/SECURITY.md`.
**Verification:** per-endpoint authz tests. A key with only `read:sessions` can list and read but not write.
### Step 3: JWT support in `AuthConfig`
Extend the auth mode enum:
```rust
pub enum AuthConfig {
Disabled,
StaticKeys { keys: Vec<AuthKeyEntry> },
Jwt(JwtConfig),
}
pub struct JwtConfig {
pub issuer: String,
pub audience: String,
pub jwks_url: String,
pub jwks_refresh_interval: Duration,
pub subject_claim: String, // e.g., "sub"
pub scopes_claim: String, // e.g., "scope" or "permissions"
pub leeway_seconds: u64,
}
```
1. Add `jsonwebtoken` and `reqwest` (already present) to dependencies.
2. Implement a `JwksCache` that fetches `jwks_url` on startup and refreshes every `jwks_refresh_interval`. Uses `reqwest` with a short timeout. Refreshes in the background via `tokio::spawn`.
3. The auth middleware branches on `AuthConfig`: `StaticKeys` continues to work, `Jwt` calls `jsonwebtoken::decode` with the cached JWKS.
4. Extract subject from the configured claim name. Extract scopes from either a space-separated string (`scope` claim) or an array claim (`permissions`).
5. Handle key rotation gracefully: if decoding fails with "unknown key ID," trigger an immediate JWKS refresh (debounced to once per minute) and retry once.
6. Integration tests with a fake JWKS endpoint (use `mockito` or `wiremock`).
**Verification:** valid JWT authenticates; expired JWT rejected; invalid signature rejected; JWKS refresh handles key rotation.
### Step 4: Real rate limiting
Replace the Phase 4 stub with a working sliding-window implementation.
1. Add `dashmap` dependency for the per-subject map (lock-free reads/writes).
2. Implement `SlidingWindow` with two adjacent one-minute buckets; the effective rate is the weighted sum of the current bucket plus the tail of the previous bucket based on how far into the current window we are.
3. Add `RateLimiter::check(subject) -> Result<(), RateLimitError>`.
4. Write middleware that calls `check` before dispatching to handlers. On `Err`, return 429 with `Retry-After` header.
5. Add `rate_limit_per_minute` and `rate_limit_burst` config fields. Reasonable defaults: 60/min, burst 10.
6. Expose per-subject current rate as a gauge in the Prometheus registry.
7. Integration test: fire N+1 requests as the same subject within a minute, assert the N+1th gets 429.
**Verification:** rate limiting works correctly across subjects; non-limited subjects aren't affected; burst allowance works.
### Step 5: Per-subject concurrency limiter
Complements rate limiting — rate limits the *count* of requests over time, concurrency limits the *simultaneous* count.
1. Implement `SubjectConcurrencyLimiter` with a `DashMap<String, Arc<Semaphore>>`.
2. Lazy-init semaphores per subject with `per_subject_concurrency` slots (default 8).
3. Middleware acquires a permit per request. If the subject's semaphore is full, queue briefly (`try_acquire_owned` with a short timeout), then 503 if still full.
4. Garbage-collect unused semaphores periodically (entries with no waiters and full availability count haven't been used).
5. Integration test: fire 10 concurrent requests as one subject with `per_subject_concurrency: 5`, assert at least 5 serialize.
**Verification:** no subject can exceed its concurrency budget; other subjects unaffected.
### Step 6: Prometheus metrics endpoint
1. Add `prometheus` crate.
2. Implement `MetricsRegistry` with the metrics listed in the types section.
3. Wire metric updates into existing code:
- HTTP middleware: `http_requests_total.inc()` on response, `http_request_duration.observe(elapsed)`, `http_requests_in_flight.inc()/dec()`
- Session creation: `sessions_created_total.inc()`, `sessions_active.set(store.count())`
- MCP factory: read the Phase 5 atomic counters on scrape and populate the Prometheus types
4. Add `GET /metrics` handler that writes the Prometheus text exposition format.
5. Auth policy for `/metrics`: configurable — either requires `admin:metrics` scope, or is opened to a private network via `metrics_listen_addr: "127.0.0.1:9090"` on a separate port (recommended).
6. Integration test: scrape `/metrics`, parse the response, assert expected metrics are present with sensible values.
**Verification:** Prometheus scraping works; metrics increment correctly.
### Step 7: Structured JSON logging
Replace the default `tracing_subscriber` format with JSON output.
1. Add a `log_format: Text | Json` config field, default `Text` for CLI/REPL, `Json` for `--serve` mode.
2. Configure `tracing_subscriber::fmt::layer().json()` conditionally.
3. Ensure every span has a `request_id` field (already present from Phase 4 middleware).
4. Add `subject` and `session_id` as span fields when present, so they get included in every child log line automatically.
5. Add a `log_level` config field that SIGHUP reloads at runtime (see Step 12).
6. Integration test: capture stdout during a request, parse as JSON, assert the fields are present and correctly scoped.
**Verification:** `loki --serve` produces one-line-per-event JSON output suitable for log aggregators.
### Step 8: Audit logging
Dedicated sink for security-relevant events.
1. Implement `AuditLogger` with `Stderr`, `File`, and `Syslog` sinks. Start with just `Stderr` and `File``Syslog` via `syslog` crate can follow.
2. Emit audit events from:
- Auth middleware: `AuditAction::AuthFailure` on any auth rejection
- Rate limiter: `AuditAction::RateLimitRejection` on 429
- Session handlers: `AuditAction::SessionCreate/Read/Update/Delete`
- Agent handlers: `AuditAction::AgentActivate`
- MCP reload endpoint: `AuditAction::McpReload`
3. Audit events are JSON lines with a schema documented in `docs/SECURITY.md`.
4. Audit events don't interfere with the main tracing stream — they go to the configured audit sink independently.
5. File rotation via `tracing-appender` or manual rotation with size + date cap.
**Verification:** every security-relevant action produces an audit event; failures include a `reason`.
### Step 9: Security headers and misc middleware
1. Add a `security_headers` middleware layer that attaches:
- `X-Content-Type-Options: nosniff`
- `X-Frame-Options: DENY`
- `Referrer-Policy: strict-origin-when-cross-origin`
- `Strict-Transport-Security: max-age=31536000; includeSubDomains` (only when `api.force_https: true`)
- Do NOT set CSP — this is an API, not a browser app; CSP would confuse clients.
2. Remove `Server: ...` and other fingerprinting headers.
3. Handle `OPTIONS` preflight correctly (Phase 4's CORS layer does this; verify).
**Verification:** `curl -I` inspects headers; automated test asserts each required header is present.
### Step 10: Config validation at startup
A single `ApiConfig::validate()` method that checks every field and aggregates ALL errors before failing.
1. Implement validation for:
- `listen_addr` is parseable and bindable
- `auth.mode` has a valid configuration (e.g., `StaticKeys` with non-empty key list, `Jwt` with reachable JWKS URL)
- `auth.keys[].key_hash` starts with `$argon2id$` (catches plaintext keys)
- `rate_limit_per_minute > 0` and `burst > 0`
- `max_body_bytes > 0` and `< 100 MiB` (sanity)
- `request_timeout_seconds > 0` and `< 3600`
- `shutdown_grace_seconds >= 0`
- `cors.allowed_origins` entries are valid URLs or `"*"`
2. Return a `ConfigValidationError` that lists every problem, not just the first.
3. Call `validate()` in `serve()` before binding the listener.
4. Test: a deliberately-broken config produces an error listing all problems.
**Verification:** startup validation catches common mistakes; error message is actionable.
### Step 11: Health check endpoints
1. `GET /healthz/live` — always returns 200 OK unless the process is in graceful shutdown. Body: `{"status":"ok"}`. No auth required.
2. `GET /healthz/ready` — returns 200 OK when fully initialized and not saturated, otherwise 503 Service Unavailable. Readiness criteria:
- `AppState` fully initialized
- Session store writable (attempt a probe write to a reserved path)
- MCP pool initialized (at least the factory is alive)
- Concurrency semaphore has at least 10% available (not saturated)
3. Both endpoints are unauthenticated and unmetered — load balancers hit them constantly.
4. Document in `docs/DEPLOYMENT.md` how Kubernetes, systemd, and other supervisors should use these.
**Verification:** endpoints return correct status under various load conditions.
### Step 12: SIGHUP config reload
Reload a subset of config without restarting.
1. Reloadable fields:
- Auth keys (StaticKeys mode)
- JWT config (including JWKS URL)
- Log level
- Rate limit config
- Per-subject concurrency limits
- Audit logger sink
2. NOT reloadable (requires full restart):
- Listen address
- MCP pool config (pool holds live subprocesses)
- Session storage paths
- TLS certs (use a reverse proxy)
3. Implementation: SIGHUP handler that re-reads `config.yaml`, validates it, and atomically swaps the affected fields in `ApiState`. Uses `arc-swap` crate for lock-free swaps.
4. Audit every reload: `AuditAction::ConfigReload` with before/after diff summary.
5. Document: rotation procedures for auth keys, logging level adjustments, etc.
**Verification:** start server, modify `config.yaml`, send SIGHUP, assert new config is in effect without dropped requests.
### Step 13: Deployment manifests
#### 13a. Dockerfile
Multi-stage build for a minimal runtime image:
```dockerfile
# Build stage
FROM rust:1.82-slim AS builder
WORKDIR /build
COPY Cargo.toml Cargo.lock ./
COPY src ./src
COPY assets ./assets
RUN cargo build --release --bin loki
# Runtime stage
FROM debian:bookworm-slim
RUN apt-get update && apt-get install -y --no-install-recommends \
ca-certificates \
tini \
&& rm -rf /var/lib/apt/lists/*
RUN useradd --system --home /loki --shell /bin/false loki
COPY --from=builder /build/target/release/loki /usr/local/bin/loki
COPY --from=builder /build/assets /opt/loki/assets
USER loki
WORKDIR /loki
ENV LOKI_CONFIG_DIR=/loki/config
EXPOSE 3400
ENTRYPOINT ["/usr/bin/tini", "--"]
CMD ["/usr/local/bin/loki", "--serve"]
```
Build args for targeting specific architectures. Result is a ~100 MB image.
#### 13b. systemd unit
```ini
[Unit]
Description=Loki AI Server
After=network-online.target
Wants=network-online.target
[Service]
Type=notify
ExecStart=/usr/local/bin/loki --serve
Restart=on-failure
RestartSec=5
User=loki
Group=loki
# Sandboxing
NoNewPrivileges=true
PrivateTmp=true
PrivateDevices=true
ProtectSystem=strict
ProtectHome=true
ReadWritePaths=/var/lib/loki
ProtectKernelTunables=true
ProtectKernelModules=true
ProtectControlGroups=true
RestrictSUIDSGID=true
RestrictRealtime=true
LockPersonality=true
# Resource limits
LimitNOFILE=65536
LimitNPROC=512
MemoryMax=4G
# Reload
ExecReload=/bin/kill -HUP $MAINPID
[Install]
WantedBy=multi-user.target
```
`Type=notify` requires Loki to call `sd_notify(READY=1)` after successful startup — add this with the `sd-notify` crate.
#### 13c. docker-compose example
For local development with TLS via nginx:
```yaml
version: "3.9"
services:
loki:
build: ..
environment:
LOKI_CONFIG_DIR: /loki/config
volumes:
- ./config:/loki/config:ro
- loki_data:/loki/data
ports:
- "127.0.0.1:3400:3400"
restart: unless-stopped
healthcheck:
test: [ "CMD", "curl", "-f", "http://localhost:3400/healthz/live" ]
interval: 30s
timeout: 5s
retries: 3
nginx:
image: nginx:alpine
volumes:
- ./deploy/nginx.conf:/etc/nginx/nginx.conf:ro
- ./deploy/certs:/etc/nginx/certs:ro
ports:
- "443:443"
depends_on:
- loki
volumes:
loki_data:
```
Include a sample `nginx.conf` that terminates TLS and forwards to `loki:3400`.
#### 13d. Kubernetes manifests
Provide `deploy/k8s/` with:
- `namespace.yaml`
- `deployment.yaml` (3 replicas, resource requests/limits, liveness/readiness probes)
- `service.yaml` (ClusterIP)
- `configmap.yaml` (non-secret config)
- `secret.yaml` (API keys, JWT config)
- `hpa.yaml` (HorizontalPodAutoscaler based on CPU + custom metric for requests/sec)
- `ingress.yaml` (optional example using nginx-ingress)
Document storage strategy: sessions use a PVC mounted at `/loki/data`; RAG embeddings use a read-only ConfigMap or a separate PVC.
**Verification:** each deployment target produces a running Loki that passes health checks.
### Step 14: Operational runbook
Write `docs/RUNBOOK.md` with sections for:
- **Starting and stopping** the server
- **Rotating auth keys** (StaticKeys mode) — edit config, SIGHUP, verify in audit log
- **Rotating auth keys** (Jwt mode) — update JWKS at issuer, Loki auto-refreshes
- **Rotating MCP credentials** — update env vars, `POST /v1/mcp/reload` (new endpoint in this phase) or restart
- **Diagnosing high latency** — check MCP hit rate, check LLM provider latency, check concurrency saturation
- **Diagnosing auth failures** — audit log `AuthFailure` events, check key hash, check JWKS reachability
- **Diagnosing rate limit rejections** — check per-subject counter, adjust limit or identify runaway client
- **Diagnosing orphaned MCP subprocesses** — `ps aux | grep loki`, check logs for `McpFactory shutdown complete`
- **Diagnosing session corruption** — check `.yaml.tmp` files (should not exist when server is idle), inspect session YAML for validity
- **Backup and restore** — tar the `sessions/` and `agents/` directories
- **Scaling horizontally** — each replica has its own MCP pool and session store; share sessions via shared filesystem (NFS/EFS) or deferred to a database-backed SessionStore (not in this phase)
- **Incident response** — what logs to collect, what metrics to snapshot, how to reach a minimal reproducing state
**Verification:** walk through each procedure on a test deployment; fix any unclear steps.
### Step 15: Deployment and security guides
`docs/DEPLOYMENT.md` — step-by-step for Docker, systemd, docker-compose, Kubernetes. Pre-flight checklist, first-time setup, upgrade procedure.
`docs/SECURITY.md` — threat model, hardening checklist, scope model, audit event schema, key rotation, reverse proxy configuration, network security recommendations, CVE reporting contact.
Cross-reference from `README.md` and add a "Production Deployment" section to the README that points to both docs.
**Verification:** a developer unfamiliar with Loki can deploy it successfully using only the docs.
---
## Risks and Watch Items
| Risk | Severity | Mitigation |
|---|---|---|
| **Session ownership migration breaks legacy users** | Medium | Legacy sessions with `owner: None` stay readable by anyone; they get claimed forward on first mutation. Document this in `RUNBOOK.md`. Add a one-shot migration CLI command (`loki migrate sessions --claim-to <subject>`) that assigns ownership of all unowned sessions to a specific subject. |
| **JWT JWKS fetch failures block startup** | Medium | JWKS URL must be reachable at startup; if it's not, log an error and fall back to "reject all" mode until the fetch succeeds. A retry loop with exponential backoff runs in the background. Do NOT crash on JWKS failure. |
| **Rate limiter DashMap growth** | Low | Per-subject windows accumulate forever without cleanup. Add a background reaper that removes entries with zero recent activity every few minutes. Cap total entries at 100k as a safety valve. |
| **Prometheus metric cardinality explosion** | Low | `http_requests_total` with per-path labels could explode if routes have dynamic segments (`/v1/sessions/:id`). Use route templates as labels, not concrete paths. Validate label sets at registration. |
| **Audit log retention compliance** | Low | Audit logs might need to be retained for regulatory reasons. Phase 6 provides the emission; retention is the operator's responsibility. Document this in `SECURITY.md`. |
| **SIGHUP reload partial failure** | Medium | If the new config is invalid, don't swap it in — keep the old config running. Log the validation error. The operator can fix the file and SIGHUP again. Never leave the server in an inconsistent state. |
| **Docker image size** | Low | `debian:bookworm-slim` is ~80 MB; final image ~100 MB. If smaller is needed, use `distroless/cc-debian12` for a ~35 MB image at the cost of not having `tini` or debugging tools. Document both options. |
| **systemd Type=notify missing implementation** | Medium | Adding `sd_notify` requires the `sd-notify` crate AND calling it after listener bind. Missing this call makes systemd think the service failed. Add an integration test that fakes systemd and asserts the notification is sent. |
| **Kubernetes pod disruption** | Low | HPA scales down during low traffic, but in-flight requests on the terminating pod must complete gracefully. Set `terminationGracePeriodSeconds` to at least `shutdown_grace_seconds + 10`. Document in `DEPLOYMENT.md`. |
| **Running under a reverse proxy** | Low | CORS, `Host` header handling, `X-Forwarded-For` for rate limiter subject identification. Document the expected proxy config (trust `X-Forwarded-*` headers only from trusted proxies). |
---
## What Phase 6 Does NOT Do
- **No multi-region replication.** Loki is a single-instance service; scale out by running multiple instances behind a load balancer, each with its own pool. Cross-instance state sharing is not in scope.
- **No database-backed session store.** `FileSessionStore` is still the only implementation. A `PostgresSessionStore` is a clean extension point (`SessionStore` trait is already there) but belongs to a follow-up.
- **No cluster coordination.** Each Loki instance is independent. Running Loki in a "cluster" mode where instances share work is a separate project.
- **No advanced ML observability.** LLM call costs, token usage trends, provider error rates — these are tracked as counters but not aggregated into dashboards. Follow-up work.
- **No built-in TLS termination.** Use a reverse proxy (nginx, Caddy, Traefik, a cloud load balancer). Supporting TLS in-process adds complexity and key management concerns that reverse proxies solve better.
- **No SAML or LDAP.** Only StaticKeys and JWT. SAML/LDAP integration can extend `AuthConfig` later.
- **No plugin system.** Extensions to auth, storage, or middleware require forking and rebuilding. A dynamic plugin loader is explicitly out of scope.
- **No multi-tenancy beyond session ownership.** Tenants share the same process, same MCP pool, same RAG cache, same resources. Strict tenant isolation (separate processes per tenant) requires orchestration outside Loki.
- **No cost accounting per tenant.** LLM API calls are tracked per-subject in audit logs but not aggregated into billing-grade cost reports.
---
## Entry Criteria (from Phase 5)
- [ ] `McpFactory` pooling works and has metrics
- [ ] Graceful shutdown drains the MCP pool
- [ ] Phase 5 load test passes (hit rate >0.8, no orphaned subprocesses)
- [ ] Phase 4 API integration test suite passes
- [ ] `cargo check`, `cargo test`, `cargo clippy` all clean
## Exit Criteria (Phase 6 complete — v1 ready)
- [ ] Per-subject session ownership enforced; integration tests prove Alice can't read Bob's sessions
- [ ] Scope-based authorization enforced on every endpoint
- [ ] JWT authentication works with a real JWKS endpoint
- [ ] Real rate limiting replaces the Phase 4 stub; 429 responses include `Retry-After`
- [ ] Per-subject concurrency limiter prevents noisy-neighbor saturation
- [ ] Prometheus `/metrics` endpoint scrapes cleanly
- [ ] Structured JSON logs emitted in `--serve` mode
- [ ] Audit events written for all security-relevant actions
- [ ] Security headers set on all responses
- [ ] Config validation fails fast at startup with readable errors
- [ ] `/healthz/live` and `/healthz/ready` endpoints work
- [ ] SIGHUP reloads auth keys, log level, and rate limits without restart
- [ ] Dockerfile produces a minimal runtime image
- [ ] systemd unit with `Type=notify` works correctly
- [ ] docker-compose example runs end-to-end with TLS via nginx
- [ ] Kubernetes manifests deploy successfully
- [ ] `docs/RUNBOOK.md` covers all common operational scenarios
- [ ] `docs/DEPLOYMENT.md` guides a first-time deployer to success
- [ ] `docs/SECURITY.md` documents threat model, scopes, and hardening
- [ ] `cargo check`, `cargo test`, `cargo clippy` all clean
- [ ] End-to-end production smoke test: deploy to Kubernetes, send real traffic, scrape metrics, rotate a key, induce a failure, observe recovery
---
## v1 Release Summary
After Phase 6 lands, Loki v1 has transformed from a single-user CLI tool into a production-ready multi-tenant AI service. Here's what the v1 release notes should say:
**New in Loki v1:**
- **REST API** — full HTTP surface for completions, sessions, agents, roles, RAGs, and metadata. Streaming via Server-Sent Events, synchronous via JSON.
- **Multi-tenant sessions** — UUID-primary identity with optional human-readable aliases. Per-subject ownership with scope-based access control.
- **Concurrent safety** — per-session mutex serialization, per-MCP-server Arc sharing, per-agent runtime isolation. Run dozens of concurrent requests without corruption.
- **MCP pooling** — recently-used MCP subprocesses stay warm across requests. Near-zero warm-path latency. Configurable idle timeout and LRU cap.
- **Authentication** — static API keys or JWT with JWKS. Argon2-hashed credentials. Scope-based authorization per endpoint.
- **Observability** — Prometheus metrics, structured JSON logging with correlation IDs, dedicated audit log stream.
- **Rate limiting** — sliding-window per subject with configurable limits and burst allowance.
- **Graceful shutdown** — in-flight requests complete within a grace period; MCP subprocesses terminate cleanly; session state is persisted.
- **Deployment manifests** — Dockerfile, systemd unit, docker-compose example, Kubernetes manifests.
- **Full documentation** — runbook, deployment guide, security guide, API reference.
**Backward compatibility:**
CLI and REPL continue to work identically to pre-v1 builds. Existing `config.yaml`, `roles/`, `sessions/`, `agents/`, `rags/`, and `functions/` directories are read-compatible. The legacy session layout is migrated lazily on first access without destroying the old files.
**What's next (v2+):**
- Database-backed session store for cross-instance sharing
- Native TLS termination option
- SAML / LDAP authentication extensions
- Per-tenant cost accounting and quotas
- Dynamic plugin system for custom auth, storage, and middleware
- Multi-region replication
- WebSocket transport alongside SSE
+232
View File
@@ -0,0 +1,232 @@
# Loki QA Checklist
Behavioral verification checklist for the REST API refactor.
Run after each step or phase to confirm existing functionality
is preserved.
## How to use
- [ ] = not yet verified for current step
- [x] = verified working
- SKIP = not applicable to current step
Check each item manually in the REPL and/or CLI. If a check
fails, stop and investigate before proceeding.
---
## 1. Build & Test Baseline
- [ ] `cargo check` — zero warnings, zero errors
- [ ] `cargo clippy` — zero warnings
- [ ] `cargo test` — all tests pass (63 as of Step 8g)
## 2. CLI — Basic Operations
- [ ] `loki "hello"` — single-shot chat works, response printed
- [ ] `loki --role <name> "hello"` — role applied, response uses role context
- [ ] `loki --session <name> "hello"` — session created/resumed, response saved
- [ ] `loki --model <model_id> "hello"` — specified model used
- [ ] `loki --prompt "you are a pirate" "hello"` — temp role applied
- [ ] `loki --info` — system info printed, exits cleanly
- [ ] `loki --list-models` — model list printed
- [ ] `loki --list-roles` — role list printed (no hidden files)
- [ ] `loki --list-sessions` — session list printed
- [ ] `loki --list-agents` — agent list printed (no `.shared` directory)
- [ ] `loki --dry-run "hello"` — no API call, input echoed
- [ ] `loki --no-stream "hello"` — non-streaming response
## 3. CLI — File Input
- [ ] `loki --file /tmp/test.txt "summarize"` — file content included
- [ ] `loki --file /tmp/test.txt` — file content sent without extra text
## 4. CLI — Agent (non-interactive)
- [ ] `loki --agent <name> "do something"` — agent starts, tools available, response returned
- [ ] Agent MCP servers start (if configured)
- [ ] Agent tool calls execute correctly (e.g., execute_command)
## 5. CLI — Shell Execute
- [ ] `loki -e "list files in /tmp"` — shell command generated
- [ ] Shell command explanation shown (describe mode)
- [ ] Shell command execution works when confirmed
## 6. CLI — Macro
- [ ] `loki --macro <name> "input"` — macro executes
## 7. REPL — Startup & Exit
- [ ] `loki` — REPL starts, welcome message shown
- [ ] `.exit` — REPL exits cleanly
- [ ] Ctrl+D — REPL exits cleanly
- [ ] Ctrl+C — prints exit hint, does not exit
## 8. REPL — Chat
- [ ] Type a message — response printed
- [ ] `.continue` — continues previous response
- [ ] `.regenerate` — regenerates last response
- [ ] `.copy` — copies last response to clipboard
## 9. REPL — Roles
- [ ] `.role <name>` — switches to role, prompt changes
- [ ] `.role <name> <text>` — one-shot role message
- [ ] `.info role` — shows role info
- [ ] `.edit role` — opens editor for current role
- [ ] `.save role <name>` — saves current role
- [ ] `.exit role` — exits role, prompt resets
- [ ] Role with MCP servers — servers start on `.role <name>`
- [ ] Role with MCP servers — MCP tools available in chat
- [ ] `.exit role` with MCP — servers stop, MCP tools removed
## 10. REPL — Sessions
- [ ] `.session` — starts temp session
- [ ] `.session <name>` — starts/resumes named session
- [ ] `.info session` — shows session info
- [ ] `.edit session` — opens editor
- [ ] `.save session <name>` — saves session
- [ ] `.empty session` — clears messages
- [ ] `.compress session` — compresses session
- [ ] `.exit session` — exits session
- [ ] Session with MCP servers — servers start
- [ ] Session carry-over prompt — "incorporate last Q&A?" appears when applicable
## 11. REPL — Agents
- [ ] `.agent <name>` — agent starts, tools compiled, prompt changes
- [ ] `.agent <name> <session>` — agent starts with specific session
- [ ] `.agent <name> key=value` — agent starts with variables
- [ ] `.info agent` — shows agent info
- [ ] `.starter` — shows conversation starters
- [ ] `.starter <n>` — executes starter
- [ ] `.edit agent-config` — opens agent config editor
- [ ] `.exit agent` — exits agent cleanly
- [ ] Agent with MCP servers — servers start
- [ ] Agent tool calls work (execute_command, fs_read, etc.)
- [ ] Agent global tools work (tools listed in `global_tools`)
- [ ] Agent tool file changes picked up on restart (delete .ts, .sh used instead)
- [ ] Auto-continuation works (todo list drives continuation)
- [ ] `.clear todo` — clears todo list
## 12. REPL — Sub-Agent Escalation
- [ ] Parent agent spawns sub-agent via tool call
- [ ] Sub-agent runs at depth > 0
- [ ] Sub-agent escalation: sub-agent calls user__ask → parent gets notification
- [ ] Parent calls agent__reply_escalation → sub-agent unblocked, resumes
- [ ] Multiple pending escalations shown in notification
- [ ] Max depth enforcement — sub-agent spawn rejected beyond max_agent_depth
## 13. REPL — RAG
- [ ] `.rag <name>` — initializes/loads RAG
- [ ] `.info rag` — shows RAG info
- [ ] `.sources rag` — shows citation sources
- [ ] `.edit rag-docs` — modify RAG documents
- [ ] `.rebuild rag` — rebuilds RAG index
- [ ] `.exit rag` — exits RAG
- [ ] RAG embeddings used in chat (search results included)
## 14. REPL — MCP Servers
- [ ] MCP servers start at REPL init (if globally enabled)
- [ ] `.set enabled_mcp_servers <name>` — changes active servers
- [ ] `.set mcp_server_support true/false` — toggles support
- [ ] MCP tool invocation works (mcp__invoke_<server>)
- [ ] MCP tool search works (mcp__search_<server>)
- [ ] MCP tool describe works (mcp__describe_<server>)
## 15. REPL — Settings
- [ ] `.set temperature 0.5` — changes temperature
- [ ] `.set top_p 0.9` — changes top_p
- [ ] `.set model <name>` — changes model
- [ ] `.set dry_run true` — enables dry run
- [ ] `.set stream false` — disables streaming
- [ ] `.set save true/false` — toggles save
- [ ] `.set highlight true/false` — toggles highlighting
- [ ] `.set save_session true/false/null` — changes session save behavior
- [ ] `.set compression_threshold <n>` — changes threshold
## 16. REPL — Tab Completion
- [ ] `.role<TAB>` — shows role names (no hidden files)
- [ ] `.agent<TAB>` — shows agent names (no `.shared` directory)
- [ ] `.session<TAB>` — shows session names
- [ ] `.rag<TAB>` — shows RAG names
- [ ] `.macro<TAB>` — shows macro names
- [ ] `.model<TAB>` — shows model names with descriptions
- [ ] `.set <TAB>` — shows setting names
- [ ] `.set temperature <TAB>` — shows current value
- [ ] `.set enabled_tools <TAB>` — shows tool names
- [ ] `.set enabled_mcp_servers <TAB>` — shows server names
## 17. REPL — Delete
- [ ] `.delete role <name>` — deletes role
- [ ] `.delete session <name>` — deletes session
- [ ] `.delete rag <name>` — deletes RAG
- [ ] `.delete macro <name>` — deletes macro
- [ ] `.delete agent-data <name>` — deletes agent data
## 18. REPL — Vault
- [ ] `.vault list` — lists secrets
- [ ] `.vault add <name>` — adds secret
- [ ] `.vault get <name>` — retrieves secret
- [ ] `.vault update <name>` — updates secret
- [ ] `.vault delete <name>` — deletes secret
## 19. REPL — Prelude
- [ ] `repl_prelude: "role:coder"` — auto-loads role on REPL start
- [ ] `repl_prelude: "session:mysession"` — auto-loads session
- [ ] `repl_prelude: "mysession:coder"` — auto-loads session with role
## 20. REPL — Miscellaneous
- [ ] `.help` — shows help text
- [ ] `.info` — shows system info
- [ ] `.authenticate` — OAuth flow (if configured)
- [ ] `.file <path>` — includes file in next message
- [ ] `.file <url>` — fetches URL content
- [ ] Unknown command — shows error message
- [ ] Multi-line input (:::) — works correctly
- [ ] Ctrl+O — opens editor for input buffer
## 21. Session Compression & Autoname
- [ ] Session auto-compression triggers when threshold exceeded
- [ ] Compression message shown ("Compressing the session.")
- [ ] Session auto-naming triggers for new sessions
- [ ] Auto-continuation after compression works (agent resumes)
## 22. Error Handling
- [ ] Invalid role name — error shown, REPL continues
- [ ] Invalid model name — error shown, REPL continues
- [ ] Network error during chat — error shown, REPL continues
- [ ] MCP server crash — error shown, REPL continues
- [ ] Tool execution failure — error returned to LLM as tool result
---
## Phase-specific notes
### Phase 1 (Steps 3-10): Config split into AppState + RequestContext
Known bridge-window limitations (acceptable until Steps 9-10):
- `ReplCompleter`/`ReplPrompt` still hold `GlobalConfig`
- `Input` still holds `GlobalConfig` internally
- `eval_tool_calls` still takes `&GlobalConfig`
- Dual sync (`sync_ctx_to_config`/`sync_config_to_ctx`) required
### Post-Phase 1 verification focus:
- All items above should work identically to pre-refactor behavior
- No new warnings or errors in build
- Performance should be equivalent (no observable slowdown)
+572
View File
@@ -0,0 +1,572 @@
# Architecture Plan: Loki REST API Service Mode
## The Core Problem
Today, Loki's `Config` struct is a god object — it holds both server-wide configuration (LLM providers, vault, tool definitions) and per-interaction mutable state (current role, session, agent, supervisor, inbox, tool tracker) in one `Arc<RwLock<Config>>`. CLI and REPL both mutate this singleton directly. Adding a third interface (REST API) that handles concurrent users makes this untenable.
## Design Pattern: Engine + Context + Emitter
The refactor splits Loki into three layers:
```
┌─────────┐ ┌─────────┐ ┌─────────┐
│ CLI │ │ REPL │ │ API │ ← Thin adapters (frontends)
└────┬────┘ └────┬────┘ └────┬────┘
│ │ │
▼ ▼ ▼
┌──────────────────────────────┐
│ RunRequest + Emitter │ ← Uniform request shape
└──────────────┬───────────────┘
┌──────────────────────────────┐
│ Engine::run() │ ← Single core entrypoint
│ (input → messages → LLM │
│ → tool loop → events) │
└──────────────┬───────────────┘
┌────────────┼────────────┐
▼ ▼ ▼
AppState RequestContext SessionStore
(global, (per-request, (file-backed,
immutable) mutable) per-session lock)
```
---
## 1. Split Config → AppState (global) + RequestContext (per-request)
### AppState — created once at startup, wrapped in `Arc`, never mutated during requests:
```rust
#[derive(Clone)]
pub struct AppState {
pub config: Arc<AppConfig>, // deserialized config.yaml (frozen)
pub providers: ProviderRegistry, // LLM client configs + OAuth tokens
pub vault: Arc<VaultService>, // encrypted credential storage (internal locking)
pub tools: Arc<ToolRegistry>, // tool definitions, function dirs, visible_tools
pub mcp_global: Arc<McpGlobalConfig>, // global MCP settings (not live instances)
pub sessions: Arc<dyn SessionStore>, // file-backed session persistence
pub rag_defaults: RagDefaults, // embedding model, chunk size, etc.
}
```
### RequestContext — created per CLI invocation, per REPL turn, or per API request:
```rust
pub struct RequestContext {
pub app: Arc<AppState>, // borrows global state
pub request_id: Uuid,
pub mode: FrontendMode, // Cli | Repl | Api
pub cancel: CancellationToken, // unified cancellation
// per-request mutable state (was on Config)
pub session: SessionHandle,
pub convo: ConversationState, // messages, last_message, tool_call_tracker
pub agent: Option<AgentRuntime>, // supervisor, MCP instances, inbox, escalation
pub overrides: Overrides, // model, role, rag, dry_run, etc.
pub auth: Option<AuthContext>, // API-only; None for CLI/REPL
}
pub struct Overrides {
pub role: Option<String>,
pub model: Option<String>,
pub rag: Option<RagConfig>,
pub agent: Option<AgentSpec>,
pub dry_run: bool,
pub macro_mode: bool,
}
```
### What changes for existing code
Every function that currently takes `&GlobalConfig` (i.e., `Arc<RwLock<Config>>`) and calls `.read()` / `.write()` gets refactored to take `&AppState` for reads and `&mut RequestContext` for mutations. The `config.write().set_model(...)` pattern becomes `ctx.overrides.model = Some(...)`.
### REPL special case
The REPL keeps a long-lived `RequestContext` that persists across turns (just like today's Config singleton does). State-changing dot-commands (`.model`, `.role`, `.session`) mutate the REPL's own context. This preserves current behavior exactly.
---
## 2. Unified Dispatch: The Engine
Instead of `start_directive()` in `main.rs` and `ask()` in `repl/mod.rs` being separate code paths, both call one core function:
```rust
pub struct Engine {
pub app: Arc<AppState>,
pub agent_factory: Arc<dyn AgentFactory>,
}
impl Engine {
pub async fn run(
&self,
ctx: &mut RequestContext,
req: RunRequest,
emitter: &dyn Emitter,
) -> Result<RunOutcome, CoreError> {
// 1. Apply any CoreCommand (set role, model, session, etc.)
// 2. Build Input from req.input + ctx (role messages, session history, RAG)
// 3. Create LLM client from provider registry
// 4. call_chat_completions[_streaming](), emitting events via emitter
// 5. Tool result loop (recursive)
// 6. Persist session updates
// 7. Return outcome (session_id, message_id)
}
}
pub struct RunRequest {
pub input: UserInput, // text, files, media
pub command: Option<CoreCommand>, // normalized dot-command
pub stream: bool,
}
pub enum CoreCommand {
SetRole(String),
SetModel(String),
StartSession { name: Option<String> },
StartAgent { name: String, variables: HashMap<String, String> },
Continue,
Regenerate,
CompressSession,
Info,
// ... one variant per REPL dot-command
}
```
### How frontends use it
| Frontend | Context lifetime | How it calls Engine |
|---|---|---|
| CLI | Single invocation, then exit | Creates `RequestContext`, calls `engine.run()` once, exits |
| REPL | Long-lived across turns | Keeps `RequestContext`, calls `engine.run()` per line, dot-commands become `CoreCommand` variants |
| API | Per HTTP request, but session persists | Loads `RequestContext` from `SessionStore` per request, calls `engine.run()`, persists back |
---
## 3. Output Abstraction: The Emitter Trait
The core never writes to stdout or formats JSON. It emits structured semantic events:
```rust
pub enum Event<'a> {
Started { request_id: Uuid, session_id: Uuid },
AssistantDelta(&'a str), // streaming token
AssistantMessageEnd { full_text: &'a str },
ToolCall { name: &'a str, args: &'a str },
ToolResult { name: &'a str, result: &'a str },
Info(&'a str),
Error(CoreError),
}
#[async_trait]
pub trait Emitter: Send + Sync {
async fn emit(&self, event: Event<'_>) -> Result<(), EmitError>;
}
```
### Three implementations
- **`TerminalEmitter`** — wraps the existing `SseHandler``markdown_stream` / `raw_stream` logic. Renders to terminal with crossterm. Used by both CLI and REPL.
- **`JsonEmitter`** — collects all events, returns a JSON response body at the end. Used by non-streaming API requests.
- **`SseEmitter`** — converts each `Event` to an SSE frame, pushes into a `tokio::sync::mpsc` channel that axum streams to the client. Used by streaming API requests.
---
## 4. Session Isolation for API
### Session IDs
UUID-based for API consumers. CLI/REPL keep human-readable names as aliases.
```rust
#[async_trait]
pub trait SessionStore: Send + Sync {
async fn create(&self, alias: Option<&str>) -> Result<SessionHandle>;
async fn open(&self, id: SessionId) -> Result<SessionHandle>;
async fn open_by_name(&self, name: &str) -> Result<SessionHandle>; // CLI/REPL compat
}
```
### File layout
```
~/.config/loki/sessions/
by-id/<uuid>/state.yaml # canonical storage
by-name/<name> -> <uuid> # symlink or mapping file for CLI/REPL
```
### Concurrency
Each `SessionHandle` holds a `tokio::sync::Mutex` so two concurrent API requests to the same session serialize properly. For v1 this is sufficient — no need for a database.
---
## 5. Tool Scope Isolation (formerly "Agent Isolation")
**Correction:** An earlier version of this document singled out agents as the owner of "live tool and MCP runtime." That was wrong. Loki allows MCP servers and tools to be configured at **every** `RoleLike` level — global, role, session, and agent — with resolution priority `Agent > Session > Role > Global`. Agents aren't uniquely coupled to MCP lifecycle; they're just the most visibly coupled scope in today's code.
The correct abstraction is **`ToolScope`**: every active `RoleLike` owns one. A `ToolScope` is a self-contained unit holding the resolved function declarations, live MCP runtime handles, and the tool-call tracker for whichever scope is currently on top of the stack.
### Today's behavior (to match in v1)
`McpRegistry::reinit()` is already **diff-based**: given a new enabled-server list, it stops only the servers that are no longer needed, leaves still-needed ones alive, and starts only the missing ones. This is correct single-tenant behavior but the registry is a process-wide singleton, so two concurrent consumers with different MCP sets trample each other.
### Target design
```rust
pub struct ToolScope {
pub functions: Functions, // resolved declarations for this scope
pub mcp_runtime: McpRuntime, // live handles to MCP processes
pub tool_tracker: ToolCallTracker, // per-scope call tracking
}
pub struct McpRuntime {
servers: HashMap<String, Arc<McpServerHandle>>, // live, ref-counted
}
pub struct McpFactory {
shared_servers: Mutex<HashMap<McpServerKey, Weak<McpServerHandle>>>,
}
impl McpFactory {
/// Produce a runtime with handles for the requested enabled servers.
/// Shared across ToolScopes via Arc when configs match; isolated when they differ.
pub async fn build_runtime(&self, enabled: &[String]) -> Result<McpRuntime>;
}
```
**`McpFactory` lives on `AppState`.** It does NOT hold any live servers itself — it holds weak refs so that when the last `ToolScope` using a given server drops its `Arc`, the process is torn down.
**`ToolScope` lives on `RequestContext`.** It replaces the current `functions`, `tool_call_tracker`, and (implicit) global `mcp_registry` fields. Every active scope — whether that's "just the REPL with its global MCP set" or "an agent with its own MCP set" — owns exactly one `ToolScope`.
### Scope transitions
When a `RoleLike` activates or exits:
1. Resolve the effective enabled-tool and enabled-MCP-server lists using priority `Agent > Session > Role > Global`.
2. Ask `McpFactory::build_runtime(enabled)` for an `McpRuntime`. The factory reuses existing `Arc<McpServerHandle>`s where keys match; spawns new processes where they don't.
3. Construct a new `ToolScope` with the runtime + resolved `Functions`.
4. Assign it to `ctx.tool_scope`. The old `ToolScope` drops; any `Arc<McpServerHandle>`s with no other references shut down their processes.
This preserves today's diff-based behavior for single-tenant (REPL) and makes it correct for multi-tenant (API).
### Sharing vs isolation (the key property)
`McpServerKey` encodes server name + command + args + env vars. Two `ToolScope`s requesting the **same key** share the same `Arc<McpServerHandle>`. Two requesting **different keys** (e.g., different per-user API keys baked into the env) get separate processes. This gives us:
- **Isolation by default** — different configs = different processes, no cross-tenant leakage
- **Sharing by coincidence** — identical configs = one process, ref-counted
- **Clean cleanup** — processes die automatically when the last scope releases them
### Agent-specific state
Agents still own some state that's genuinely agent-only (not in `ToolScope`): the supervisor, inbox, escalation queue, optional todo list, sub-agent handles, and the parent/child tree. That state lives in an `AgentRuntime`:
```rust
pub struct AgentRuntime {
pub spec: AgentSpec,
pub rag: Option<Arc<Rag>>, // shared across sibling sub-agents
pub supervisor: Supervisor,
pub inbox: Arc<Inbox>,
pub escalation_queue: Arc<EscalationQueue>, // root-shared for user interaction
pub todo_list: Option<TodoList>, // present only when auto_continue: true
pub self_agent_id: String,
pub parent_supervisor: Option<Arc<Supervisor>>,
pub current_depth: usize,
pub auto_continue_count: usize,
}
```
Three things to notice in this shape:
1. **`todo_list: Option<TodoList>`** — today's code eagerly allocates a `TodoList::default()` for every agent, but the todo tools and auto-continuation prompts are only exposed when `auto_continue: true`. Switching to `Option` lets us skip the allocation entirely for agents that don't opt in, and makes the "is this agent using todos?" question a type-level check rather than a config lookup. The semantics users see are unchanged.
2. **`rag: Option<Arc<Rag>>`** — agent RAG is an `Arc`, not an owned `Rag`. Today, every sub-agent of the same type independently calls `Rag::load()` and deserializes its own copy of the embeddings from disk. That means a parent spawning 4 parallel siblings of the same agent type pays the deserialize cost 5 times and holds 5 copies of identical vectors in memory. Sharing via `Arc` fixes both.
3. **No `mcp_runtime`** — MCP lives on `ToolScope`, not here. Agents get their tools through `ctx.tool_scope` like everyone else.
An `AgentRuntime` goes into `ctx.agent_runtime` **in addition to** the `ToolScope` — they're orthogonal concerns. An agent has both a `ToolScope` (its resolved tools + MCP) and an `AgentRuntime` (its supervision/messaging/RAG/todo state).
### RAG Cache (unified for standalone + agent RAG)
RAG in Loki comes from exactly two places today:
1. **Standalone RAG**, attached via the `.rag <name>` REPL command or the equivalent API call. Persists across role/session switches. Lives in `ctx.rag: Option<Arc<Rag>>`.
2. **Agent RAG**, loaded from the `documents:` field of an agent's `config.yaml` when the agent is activated. Lives in `ctx.agent_runtime.rag: Option<Arc<Rag>>` for the agent's lifetime.
Roles and Sessions do **not** own RAG — the `Role` and `Session` structs have no RAG fields. This is true today and the refactor preserves it.
Since both standalone and agent RAGs are ultimately `Arc<Rag>` instances loaded from disk YAML files, a single cache can serve both. `AppState` holds one:
```rust
pub struct AppState {
pub config: Arc<AppConfig>,
pub vault: GlobalVault,
pub mcp_factory: Arc<McpFactory>,
pub rag_cache: Arc<RagCache>,
}
pub struct RagCache {
entries: RwLock<HashMap<RagKey, Weak<Rag>>>,
}
#[derive(Hash, Eq, PartialEq, Clone, Debug)]
pub enum RagKey {
Named(String), // standalone RAG: rags/<name>.yaml
Agent(String), // agent-owned RAG: agents/<name>/rag.yaml
}
impl RagCache {
/// Returns a shared Arc<Rag> for the given key. If another scope
/// holds a live reference, returns that exact Arc. Otherwise loads
/// from disk, stores a Weak for future sharing, returns a fresh Arc.
/// Concurrent first-load is serialized via per-key locks.
pub async fn load(&self, key: &RagKey) -> Result<Option<Arc<Rag>>>;
/// Invalidates the cache entry. Called by rebuild_rag / edit_rag_docs
/// so the next load reads from disk. Does NOT affect existing Arc
/// holders — they keep their old Rag until they drop it.
pub fn invalidate(&self, key: &RagKey);
}
```
Why the enum: agent RAGs and standalone RAGs live at different paths on disk and could theoretically have overlapping names (an agent called "docs" and a standalone rag called "docs"). Keeping them in distinct namespaces avoids collisions and keeps the cache lookups unambiguous.
Why `Weak`: we don't want the cache to pin RAGs in memory forever. If no scope holds an `Arc<Rag>` for key X, the `Weak` becomes dangling, and the next `load()` reads fresh. "Share while in use, drop when nobody needs it" without a manual reaper.
**Concurrency wrinkle:** if two consumers request the same key at exactly the same time and neither finds a live entry, both will race to load from disk. Fix with per-key `tokio::sync::Mutex` or `once_cell::sync::OnceCell<Arc<Rag>>` — the second caller blocks briefly and receives the shared Arc.
**Invalidation:** both `rebuild_rag` and `edit_rag_docs` call `invalidate()` with the key corresponding to whichever RAG was being operated on (standalone or agent-owned). Existing `Arc<Rag>` holders keep their old reference until they drop it — which is the correct behavior, since you don't want a running request to suddenly see a partially-rebuilt index mid-execution.
### Where RAG attaches in `RequestContext`
Two distinct slots, two distinct purposes, one shared cache:
```rust
pub struct RequestContext {
// ... other fields ...
pub rag: Option<Arc<Rag>>, // standalone RAG from `.rag <name>` or API equivalent
pub agent_runtime: Option<AgentRuntime>, // contains its own `rag: Option<Arc<Rag>>` when agent owns one
}
```
When resolving "what RAG should this request use", the engine checks `ctx.agent_runtime.rag` first (agent-owned takes precedence during an agent turn), then falls back to `ctx.rag` (the user's standalone selection). If neither is set, no RAG context is injected into the prompt.
**Behavior preservation:** today's code uses a single `Config.rag` slot that's overwritten by whichever action touched it most recently — `use_rag` and `use_agent` both clobber it. Exiting an agent leaves the overwrite in place; the user has to re-run `.rag <name>` to restore their standalone RAG. The new two-slot design gives us the opportunity to fix that (save `ctx.rag` into the `AgentRuntime` on activation, restore on exit) but **Phase 1 preserves today's clobber-and-forget behavior** to keep the refactor mechanical. The improvement is flagged as a Phase 2+ enhancement.
### Sub-agent spawning
Each child agent gets its **own** `RequestContext` forked from the parent's `Arc<AppState>`. That means each child gets:
- Its own `ToolScope` built from its agent.yaml's `mcp_servers` + `global_tools`, produced by `McpFactory`
- Its own `AgentRuntime` with a fresh supervisor, a fresh inbox, depth = parent.depth + 1
- A `parent_supervisor` reference pointing back at the parent's supervisor for escalation/messaging
- A shared `root_escalation_queue` cloned by `Arc` from the parent's runtime (one queue, one human at the root)
- A shared `rag: Option<Arc<Rag>>` via `AppState.rag_cache.load(RagKey::Agent(child_agent_name))` — if the parent already holds a strong ref, the cache returns the same Arc and no disk I/O happens
Because each child has its own `ToolScope`, **concurrent sub-agents can run with different MCP server sets simultaneously** — something today's singleton registry cannot do. The `McpFactory` pool handles overlap: if child A and child B both need `github` with matching keys, they share one `github` process via `Arc`.
Because sibling sub-agents of the same type share one `Arc<Rag>` through the unified cache, **RAG embeddings are loaded at most once per (standalone or agent) name per process**, regardless of how many siblings or concurrent API sessions reference the same name. The first holder keeps the embeddings warm for everyone else's lifetime, and they drop together once nobody holds a reference.
### MCP Lifecycle Policy (pooling and idle timeout)
`McpFactory` needs an eviction policy so long-running server processes don't accumulate idle MCP subprocesses indefinitely. The design is a two-layer scheme:
```rust
pub struct McpFactory {
active: Mutex<HashMap<McpServerKey, Weak<McpServerHandle>>>,
idle: Mutex<HashMap<McpServerKey, IdleEntry>>,
config: McpFactoryConfig,
}
struct IdleEntry {
handle: Arc<McpServerHandle>,
idle_since: Instant,
}
pub struct McpFactoryConfig {
pub idle_timeout: Duration, // how long idle servers stay warm
pub cleanup_interval: Duration, // how often the reaper runs
pub max_idle_servers: Option<usize>, // LRU cap (None = unbounded)
}
```
**Layer 1 — active references via Arc.** Scopes currently using a server hold `Arc<McpServerHandle>`. Standard Rust refcounting. Any live reference keeps the process running, regardless of timers.
**Layer 2 — idle grace period via LRU eviction.** When the last active scope drops its Arc, a custom `Drop` impl on the handle moves it into the idle pool with a timestamp instead of tearing it down immediately. A background reaper task wakes on `cleanup_interval` and evicts entries whose idle time exceeds `idle_timeout`, calling `cancel().await` on the actual MCP subprocess.
Acquisition order on every scope transition:
```rust
impl McpFactory {
pub async fn acquire(&self, key: &McpServerKey) -> Result<Arc<McpServerHandle>> {
// 1. Someone else is actively using it — share.
if let Some(arc) = self.try_reuse_active(key) { return Ok(arc); }
// 2. Sitting in the idle pool — revive it, zero startup cost.
if let Some(arc) = self.revive_from_idle(key) { return Ok(arc); }
// 3. Neither — spawn fresh.
self.spawn_new(key).await
}
}
```
**Sensible defaults by deployment mode:**
| Mode | `idle_timeout` default | Rationale |
|---|---|---|
| CLI one-shot | N/A (process exits, everything dies) | No pooling needed |
| REPL | `0` (immediate drop) | Matches today's reactive reinit behavior |
| API server | `5 minutes` | Absorbs burst traffic, caps stale resources |
These are defaults, not mandates. Users should be able to override globally and per-server:
```yaml
# config.yaml
mcp_pool:
idle_timeout_seconds: 300
cleanup_interval_seconds: 30
max_idle_servers: 50
```
```json
// functions/mcp.json
{
"github": { "command": "...", "idle_timeout_seconds": 900 },
"filesystem": { "command": "...", "idle_timeout_seconds": 60 }
}
```
**Optional health checks.** While a handle sits in the idle pool, the reaper can optionally ping it via `tools/list`. If a server has crashed or become unresponsive, it's evicted immediately. Without this, a stale idle entry would make the first real request after revival fail. Worth implementing, but not strictly required for v1.
**Graceful shutdown.** On server shutdown, drain active scopes (let in-flight LLM calls complete or cancel via token), then tear down the idle pool. Give it a bounded drain timeout before force-killing. Especially important for MCP servers holding external transactions or locks.
**Per-tenant isolation.** `McpServerKey` includes env vars in its hash, so two tenants with different `GITHUB_TOKEN`s get distinct keys and therefore distinct processes. Zero cross-tenant leakage by construction.
### Phasing
Phase 1 ships `McpFactory` without the pool — just `acquire()` that always spawns fresh, `Drop` that always tears down. This is correct but inefficient. Phase 5 adds the idle pool, reaper task, health checks, and configuration knobs. Splitting it this way keeps Phase 1 focused on the state split (its actual goal) and Phase 5 focused on the pooling optimization (where it has a clear performance target: warm-path MCP tool calls should have near-zero overhead).
### Lifecycle summary
| Frontend | ToolScope lifetime | AgentRuntime lifetime | RAG lifetime |
|---|---|---|---|
| **CLI one-shot** | One invocation | One invocation (if `--agent`) | One invocation |
| **REPL** | Long-lived, rebuilt on `.role` / `.session` / `.agent` / `.set enabled_mcp_servers` | Lives from `.agent X` until `.exit agent` | Standalone RAG set via `.rag <name>` persists across role/session switches; agent RAG lives as long as the `AgentRuntime`; both come from the shared `RagCache` |
| **API session** | Lives while session is "warm"; rebuilt when client changes role/session/agent | Lives while session is "warm" | Same as REPL; `RagCache` shares `Arc<Rag>`s across concurrent sessions using the same RAG name |
| **Sub-agent (any frontend)** | Lives for the sub-agent task | Lives for the sub-agent task | Shared via `Arc` with parent and siblings through `RagCache` |
---
## 6. Cross-Cutting Concerns
| Concern | Pattern | CLI | REPL | API |
|---|---|---|---|---|
| **Errors** | Core returns `CoreError` enum; frontends map | `render_error()` to stderr | `render_error()` to terminal | `{ "error": { "code": "...", "message": "..." } }` JSON |
| **Cancellation** | `CancellationToken` in `RequestContext` | Ctrl-C handler triggers token | Ctrl-C triggers token | Client disconnect / request timeout triggers token |
| **Auth** | Middleware sets `AuthContext` on `RequestContext` | None (local user) | None (local user) | Bearer token / API key validated by axum middleware |
| **Tracing** | `tracing::Span` per request with request_id, session_id, mode | Log to file | Log to file | Log to file + structured JSON logs |
### Error type
```rust
pub enum CoreError {
InvalidRequest { msg: String },
NotFound { msg: String },
Unauthorized { msg: String },
Forbidden { msg: String },
Timeout { msg: String },
Cancelled,
Provider { msg: String },
Tool { msg: String },
Io { msg: String },
}
```
### Cancellation
Use a `CancellationToken` in `RequestContext`. The core checks it via `tokio::select!` around long awaits (LLM stream, tool execution, MCP IO).
- CLI/REPL: Ctrl-C handler triggers token.
- API: axum provides disconnect detection for SSE/streaming; when the client drops, cancel the token.
- Timeouts: set deadline and translate to token cancellation.
### Auth (API-only initially)
axum middleware authenticates (API key / bearer token), builds `AuthContext`, stores in request extensions, then the handler copies it into `RequestContext`. Core enforces policy only when executing sensitive operations (tools, filesystem, vault).
```rust
pub struct AuthContext {
pub subject: String,
pub scopes: Vec<String>,
}
```
---
## 7. API Endpoint Design
```
POST /v1/completions # one-shot prompt (no session)
POST /v1/sessions # create session
POST /v1/sessions/:id/completions # prompt within session
DELETE /v1/sessions/:id # close session
POST /v1/sessions/:id/agent # activate agent on session
DELETE /v1/sessions/:id/agent # deactivate agent
POST /v1/sessions/:id/role # set role on session
POST /v1/sessions/:id/rag # attach RAG to session
GET /v1/models # list available models
GET /v1/agents # list available agents
GET /v1/roles # list available roles
```
### Request body for completions
```json
{
"prompt": "Explain TCP handshake",
"model": "openai:gpt-4o",
"stream": true,
"files": ["path/to/doc.pdf"],
"role": "explain"
}
```
---
## 8. Implementation Phases
| Phase | Scope | Effort | Risk |
|---|---|---|---|
| **Phase 1: Extract AppState** | Split Config into AppState (global) + per-request state. Keep CLI/REPL working exactly as before. No API yet. | ~1-2 weeks | Medium — touching every file that uses GlobalConfig |
| **Phase 2: Introduce Engine + Emitter** | Unify `start_directive()` and `ask()` behind `Engine::run()`. Create `TerminalEmitter`. CLI/REPL now call Engine. | ~1 week | Low — refactoring existing paths |
| **Phase 3: SessionStore abstraction** | Extract session persistence behind trait. Add UUID-based sessions. CLI/REPL still use name-based aliases. | ~3-5 days | Low |
| **Phase 4: REST API server** | Add `--serve` flag. axum handlers that create `RequestContext`, call `Engine::run()`, return JSON/SSE. Basic auth middleware. | ~1-2 weeks | Low — clean layer on top of Engine |
| **Phase 5: Agent isolation** | Move agent runtime into `RequestContext`. `AgentFactory` creates isolated runtimes per session. | ~1 week | Medium — MCP server lifecycle mgmt |
| **Phase 6: Production hardening** | Rate limiting, proper auth, request validation, health checks, graceful shutdown, deployment configs. | ~1 week | Low |
**Total estimate: ~5-7 weeks** for a production-ready v1.
### Key Risk: Phase 1
Phase 1 is the hardest and riskiest — it touches nearly every module. The mitigation is to do it incrementally: first add `AppState` alongside existing `Config`, then migrate callers module by module, then remove the old `GlobalConfig` type alias. Tests should pass at every intermediate step.
---
## Key Design Decisions & Trade-offs
1. **Eliminates the singleton mutation bottleneck**: concurrency becomes "multiple `RequestContext`s" rather than fighting over `RwLock<Config>`.
2. **Preserves current behavior**: REPL can keep "state-changing commands" by mutating its own long-lived `RequestContext` + persisted `SessionState`.
3. **Streaming becomes portable**: terminal rendering, JSON, and SSE are just different `Emitter`s over the same event stream.
4. **Agent/MCP isolation is explicit**: prevents cross-session conflicts by construction.
## Watch Out For
1. **Persisted vs in-memory drift**: decide which fields live in `SessionState` vs `ConversationState`; persist only what must survive process restarts.
2. **Per-session concurrency semantics**: either serialize requests per session (simplest) or carefully merge message histories; v1 should serialize.
3. **MCP process lifecycle**: if you keep MCP servers alive across requests, tie them to a session runtime and clean them up on session close/TTL.
## Future Considerations
1. Swap file store behind `SessionStore` with sqlite without changing core.
2. Add a stable public API schema for events so clients can render rich tool-call UIs.
3. Actor model (one tokio task per session receiving commands via mpsc) for simplified session+agent lifetime management.
@@ -0,0 +1,255 @@
# Phase 1 Step 1 — Implementation Notes
## Status
Done.
## Plan reference
- Plan: `docs/PHASE-1-IMPLEMENTATION-PLAN.md`
- Section: "Step 1: Make Config constructible from AppConfig + RequestContext"
## Summary
Added three conversion methods on `Config` (`to_app_config`,
`to_request_context`, `from_parts`) plus a round-trip test suite, all
living in a new `src/config/bridge.rs` module. These methods are the
facade that will let Steps 29 migrate callsites from the old `Config`
to the split `AppState` + `RequestContext` incrementally. Nothing calls
them outside the test suite yet; that's expected and matches the
plan's "additive only, no callsite changes" guidance for Step 1.
## Pre-Step-1 correction to Step 0
Before implementing Step 1 I verified all three Step 0 files
(`src/config/app_config.rs`, `src/config/app_state.rs`,
`src/config/request_context.rs`) against every architecture decision
from the design conversations. All three were current except one stale
reference:
- `src/config/request_context.rs` docstring said "unified into
`ToolScope` during Phase 1 Step 6" but after the
ToolScope/AgentRuntime discussions the plan renumbered this to
**Step 6.5** and added the `AgentRuntime` collapse alongside
`ToolScope`. Updated the `# Tool scope (planned)` section docstring
to reflect both changes (now titled `# Tool scope and agent runtime
(planned)`).
No other Step 0 changes were needed.
## What was changed
### New files
- **`src/config/bridge.rs`** (~430 lines including tests)
- Module docstring explaining the bridge's purpose, scheduled
deletion in Step 10, and the lossy `mcp_registry` field.
- `impl Config` block with three public methods, scoped under
`#[allow(dead_code)]`:
- `to_app_config(&self) -> AppConfig` — borrow, returns fresh
`AppConfig` by cloning the 40 serialized fields.
- `to_request_context(&self, app: Arc<AppState>) -> RequestContext`
— borrow + provided `AppState`, returns fresh `RequestContext`
by cloning the 19 runtime fields held on both types.
- `from_parts(app: &AppState, ctx: &RequestContext) -> Config`
borrow both halves, returns a new owned `Config`. Sets
`mcp_registry: None` because no split type holds it.
- `#[cfg(test)] mod tests` with 4 unit tests:
- `to_app_config_copies_every_serialized_field`
- `to_request_context_copies_every_runtime_field`
- `round_trip_preserves_all_non_lossy_fields`
- `round_trip_default_config`
- Helper `build_populated_config()` that sets every primitive /
`String` / simple `Option` field to a non-default value so a
missed field in the conversion methods produces a test failure.
### Modified files
- **`src/config/mod.rs`** — added `mod bridge;` declaration (one
line, inserted alphabetically between `app_state` and `input`).
- **`src/config/request_context.rs`** — updated the "Tool scope
(planned)" docstring section to correctly reference Phase 1
**Step 6.5** (not Step 6) and to mention the `AgentRuntime`
collapse alongside `ToolScope`. No code changes.
## Key decisions
### 1. The bridge lives in its own module
I put the conversion methods in `src/config/bridge.rs` rather than
adding them inline to `src/config/mod.rs`. The plan calls for this
entire bridge to be deleted in Step 10, and isolating it in one file
makes that deletion a single `rm` + one `mod bridge;` line removal in
`mod.rs`. Adding ~300 lines to the already-massive `mod.rs` would have
made the eventual cleanup harder.
### 2. `mcp_registry` is lossy by design (documented)
`Config.mcp_registry: Option<McpRegistry>` has no home in either
`AppConfig` (serialized settings only) or `RequestContext` (runtime
state that doesn't include MCP, per Step 6.5's `ToolScope` design).
I considered three options:
1. **Add a temporary `mcp_registry` field to `RequestContext`** — ugly,
introduces state that has to be cleaned up in Step 6.5 anyway.
2. **Accept lossy round-trip, document it** — chosen.
3. **Store `mcp_registry` on `AppState` temporarily** — dishonest,
contradicts the plan which says MCP isn't process-wide.
Option 2 aligns with the plan's direction. The lossy field is
documented in three places so no caller is surprised:
- Module-level docstring (`# Lossy fields` section)
- `from_parts` method docstring
- Inline comment next to the `is_none()` assertion in the round-trip
test
Any Step 29 callsite that still needs the registry during its
migration window must keep a reference to the original `Config`
rather than relying on round-trip fidelity.
### 3. `#[allow(dead_code)]` scoped to the whole `impl Config` block
Applied to the `impl` block in `bridge.rs` rather than individually to
each method. All three methods are dead until Step 2+ starts calling
them. When the first caller migrates, I'll narrow the allow to the
methods that are still unused. By Step 10 the whole file is deleted
and the allow goes with it.
### 4. Populated-config builder skips domain-type runtime fields
`build_populated_config()` sets every primitive, `String`, and simple
`Option` field to a non-default value. It does **not** try to construct
real `Role`, `Session`, `Agent`, `Supervisor`, `Inbox`, or
`EscalationQueue` instances because those have complex async/setup
lifecycles and constructors don't exist for test use.
The round-trip tests still exercise the clone path for all those
`Option<T>` fields — they just exercise the `None` variant. The tests
prove that (a) if a runtime field is set, the conversion clones it
correctly (which is guaranteed by Rust's `#[derive(Clone)]` on
`Config`), and (b) `None` roundtrips to `None`. Deeper coverage with
populated domain types would require mock constructors that don't
exist in the current code, making it a meaningful scope increase
unsuitable for Step 1's "additive, mechanical" goal.
### 5. The test covers `Config::default()` separately from the
populated builder
A separate `round_trip_default_config` test catches any subtle "the
default doesn't roundtrip" bug that `build_populated_config` might
mask by always setting fields to non-defaults. Both tests run through
the same `to_app_config → to_request_context → from_parts` pipeline.
## Deviations from plan
None of substance. The plan's Step 1 description was three sentences
and a pseudocode block; the implementation matches it field-for-field
except for two clarifications the plan didn't specify:
1. **Which module holds the methods** — the plan didn't say. I chose a
dedicated `src/config/bridge.rs` file (see Key Decision #1).
2. **How `mcp_registry` is handled in round-trip** — the plan's
pseudocode said `from_parts` "merges back" but didn't address the
field that has no home. I chose lossy reconstruction with
documented behavior (see Key Decision #2).
Both clarifications are additive — they don't change what Step 1
accomplishes, they just pin down details the plan left implicit.
## Verification
### Compilation
- `cargo check` — clean, zero warnings. The expected dead-code warning
from the new methods is suppressed by `#[allow(dead_code)]` on the
`impl` block.
### Tests
- `cargo test bridge` — 4 new tests pass:
- `config::bridge::tests::round_trip_default_config`
- `config::bridge::tests::to_app_config_copies_every_serialized_field`
- `config::bridge::tests::to_request_context_copies_every_runtime_field`
- `config::bridge::tests::round_trip_preserves_all_non_lossy_fields`
- `cargo test` — full suite passes: **63 passed, 0 failed**
(59 pre-existing + 4 new).
### Manual smoke test
Not applicable — Step 1 is additive only, no runtime behavior changed.
CLI and REPL continue working through the original `Config` code
paths, unchanged.
## Handoff to next step
### What Step 2 can rely on
Step 2 (migrate ~30 static methods off `Config` to a `paths` module)
can rely on all of the following being true:
- `Config::to_app_config()`, `Config::to_request_context(app)`, and
`Config::from_parts(app, ctx)` all exist and are tested.
- The three new types (`AppConfig`, `AppState`, `RequestContext`) are
fully defined and compile.
- Nothing in the codebase outside `src/config/bridge.rs` currently
calls the new methods, so Step 2 is free to start using them
wherever convenient without fighting existing callers.
- `AppState` only has two fields: `config: Arc<AppConfig>` and
`vault: GlobalVault`. No `mcp_factory`, no `rag_cache` yet — those
land in Step 6.5.
- `RequestContext` has flat fields mirroring the runtime half of
today's `Config`. The `ToolScope` / `AgentRuntime` unification
happens in Step 6.5, not earlier. Step 2 should not try to
pre-group fields.
### What Step 2 should watch for
- **Static methods on `Config` with no `&self` parameter** are the
Step 2 target. The Phase 1 plan lists ~33 of them in a table
(`config_dir`, `local_path`, `cache_path`, etc.). Each gets moved
to a new `src/config/paths.rs` module (or similar), with forwarding
`#[deprecated]` methods left behind on `Config` until Step 2 is
fully done.
- **`vault_password_file`** on `Config` is private (not `pub`), but
`vault_password_file` on `AppConfig` is `pub(crate)`. `bridge.rs`
accesses both directly because it's a sibling module under
`src/config/`. If Step 2's path functions need to read
`vault_password_file` from `AppConfig` they can do so directly
within the `config` module, but callers outside the module will
need an accessor method.
- **`Config.mcp_registry` round-trip is lossy.** If any static method
moved in Step 2 touches `mcp_registry` (unlikely — none of the ~33
static methods listed in the plan do), that method should NOT use
the bridge — it should keep operating on the original `Config`.
Double-check the list before migrating.
### What Step 2 should NOT do
- Don't delete the bridge. It's still needed for Steps 39.
- Don't narrow `#[allow(dead_code)]` on `impl Config` in `bridge.rs`
yet — Step 2 might start using some of the methods but not all,
and the allow-scope should be adjusted once (at the end of Step 2)
rather than incrementally.
- Don't touch the `request_context.rs` `# Tool scope and agent
runtime (planned)` docstring. It's accurate and Step 6.5 is still
far off.
### Files to re-read at the start of Step 2
- `docs/PHASE-1-IMPLEMENTATION-PLAN.md` — Step 2 section has the
full static-method migration table.
- This notes file (`PHASE-1-STEP-1-NOTES.md`) — for the bridge's
current shape and the `mcp_registry` lossy-field context.
- `src/config/bridge.rs` — for the exact method signatures available.
## References
- Phase 1 plan: `docs/PHASE-1-IMPLEMENTATION-PLAN.md`
- Architecture doc: `docs/REST-API-ARCHITECTURE.md`
- Step 0 files: `src/config/app_config.rs`, `src/config/app_state.rs`,
`src/config/request_context.rs`
- Step 1 files: `src/config/bridge.rs`, `src/config/mod.rs` (mod
declaration), `src/config/request_context.rs` (docstring fix)
@@ -0,0 +1,111 @@
# Phase 1 Step 10 — Implementation Notes
## Status
Done. Client chain migrated. `GlobalConfig` reduced to runtime-only
usage (tool evaluation chain + REPL sync).
## Summary
Migrated the entire client chain away from `GlobalConfig`:
- `Client` trait: `global_config()``app_config()`
- Client structs: `GlobalConfig``Arc<AppConfig>`
- `init_client`: `&GlobalConfig``&Arc<AppConfig>`
- `Input` struct: removed `config: GlobalConfig` field entirely
- `Rag`: deleted `build_temp_global_config` bridge
- `render_stream`: `&GlobalConfig``&AppConfig`
- `Config::search_rag`: `&GlobalConfig``&AppConfig`
- `call_chat_completions*`: explicit `runtime: &GlobalConfig` parameter
## What was changed
### Files modified (10 files)
- **`src/client/macros.rs`** — client structs hold `Arc<AppConfig>`,
`init` takes `&Arc<AppConfig>`, `init_client` takes
`&Arc<AppConfig>` + `Model`. Zero GlobalConfig in file.
- **`src/client/common.rs`** — `Client` trait: `app_config() -> &AppConfig`.
`call_chat_completions*` take explicit `runtime: &GlobalConfig`.
- **`src/config/input.rs`** — removed `config: GlobalConfig` field.
Added `rag: Option<Arc<Rag>>` captured at construction. Changed
`set_regenerate` to take `current_role: Role` parameter. Zero
`self.config` references.
- **`src/config/mod.rs`** — `search_rag` takes `&AppConfig`. Deleted
dead `rag_template` method.
- **`src/render/mod.rs`** — `render_stream` takes `&AppConfig`. Zero
GlobalConfig in file.
- **`src/rag/mod.rs`** — deleted `build_temp_global_config`. Creates
clients via `init_client(&self.app_config, model)`. Zero
GlobalConfig in file.
- **`src/main.rs`** — updated `call_chat_completions*` calls with
explicit `runtime` parameter.
- **`src/repl/mod.rs`** — updated `call_chat_completions*` calls,
`set_regenerate` call with `current_role` parameter.
- **`src/function/supervisor.rs`** — updated `call_chat_completions`
call in `run_child_agent`.
- **`src/config/app_config.rs`** — no changes (already had all
needed fields).
## Remaining GlobalConfig usage (71 references)
| Category | Files | Count | Why |
|---|---|---|---|
| Definition | `config/mod.rs` | 13 | Config struct, GlobalConfig alias, methods called by REPL |
| Tool eval chain | `function/mod.rs` | 8 | `eval_tool_calls(&GlobalConfig)`, `ToolCall::eval(&GlobalConfig)` |
| Tool handlers | `function/supervisor.rs` | 17 | All handler signatures |
| Tool handlers | `function/todo.rs` | 2 | Todo handler signatures |
| Tool handlers | `function/user_interaction.rs` | 3 | User interaction handler signatures |
| Runtime param | `client/common.rs` | 3 | `call_chat_completions*(runtime: &GlobalConfig)` |
| Input construction | `config/input.rs` | 4 | Constructor params + capture_input_config |
| REPL | `repl/mod.rs` | 10 | Input construction, ask, sync helpers |
| REPL components | `repl/completer.rs` | 3 | Holds GlobalConfig for reedline |
| REPL components | `repl/prompt.rs` | 3 | Holds GlobalConfig for reedline |
| REPL components | `repl/highlighter.rs` | 2 | Holds GlobalConfig for reedline |
| Bridge | `config/request_context.rs` | 1 | `to_global_config()` |
| Bridge | `config/macros.rs` | 2 | `macro_execute` takes &GlobalConfig |
The remaining GlobalConfig usage falls into 3 categories:
1. **Tool evaluation chain** (30 refs) — `eval_tool_calls` and
handlers read runtime state from GlobalConfig
2. **REPL** (18 refs) — sync helpers, Input construction, reedline
3. **Definition** (13 refs) — the Config struct itself
## Phase 1 final completion summary
Phase 1 is now complete. Every module that CAN be migrated HAS been
migrated. The remaining GlobalConfig usage is the tool evaluation
chain (which reads runtime state during active tool calls) and the
REPL sync layer (which bridges RequestContext to GlobalConfig for
the tool chain).
### Key achievements
- `Input` no longer holds `GlobalConfig`
- Client structs no longer hold `GlobalConfig`
- `Rag` has zero `GlobalConfig` references
- `render_stream` takes `&AppConfig`
- `Agent::init` takes `&AppConfig` + `&AppState`
- Both entry points thread `RequestContext`
- 64+ methods on `RequestContext`, 21+ on `AppConfig`
- Zero regressions: 63 tests, zero warnings, zero clippy issues
### What Phase 2 starts with
Phase 2 can build REST API endpoints using `AppState` + `RequestContext`
directly. The tool evaluation chain will need to be migrated from
`&GlobalConfig` to `&mut RequestContext` when REST API tool calls
are implemented — at that point, `Config` and `GlobalConfig` can
be fully deleted.
## Verification
- `cargo check` — zero warnings, zero errors
- `cargo clippy` — zero warnings
- `cargo test` — 63 passed, 0 failed
@@ -0,0 +1,131 @@
# Phase 1 Step 14 — Implementation Notes
## Status
Done.
## Plan reference
- Plan: `docs/PHASE-1-IMPLEMENTATION-PLAN.md`
- Section: "Step 14: Migrate `Input` constructors and REPL"
## Summary
Eliminated `GlobalConfig` from every file except `config/mod.rs`
(where the type is defined). `Input` constructors take
`&RequestContext`. REPL holds `Arc<RwLock<RequestContext>>` instead
of `GlobalConfig`. Reedline components read from shared
`RequestContext`. Sync helpers deleted. `to_global_config()` deleted.
`macro_execute` takes `&mut RequestContext`. Implemented
`RequestContext::use_agent`. Added MCP loading spinner, MCP server
tab completions, and filtered internal tools from completions.
## What was changed
### Files modified
- **`src/config/input.rs`** — constructors take `&RequestContext`
instead of `&GlobalConfig`. `capture_input_config` and
`resolve_role` read from `RequestContext`/`AppConfig`.
- **`src/config/request_context.rs`** — added `use_agent()` method.
Deleted `to_global_config()` and `sync_mcp_from_registry()`.
Added MCP loading spinner in `rebuild_tool_scope`. Added
configured MCP servers to `.set enabled_mcp_servers` completions.
Filtered `user__*`, `mcp_*`, `todo__*`, `agent__*` from
`.set enabled_tools` completions.
- **`src/repl/mod.rs`** — `Repl` struct holds
`Arc<RwLock<RequestContext>>`, no `GlobalConfig` field. `ask` and
`run_repl_command` take `&mut RequestContext` only. Deleted
`sync_ctx_to_config`, `sync_config_to_ctx`,
`sync_app_config_to_ctx`, `reinit_mcp_registry`.
- **`src/repl/completer.rs`** — holds
`Arc<RwLock<RequestContext>>` instead of `GlobalConfig`.
- **`src/repl/prompt.rs`** — holds `Arc<RwLock<RequestContext>>`
instead of `GlobalConfig`.
- **`src/repl/highlighter.rs`** — updated if it held `GlobalConfig`.
- **`src/config/macros.rs`** — `macro_execute` takes
`&mut RequestContext` instead of `&GlobalConfig`.
- **`src/main.rs`** — all `to_global_config()` calls eliminated.
Agent path uses `ctx.use_agent()`. Macro path passes
`&mut ctx` directly.
### Methods added
- `RequestContext::use_agent(app, name, session, abort_signal)`
calls `Agent::init`, sets up MCP via `rebuild_tool_scope`,
sets agent/rag/supervisor, starts session.
### Methods deleted
- `RequestContext::to_global_config()`
- `RequestContext::sync_mcp_from_registry()`
- REPL: `sync_ctx_to_config`, `sync_config_to_ctx`,
`sync_app_config_to_ctx`, `reinit_mcp_registry`
### UX improvements
- MCP loading spinner restored in `rebuild_tool_scope`
- `.set enabled_mcp_servers<TAB>` shows configured servers from
`mcp.json` + mapping aliases
- `.set enabled_tools<TAB>` hides internal tools (`user__*`,
`mcp_*`, `todo__*`, `agent__*`)
## GlobalConfig remaining
Only `src/config/mod.rs` (13 references): type definition, legacy
`Config::use_agent`, `Config::use_session_safely`,
`Config::use_role_safely`, `Config::update`, `Config::delete` — all
dead code. Step 15 deletes them.
## Post-implementation review (Oracle)
Oracle reviewed all REPL and CLI flows. Findings:
1. **AbortSignal not threaded through rebuild_tool_scope**
FIXED. `rebuild_tool_scope`, `bootstrap_tools`, `use_role`,
`use_session`, `use_agent`, `update` now all thread the real
`AbortSignal` through to the MCP loading spinner. Ctrl+C
properly cancels MCP server loading.
2. **RwLock held across await in REPL** — KNOWN LIMITATION.
`Repl::run` holds `ctx.write()` for the duration of
`run_repl_command`. This is safe in the current design because
reedline's prompt/completion is synchronous (runs between line
reads, before the write lock is taken). Phase 2 should refactor
to owned `RequestContext` + lightweight snapshot for reedline.
3. **MCP subprocess leaks** — NOT AN ISSUE. `rmcp::RunningService`
has a `DropGuard` that cancels the tokio cancellation token on
Drop. Servers are killed when their `Arc<ConnectedServer>`
refcount hits zero.
4. **MCP duplication** — NOT AN ISSUE after Step 14. The
`initial_global` sync was removed. MCP runtime is populated
only by `rebuild_tool_scope``McpFactory::acquire`, which
deduplicates via `Weak` references.
5. **Agent+session MCP override** — PRE-EXISTING behavior, not
a regression. When an agent session has its own MCP config,
it takes precedence. Supervisor child agents handle this
explicitly via `populate_agent_mcp_runtime`.
6. **Stale Input in tool loop** — PRE-EXISTING design. Input
captures state at construction time and uses `merge_tool_results`
for continuations. Tools communicate results via tool results,
not by mutating the session mid-turn. Not a regression.
7. **Auto-compression** — REPL does inline compression in `ask`.
CLI directive path relies on session save which happens in
`after_chat_completion`. Consistent with pre-migration behavior.
## Verification
- `cargo check` — 6 dead-code warnings (legacy Config methods)
- `cargo test` — 63 passed, 0 failed
@@ -0,0 +1,138 @@
# Phase 1 Step 15 — Implementation Notes
## Status
Done. Phase 1 complete.
## Plan reference
- Plan: `docs/PHASE-1-IMPLEMENTATION-PLAN.md`
- Section: "Step 15: Delete `Config` struct and `GlobalConfig`"
## Summary
Deleted `GlobalConfig` type alias and all dead `Config` methods.
Deleted `Config::from_parts` and bridge tests. Moved 8 flat
runtime fields from `RequestContext` into `ToolScope` and
`AgentRuntime`. `RequestContext` is now a clean composition of
well-scoped state structs.
## What was changed
### Dead code deletion
- `GlobalConfig` type alias — deleted
- `Config::from_parts` — deleted
- All bridge.rs tests — deleted
- Dead `Config` methods — deleted (use_agent, use_session_safely,
use_role_safely, update, delete, and associated helpers)
- Dead `McpRegistry` methods (search_tools_server, describe,
invoke) — deleted
- Dead `Functions` methods — deleted
- Unused imports cleaned across all files
### Field migrations
**From `RequestContext` to `ToolScope`:**
- `functions: Functions``tool_scope.functions` (was duplicated)
- `tool_call_tracker: Option<ToolCallTracker>``tool_scope.tool_tracker`
**From `RequestContext` to `AgentRuntime`:**
- `supervisor: Option<Arc<RwLock<Supervisor>>>``agent_runtime.supervisor`
- `parent_supervisor: Option<Arc<RwLock<Supervisor>>>``agent_runtime.parent_supervisor`
- `self_agent_id: Option<String>``agent_runtime.self_agent_id`
- `current_depth: usize``agent_runtime.current_depth`
- `inbox: Option<Arc<Inbox>>``agent_runtime.inbox`
- `root_escalation_queue: Option<Arc<EscalationQueue>>``agent_runtime.escalation_queue`
### RequestContext accessors added
Accessor methods on `RequestContext` provide the same API:
- `current_depth()` → returns `agent_runtime.current_depth` or 0
- `supervisor()` → returns `agent_runtime.supervisor` or None
- `parent_supervisor()` → returns agent_runtime.parent_supervisor or None
- `self_agent_id()` → returns agent_runtime.self_agent_id or None
- `inbox()` → returns agent_runtime.inbox or None
- `root_escalation_queue()` → returns agent_runtime.escalation_queue or None
### AgentRuntime changes
All fields made `Option` to support agents without spawning
capability (no supervisor), root agents without inboxes, and
lazy escalation queue creation.
### Files modified
- `src/config/request_context.rs` — removed 8 flat fields, added
accessors, updated all internal methods
- `src/config/tool_scope.rs` — removed `#![allow(dead_code)]`
- `src/config/agent_runtime.rs` — made fields Optional, removed
`#![allow(dead_code)]`, added `Default` impl
- `src/config/bridge.rs` — deleted `from_parts`, tests; updated
`to_request_context` to build `AgentRuntime`
- `src/config/mod.rs` — deleted `GlobalConfig`, dead methods,
dead runtime fields
- `src/function/mod.rs``ctx.tool_scope.functions`,
`ctx.tool_scope.tool_tracker`
- `src/function/supervisor.rs` — agent_runtime construction,
accessor methods
- `src/function/user_interaction.rs` — accessor methods
- `src/function/todo.rs` — agent_runtime access
- `src/client/common.rs``ctx.tool_scope.tool_tracker`
- `src/config/macros.rs` — agent_runtime construction
- `src/repl/mod.rs` — tool_scope/agent_runtime access
- `src/main.rs` — agent_runtime for startup path
- `src/mcp/mod.rs` — deleted dead methods
## RequestContext final structure
```rust
pub struct RequestContext {
// Shared immutable state
pub app: Arc<AppState>,
// Per-request identity
pub macro_flag: bool,
pub info_flag: bool,
pub working_mode: WorkingMode,
// Current model
pub model: Model,
// Active scope state
pub role: Option<Role>,
pub session: Option<Session>,
pub rag: Option<Arc<Rag>>,
pub agent: Option<Agent>,
pub agent_variables: Option<AgentVariables>,
pub last_message: Option<LastMessage>,
// Tool runtime (functions + MCP + tracker)
pub tool_scope: ToolScope,
// Agent runtime (supervisor + inbox + escalation + depth)
pub agent_runtime: Option<AgentRuntime>,
}
```
## Verification
- `cargo check` — zero warnings, zero errors
- `cargo test` — 59 passed, 0 failed
- `GlobalConfig` references — zero across entire codebase
- Flat runtime fields on RequestContext — zero (all moved)
## Phase 1 complete
The monolithic `Config` god-state struct has been broken apart:
| Struct | Purpose | Lifetime |
|---|---|---|
| `AppConfig` | Serialized config from YAML | Immutable, shared |
| `AppState` | Process-wide shared state (vault, MCP factory, RAG cache) | Immutable, shared via Arc |
| `RequestContext` | Per-request mutable state | Owned per request |
| `ToolScope` | Active tool declarations + MCP runtime + call tracker | Per scope transition |
| `AgentRuntime` | Agent-specific wiring (supervisor, inbox, escalation) | Per agent activation |
The codebase is ready for Phase 2: REST API endpoints that create
`RequestContext` per-request from shared `AppState`.
@@ -0,0 +1,443 @@
# Phase 1 Step 16 — Implementation Notes
## Status
Pending. Architecture plan approved; ready for sub-phase execution.
## Plan reference
- Plan: `docs/PHASE-1-IMPLEMENTATION-PLAN.md`
- Section: "Step 16: Complete Config → AppConfig Migration (Post-QA)"
## Problem
The current startup flow mutates `Config` during `Config::init()`,
then converts it to `AppConfig` via `bridge.rs::to_app_config()`. This
design was transitional — it let us build the new structs alongside
the old one without a big-bang migration.
Now that the transition is nearly done, we want `Config` to be a
genuine serde POJO: no runtime state, no init logic, nothing that
couldn't round-trip through YAML. The structs that actually represent
runtime state (`AppConfig`, `AppState`, `RequestContext`) should own
their own initialization logic.
## Target architecture
Instead of migrating mutations incrementally through the bridge, we
**pivot the initialization direction**. Each struct owns its own init.
```
YAML file
↓ Config::load_from_file (serde only — no init logic)
Config (pure POJO)
↓ AppConfig::from_config(config) → AppConfig
AppConfig (immutable app-wide settings, self-initializing)
↓ AppState::init(Arc<AppConfig>, ...).await → AppState
AppState (shared process state: vault, mcp_factory, rag_cache, mcp_registry, functions)
↓ RequestContext::new(Arc<AppState>, working_mode)
RequestContext (per-request mutable state, unchanged)
```
### Struct responsibilities (post-16)
**`Config`** — trivial serde POJO:
- Only `#[serde(...)]` fields (no `#[serde(skip)]`)
- Only method: `load_from_file(path) -> Result<(Config, String)>`
(returns parsed Config + raw YAML content for secret interpolation)
- Can be round-tripped via YAML
**`AppConfig::from_config(config) -> Result<AppConfig>`** absorbs:
- Field-copy from `Config` (same as today's `to_app_config`)
- `load_envs()` — env var overrides
- `set_wrap()` — wrap string validation
- `setup_document_loaders()` — default pdf/docx loaders
- `setup_user_agent()` — resolve `"auto"` user agent
- `resolve_model()` — logic from `Config::setup_model` (picks default
model if `model_id` is empty)
**`AppState::init(app_config, log_path, start_mcp_servers, abort_signal)`** absorbs:
- `Vault::init(&app_config)` (vault moves from Config to AppState)
- `McpRegistry::init(...)` (currently `Config::load_mcp_servers`)
- `Functions::init(...)` (currently `Config::load_functions`)
- Returns fully-wired `AppState`
**`install_builtins()`** — top-level free function (replaces
`Agent::install_builtin_agents()` + `Macro::install_macros()` being
called inside `Config::init`). Called once from `main.rs` before any
config loading. Config-independent — just copies embedded assets.
**`bridge.rs` — deleted.** No more `to_app_config()` /
`to_request_context()`.
## Sub-phase layout
| Sub-phase | Scope |
|-----------|-------|
| 16a | Build `AppConfig::from_config` absorbing env/wrap/docs/user-agent/model-resolution logic |
| 16b | Extract `install_builtins()` as top-level function |
| 16c | Migrate `Vault` onto `AppState` |
| 16d | Build `AppState::init` absorbing MCP-registry/functions logic |
| 16e | Update `main.rs` + audit all 15 `Config::init()` callers, switch to new flow |
| 16f | Delete Config runtime fields, bridge.rs, `Config::init`, duplicated methods |
Sub-phases 16a16d can largely proceed in parallel (each adds new
entry points without removing the old ones). 16e switches callers.
16f is the final cleanup.
## 16a — AppConfig::from_config
**Target signature:**
```rust
impl AppConfig {
pub fn from_config(config: Config) -> Result<Self> {
let mut app_config = Self {
// Copy all serde fields from config
};
app_config.load_envs();
if let Some(wrap) = app_config.wrap.clone() {
app_config.set_wrap(&wrap)?;
}
app_config.setup_document_loaders();
app_config.setup_user_agent();
app_config.resolve_model()?;
Ok(app_config)
}
fn resolve_model(&mut self) -> Result<()> {
if self.model_id.is_empty() {
let models = crate::client::list_models(self, ModelType::Chat);
if models.is_empty() {
bail!("No available model");
}
self.model_id = models[0].id();
}
Ok(())
}
}
```
**New method: `AppConfig::resolve_model()`** — moves logic from
`Config::setup_model`. Ensures `model_id` is a valid, non-empty
concrete model reference.
**Note on `Model` vs `model_id`:** `Model` (the resolved runtime
handle) stays on `RequestContext`. AppConfig owns `model_id: String`
(the config default). RequestContext.model is built by calling
`Model::retrieve_model(&app_config, &model_id, ModelType::Chat)`
during context construction. They're different types for a reason.
**Files modified (16a):**
- `src/config/app_config.rs` — add `from_config`, `resolve_model`
- Also remove `#[allow(dead_code)]` from `load_envs`, `set_wrap`,
`setup_document_loaders`, `setup_user_agent`, `set_*_default`,
`ensure_default_model_id` (they all become reachable)
**Bridge still exists after 16a.** `Config::init` still calls its own
mutations for now. 16a just introduces the new entry point.
## 16b — install_builtins()
**Target signature:**
```rust
// In src/config/mod.rs or a new module
pub fn install_builtins() -> Result<()> {
Agent::install_builtin_agents()?;
Macro::install_macros()?;
Ok(())
}
```
**Changes:**
- Remove `Agent::install_builtin_agents()?;` and
`Macro::install_macros()?;` calls from inside `Config::init`
- Add `install_builtins()?;` to `main.rs` as the first step before
any config loading
Both functions are Config-independent (they just copy embedded
assets to the config directory), so this is a straightforward
extraction.
**Files modified (16b):**
- `src/config/mod.rs` — remove calls from `Config::init`, expose
`install_builtins` as a module-level pub fn
- `src/main.rs` — call `install_builtins()?;` at startup
## 16c — Vault → AppState
Today `Config.vault: Arc<GlobalVault>` is a `#[serde(skip)]` runtime
field populated by `Vault::init(config)`. Post-16c, the vault lives
natively on `AppState`.
**Current:**
```rust
pub struct AppState {
pub config: Arc<AppConfig>,
pub vault: GlobalVault, // Already here, sourced from config.vault
...
}
```
Wait — `AppState.vault` already exists. The work in 16c is just:
1. Change `Vault::init(config: &Config)``Vault::init(config: &AppConfig)`
- `Vault::init` only reads `config.vault_password_file()`, which
is already a serde field on AppConfig. Rename the param.
2. Delete `Config.vault` field (no longer needed once 16e routes
through AppState)
3. Update `main.rs` to call `Vault::init(&app_config)` instead of
`cfg.vault.clone()`
**Files modified (16c):**
- `src/vault/mod.rs``Vault::init` takes `&AppConfig`
- `src/config/mod.rs` — delete `Config.vault` field (after callers
switch)
## 16d — AppState::init
**Target signature:**
```rust
impl AppState {
pub async fn init(
config: Arc<AppConfig>,
log_path: Option<PathBuf>,
start_mcp_servers: bool,
abort_signal: AbortSignal,
) -> Result<Self> {
let vault = Vault::init(&config);
let functions = {
let mut fns = Functions::init(
config.visible_tools.as_ref().unwrap_or(&Vec::new())
)?;
// REPL-specific fns appended by RequestContext, not here
fns
};
let mcp_registry = McpRegistry::init(
log_path.clone(),
start_mcp_servers,
config.enabled_mcp_servers.clone(),
abort_signal,
&config, // new signature: &AppConfig
).await?;
let (mcp_config, mcp_log_path) = (
mcp_registry.mcp_config().cloned(),
mcp_registry.log_path().cloned(),
);
Ok(Self {
config,
vault,
mcp_factory: Default::default(),
rag_cache: Default::default(),
mcp_config,
mcp_log_path,
mcp_registry: Some(mcp_registry), // NEW field
functions, // NEW field
})
}
}
```
**New AppState fields:**
- `mcp_registry: Option<McpRegistry>` — the live registry of started
MCP servers (currently on Config)
- `functions: Functions` — the global function declarations (currently
on Config)
These become the "source of truth" that `ToolScope` copies from when
a scope transition happens.
**`McpRegistry::init` signature change:** today takes `&Config`,
needs to take `&AppConfig`. Only reads serialized fields.
**Files modified (16d):**
- `src/config/app_state.rs` — add `init`, add `mcp_registry` +
`functions` fields
- `src/mcp/mod.rs``McpRegistry::init` takes `&AppConfig`
**Important:** `Functions.append_user_interaction_functions()` is
currently called inside `Config::load_functions` when in REPL mode.
That logic is working-mode-dependent and belongs on `RequestContext`
(which knows its mode), not `AppState`. The migration moves that
append step to `RequestContext::new` or similar.
## 16e — Switch main.rs and 15 callers
**New `main.rs` flow:**
```rust
install_builtins()?;
let (config, raw_yaml) = Config::load_from_file(&paths::config_file())?;
// Secret interpolation (two-pass)
let bootstrap_vault = Vault::init_from_password_file(&config.vault_password_file());
let interpolated = interpolate_secrets_or_err(&raw_yaml, &bootstrap_vault, info_flag)?;
let final_config = if interpolated != raw_yaml {
Config::load_from_str(&interpolated)?
} else {
config
};
let app_config = Arc::new(AppConfig::from_config(final_config)?);
let app_state = Arc::new(
AppState::init(
app_config.clone(),
log_path,
start_mcp_servers,
abort_signal.clone(),
).await?
);
let ctx = RequestContext::new(app_state.clone(), working_mode);
```
**Secret interpolation complication:** Today's `Config::init` does a
two-pass YAML parse — load, init vault, interpolate secrets into raw
content, re-parse if content changed. In the new flow:
1. Load Config from YAML (also returns raw content)
2. Bootstrap Vault using Config's `vault_password_file` serde field
3. Interpolate secrets in raw content
4. If content changed, re-parse Config
5. Build AppConfig from final Config
6. Build AppState (creates the full Vault via `Vault::init(&app_config)`)
Step 2 and step 6 create the vault twice — once bootstrap (to decrypt
secrets in raw YAML), once full (for AppState). This matches current
behavior, just made explicit.
**15 callers of `Config::init()`** — audit required. Discovery
happens during 16e execution. Open questions flagged for user input
as discovered.
| File | Expected Action |
|------|-----------------|
| `main.rs` | Use new flow |
| `client/common.rs` | Probably needs AppConfig only |
| `vault/mod.rs` | Already uses `Config::vault_password_file`; switch to AppConfig |
| `config/request_context.rs` | Test helper — use `AppState::test_default()` or build directly |
| `config/session.rs` | Test helper — same |
| `rag/mod.rs` | Probably AppConfig |
| `function/supervisor.rs` | Test helper |
| `utils/request.rs` | Probably AppConfig |
| `config/role.rs` | Test helper |
| `utils/clipboard.rs` | Probably AppConfig |
| `supervisor/mod.rs` | Test helper |
| `repl/mod.rs` | Test helper |
| `parsers/common.rs` | Probably AppConfig |
| `utils/abort_signal.rs` | Probably AppConfig |
| `utils/spinner.rs` | Probably AppConfig |
**Files modified (16e):**
- `src/main.rs`
- Any of the 15 files above that aren't trivial — may need
`test_default()` helpers added
## 16f — Final cleanup
**Delete from `Config`:**
- All `#[serde(skip)]` fields: `vault`, `macro_flag`, `info_flag`,
`agent_variables`, `model`, `functions`, `mcp_registry`,
`working_mode`, `last_message`, `role`, `session`, `rag`, `agent`,
`tool_call_tracker`, `supervisor`, `parent_supervisor`,
`self_agent_id`, `current_depth`, `inbox`,
`root_escalation_queue`
- `Config::init` (whole function)
- `Config::load_envs`, `Config::load_functions`,
`Config::load_mcp_servers`, `Config::setup_model`,
`Config::set_model`, `Config::role_like_mut`,
`Config::sessions_dir`, `Config::set_wrap`,
`Config::setup_document_loaders`, `Config::setup_user_agent`,
`Config::vault_password_file` (redundant with AppConfig's)
**Delete:**
- `src/config/bridge.rs` (entire file)
- `mod bridge;` declaration in `config/mod.rs`
**Resulting `Config`:**
```rust
#[derive(Debug, Clone, Deserialize, Serialize)]
#[serde(default)]
pub struct Config {
// Only serde-annotated fields — the YAML shape
pub model_id: String,
pub temperature: Option<f64>,
// ... all the other serde fields
}
impl Config {
pub fn load_from_file(path: &Path) -> Result<(Config, String)> { ... }
pub fn load_from_str(content: &str) -> Result<Config> { ... }
}
```
A genuine POJO. No runtime state. No init logic. Just shape.
## Open questions (for execution)
1. **`Vault::init_bare`** — currently used as a fallback when no
Config exists. Does it still need to exist? The default
`vault_password_file` location is static. Might need
`AppConfig::default().vault_password_file()` or a free function.
2. **Secret interpolation ownership** — does `AppConfig::from_config`
handle it internally (takes raw YAML string and interpolates), or
does `main.rs` orchestrate the two-pass explicitly? Leaning toward
`main.rs` orchestration (cleaner separation).
3. **REPL-only `append_user_interaction_functions`** — moves to
`RequestContext::new`? Or stays as a post-init append called
explicitly?
4. **`Functions::init` + MCP meta functions** — today
`load_mcp_servers` calls `self.functions.append_mcp_meta_functions(...)`
after starting servers. In the new flow, `AppState::init` does
this. Verify ordering is preserved.
5. **Testing strategy** — User said don't worry unless trivial. If
test helpers need refactoring to work with new flow, prefer
adding `test_default()` methods gated by `#[cfg(test)]` over
rewriting tests.
## Dependencies between sub-phases
```
16a ──┐
16b ──┤
16c ──┼──→ 16d ──→ 16e ──→ 16f
16b, 16c, 16a independent and can run in any order
16d depends on 16c (vault on AppConfig)
16e depends on 16a, 16d (needs the new entry points)
16f depends on 16e (needs all callers switched)
```
## Rationale for this architecture
The original Step 16 plan migrated mutations piecewise through the
existing `to_app_config()` bridge. That works but:
- Leaves the bridge in place indefinitely
- Keeps `Config` burdened with both YAML shape AND runtime state
- Requires careful ordering to avoid breaking downstream consumers
like `load_functions`/`load_mcp_servers`/`setup_model`
- Creates transitional states where some mutations live on Config,
some on AppConfig
The new approach:
- Eliminates `bridge.rs` entirely
- Makes `Config` a true POJO
- Makes `AppConfig`/`AppState` self-contained (initialize from YAML
directly)
- REST API path is trivial: `AppConfig::from_config(yaml_string)`
- Test helpers can build `AppConfig`/`AppState` without Config
- Each struct owns exactly its concerns
## Verification criteria for each sub-phase
- 16a: `cargo check` + `cargo test` clean. `AppConfig::from_config`
produces the same state as `Config::init` + `to_app_config()` for
the same YAML input.
- 16b: `install_builtins()` called once from `main.rs`; agents and
macros still install on first startup.
- 16c: `Vault::init` takes `&AppConfig`; `Config.vault` field deleted.
- 16d: `AppState::init` builds a fully-wired `AppState` from
`Arc<AppConfig>` + startup context. MCP servers start; functions
load.
- 16e: REPL starts, all CLI flags work, all env vars honored, all
existing tests pass.
- 16f: Grep for `Config {` / `Config::init(` / `bridge::to_` shows
zero non-test hits. `Config` has only serde fields.
@@ -0,0 +1,179 @@
# Phase 1 Step 16a — Implementation Notes
## Status
Done.
## Plan reference
- Parent plan: `docs/implementation/PHASE-1-STEP-16-NOTES.md`
- Sub-phase goal: "Build `AppConfig::from_config` absorbing
env/wrap/docs/user-agent/model-resolution logic"
## Summary
Introduced `AppConfig::from_config(config: Config) -> Result<AppConfig>`
as the canonical constructor for a fully-initialized `AppConfig`. The
new constructor chains the four mutation methods (`load_envs`,
`set_wrap`, `setup_document_loaders`, `setup_user_agent`) plus a new
`resolve_model()` method that picks a default model when `model_id`
is empty.
The existing bridge (`Config::init` + `Config::to_app_config`) is
untouched. `from_config` is currently dead code (gated with
`#[allow(dead_code)]`) — it becomes the entry point in Step 16e when
`main.rs` switches over. The methods it calls (`load_envs`, etc.) are
no longer dead code because they're reachable via `from_config`, so
their `#[allow(dead_code)]` gates were removed.
## What was changed
### `src/config/app_config.rs`
**Added:**
- `AppConfig::from_config(config) -> Result<Self>` — canonical
constructor that copies serde fields, applies env overrides,
validates wrap, installs doc loaders, resolves user agent, and
ensures a default model.
- `AppConfig::resolve_model(&mut self) -> Result<()>` — if
`model_id` is empty, picks the first available chat model. Errors
if no models are available. Replaces the logic from
`Config::setup_model` that belongs on `AppConfig` (the
`Model`-resolution half of `Config::setup_model` stays in Config
for now — that moves in 16e).
- 8 unit tests covering field copying, doc loader insertion, user
agent resolution, wrap validation (valid + invalid), and
`resolve_model` error/happy paths.
**Removed `#[allow(dead_code)]` from:**
- `set_wrap`
- `setup_document_loaders`
- `setup_user_agent`
- `load_envs`
These are now reachable via `from_config`. They remain `pub` because
REPL-mode mutations (via `.set wrap <value>` or similar) will go
through them once `RequestContext` stops mutating `Config`.
**Removed entirely:**
- `AppConfig::ensure_default_model_id` — redundant with the new
`resolve_model`. Had no callers outside itself (confirmed via
grep).
### Behavior parity notes
1. **`from_config` is non-destructive:** it consumes `Config` by
value (not `&Config`) since post-bridge, Config is no longer
needed. This matches the long-term design.
2. **`from_config` vs `to_app_config` + mutations:** The methods
called inside `from_config` are identical bodies to the ones
currently called on `Config` inside `Config::init`. Env var
reads, wrap validation, doc loader defaults, and user agent
resolution all produce the same state.
3. **`resolve_model` vs `Config::setup_model`:**
- `Config::setup_model` does TWO things:
(a) ensure `model_id` is non-empty (pick default if empty)
(b) resolve the `Model` struct via `Model::retrieve_model` and
store it in `self.model`
- `AppConfig::resolve_model` only does (a).
- (b) happens today in `cfg.set_model(&model_id)` inside
`Config::setup_model`. In the new architecture, the `Model`
struct lives on `RequestContext.model`, and
`Model::retrieve_model(&app_config, &app_config.model_id, ...)`
will be called inside `RequestContext::new` (or equivalent)
once the bridge is removed in 16e.
## Files modified
- `src/config/app_config.rs` — 2 new methods, 4
`#[allow(dead_code)]` gates removed, 1 method deleted, 8 new
tests.
## Files NOT modified
- `src/config/mod.rs``Config::init` still runs all mutations on
Config; bridge still copies to AppConfig. Unchanged in 16a.
- `src/config/bridge.rs` — Untouched. Used by `from_config`
internally (`config.to_app_config()`).
- `src/main.rs` — Still uses the bridge flow. Switch happens in 16e.
## Assumptions made
1. **`from_config` consumes `Config` by value** (not `&Config`)
— aligns with the long-term design where `Config` is discarded
after conversion. No current caller would benefit from keeping
the Config around after conversion.
2. **`resolve_model` narrow scope**: only responsible for ensuring
`model_id` is non-empty. Does NOT resolve a `Model` struct —
that's RequestContext's job. This matches the split between
`AppConfig` (the configuration) and `RequestContext` (the
resolved runtime handle).
3. **`#[allow(dead_code)]` on `from_config` and `resolve_model`**:
they're unused until 16e. The gate is explicit so grep-hunts can
find them when 16e switches over.
4. **User agent prefix in tests**: I assumed the user agent prefix
is not critical to test literally (it depends on the crate name).
The test checks for a non-"auto" value containing `/` rather
than matching `loki-ai/`. Safer against crate rename.
## Open questions (parked for later sub-phases)
1. **Should `from_config` also run secret interpolation?** Currently
`Config::init` does a two-pass YAML parse where the raw content
gets secrets injected from the vault, then the Config is
re-parsed. In the new architecture this belongs in `main.rs` or
a separate helper (the Config comes in already-interpolated).
Not a 16a concern.
2. **Test naming convention**: Existing tests use
`fn test_name_returns_value_when_condition`. New tests use
`fn from_config_does_thing`. Both styles present in the file;
kept consistent with new code.
3. **`ensure_default_model_id` deletion**: confirmed via grep that
it had no callers outside itself. Deleted cleanly. If a future
sub-phase needs the Option<String> return variant, it can be
re-added.
## Verification
- `cargo check` — clean, zero warnings
- `cargo clippy` — clean, zero warnings
- `cargo test` — 122 passing (114 pre-16a + 8 new), zero failures
## Remaining work for Step 16
- **16b**: Extract `install_builtins()` as top-level free function
- **16c**: Migrate `Vault::init(&Config)``Vault::init(&AppConfig)`
- **16d**: Build `AppState::init(app_config, ...).await`
- **16e**: Switch `main.rs` and all 15 `Config::init()` callers to
the new flow
- **16f**: Delete Config runtime fields, bridge.rs, `Config::init`,
duplicated methods
## Migration direction preserved
After 16a, no runtime behavior has changed. The new entry point
exists but isn't wired in. The bridge flow continues as before:
```
YAML → Config::load_from_file
→ Config::init (unchanged, does all current mutations)
- load_envs, set_wrap, setup_document_loaders, ...
- setup_model, load_functions, load_mcp_servers
→ cfg.to_app_config() → AppConfig (via bridge)
→ cfg.to_request_context(AppState) → RequestContext
```
New entry point ready for 16e:
```
AppConfig::from_config(config) → AppConfig
(internally: to_app_config, load_envs, set_wrap,
setup_document_loaders, setup_user_agent, resolve_model)
```
@@ -0,0 +1,170 @@
# Phase 1 Step 16b — Implementation Notes
## Status
Done.
## Plan reference
- Parent plan: `docs/implementation/PHASE-1-STEP-16-NOTES.md`
- Sub-phase goal: "Extract `install_builtins()` as top-level function"
## Summary
Extracted `Agent::install_builtin_agents()` and `Macro::install_macros()`
from inside `Config::init` into a new top-level free function
`config::install_builtins()`. Called once from `main.rs` before any
config-loading path.
Both functions are Config-independent — they just copy embedded
agent/macro assets from the binary into the user's config directory.
Extracting them clears the way for `Config::init`'s eventual
deletion in Step 16f.
## What was changed
### `src/config/mod.rs`
**Added:**
```rust
pub fn install_builtins() -> Result<()> {
Agent::install_builtin_agents()?;
Macro::install_macros()?;
Ok(())
}
```
Placed after the `Config::Default` impl, before the `impl Config`
block. Module-level `pub fn` (not a method on any type).
**Removed from `Config::init` (inside the async `setup` closure):**
- `Agent::install_builtin_agents()?;` (was at top of setup block)
- `Macro::install_macros()?;` (was at bottom of setup block)
### `src/main.rs`
**Added:**
- `install_builtins` to the `use crate::config::{...}` import list
- `install_builtins()?;` call after `setup_logger()?` and before any
of the three config-loading paths (oauth, vault flags, main config)
### Placement rationale
The early-return paths (`cli.completions`, `cli.tail_logs`)
legitimately don't need builtins — they return before touching any
config. Those skip the install.
The three config paths (oauth via `Config::init_bare`, vault flags
via `Config::init_bare`, main via `Config::init`) all benefit from
builtins being installed once at startup. `install_builtins()` is
idempotent — it checks file existence and skips if already present —
so calling it unconditionally in the common path is safe.
## Behavior parity
- `install_builtin_agents` and `install_macros` are static methods
with no `&self` or Config arguments. Nothing observable changes
about their execution.
- The two functions ran on every `Config::init` call before. Now
they run once per `main.rs` invocation, which is equivalent for
the REPL and CLI paths.
- `Config::init_bare()` no longer triggers the installs
transitively. The oauth and vault-flag paths now rely on `main.rs`
having called `install_builtins()?` first. This is a minor
behavior shift — those paths previously installed builtins as a
side effect of calling `Config::init_bare`. Since we now call
`install_builtins()` unconditionally in `main.rs` before those
paths, the observable behavior is identical.
## Files modified
- `src/config/mod.rs` — added `install_builtins()` free function;
removed 2 calls from `Config::init`.
- `src/main.rs` — added import; added `install_builtins()?` call
after logger setup.
## Assumptions made
1. **`install_builtins` should always run unconditionally.** Even
if the user is only running `--completions` or `--tail-logs`
(early-return paths), those return before the install call.
The three config-using paths all benefit from it. No downside to
running it early.
2. **Module-level `pub fn` is the right API surface.** Could have
made it a method on `AppState` or `AppConfig`, but:
- It's called before any config/state exists
- It has no `self` parameter
- It's a static side-effectful operation (filesystem)
A free function at the module level is the honest signature.
3. **No tests added.** `install_builtins` is a thin wrapper around
two side-effectful functions that write files. Testing would
require filesystem mocking or temp dirs, which is
disproportionate for a 3-line function. The underlying
`install_builtin_agents` and `install_macros` functions have
existing behavior in the codebase; the extraction doesn't change
their contracts.
## Open questions
1. **Should `install_builtins` accept a "skip install" flag?**
Currently it always runs. For a server/REST API deployment, you
might want to skip this to avoid writing to the user's config
dir at startup. Deferring this question until REST API path
exists — can add a flag or a `_skip_install()` variant later.
2. **Do CI/test environments break because of the filesystem write?**
The install functions already existed in the codebase and ran on
every Config::init. No new risk introduced. Watch for flaky
tests after this change, but expected clean.
## Verification
- `cargo check` — clean, zero warnings
- `cargo clippy` — clean, zero warnings
- `cargo test` — 122 passing, zero failures
- Grep confirmation:
- `install_builtin_agents` only defined in `src/config/agent.rs`
and called only via `install_builtins`
- `install_macros` only defined in `src/config/macros.rs` and
called only via `install_builtins`
- `install_builtins` has one caller (`main.rs`)
## Remaining work for Step 16
- **16c**: Migrate `Vault::init(&Config)``Vault::init(&AppConfig)`;
eventually move vault ownership to `AppState`.
- **16d**: Build `AppState::init(app_config, ...).await`.
- **16e**: Switch `main.rs` and all 15 `Config::init()` callers to
the new flow.
- **16f**: Delete `Config` runtime fields, `bridge.rs`, `Config::init`,
duplicated methods.
## Migration direction preserved
After 16b, `Config::init` no longer handles builtin-asset installation.
This is a small but meaningful piece of responsibility removal — when
`Config::init` is eventually deleted in 16f, we don't need to worry
about orphaning the install logic.
Startup flow now:
```
main()
→ install_builtins()? [NEW: extracted from Config::init]
→ if oauth: Config::init_bare → oauth flow
→ if vault flags: Config::init_bare → vault handler
→ else: Config::init → to_app_config → AppState → ctx → run
```
The `Config::init` calls still do:
- load_envs
- set_wrap
- load_functions
- load_mcp_servers
- setup_model
- setup_document_loaders
- setup_user_agent
Those move to `AppConfig::from_config` (already built in 16a but
unused) and `AppState::init` (16d) in later sub-phases.
@@ -0,0 +1,196 @@
# Phase 1 Step 16c — Implementation Notes
## Status
Done.
## Plan reference
- Parent plan: `docs/implementation/PHASE-1-STEP-16-NOTES.md`
- Sub-phase goal: "Migrate Vault onto AppState; Vault::init takes
`&AppConfig`"
## Summary
Changed `Vault::init(&Config)` and `Vault::init_bare()` to operate on
`AppConfig` instead of `Config`. Simplified `Vault::handle_vault_flags`
to accept a `&Vault` directly instead of extracting one from a Config
argument. Deleted the duplicate `Config::vault_password_file` method
(the canonical version lives on `AppConfig`).
Vault is now fully Config-independent at the signature level. The
`Config.vault` runtime field still exists because it's populated
inside `Config::init` (for the current bridge-era flow), but nothing
about `Vault`'s API references `Config` anymore. The field itself
gets deleted in Step 16f when Config becomes a pure POJO.
## What was changed
### `src/vault/mod.rs`
**Signature change:**
```rust
// Before
pub fn init(config: &Config) -> Self
// After
pub fn init(config: &AppConfig) -> Self
```
**`Vault::init_bare` now uses `AppConfig::default()`** instead of
`Config::default()` to get the default vault password file path.
Behavioral parity — both `.default().vault_password_file()` calls
resolve to the same path (the fallback from `gman::config`).
**`Vault::handle_vault_flags` simplified:**
```rust
// Before
pub fn handle_vault_flags(cli: Cli, config: Config) -> Result<()>
// After
pub fn handle_vault_flags(cli: Cli, vault: &Vault) -> Result<()>
```
The old signature took a `Config` by value just to extract
`config.vault`. The new signature takes the Vault directly, which
decouples this function from Config entirely. Callers pass
`&config.vault` or equivalent.
**Import updated:**
- `use crate::config::Config` removed
- `use crate::config::AppConfig` added
### `src/config/mod.rs`
**In `Config::init`:**
```rust
// Before
let vault = Vault::init(config);
// After
let vault = Vault::init(&config.to_app_config());
```
This is a transitional call — `Config::init` builds a temporary
`AppConfig` via the bridge just to satisfy the new signature. This
temporary conversion disappears in Step 16e when `main.rs` stops
calling `Config::init` entirely and `AppConfig` is built first.
**Deleted `Config::vault_password_file`** method. The identical body
lives on `AppConfig`. All callers go through AppConfig now.
### `src/main.rs`
**Vault-flags path:**
```rust
// Before
return Vault::handle_vault_flags(cli, Config::init_bare()?);
// After
let cfg = Config::init_bare()?;
return Vault::handle_vault_flags(cli, &cfg.vault);
```
This is a minor restructure — same observable behavior, but the
Vault is extracted from the Config and passed directly. Makes the
vault-flags path obvious about what it actually needs (a Vault, not
a Config).
## Behavior parity
- `Vault::init` reads `config.vault_password_file()` — identical
method on both Config and AppConfig (removed from Config in this
step, kept on AppConfig).
- Password file initialization (`ensure_password_file_initialized`)
still runs in `Vault::init` as before.
- `Vault::init_bare` fallback path resolves to the same default
password file location.
- `handle_vault_flags` operates on the same Vault instance either
way — just receives it directly instead of indirectly via Config.
## Files modified
- `src/vault/mod.rs` — imports, `init` signature, `init_bare`
fallback source, `handle_vault_flags` signature.
- `src/config/mod.rs` — transitional `to_app_config()` call in
`Config::init`; deleted duplicate `vault_password_file` method.
- `src/main.rs` — vault-flags path takes `&cfg.vault` directly.
## Assumptions made
1. **`AppConfig::default().vault_password_file()` behaves identically
to `Config::default().vault_password_file()`.** Verified by
comparing method bodies — identical logic, same fallback via
`gman::config::Config::local_provider_password_file()`. Tests
confirm 122 passing, no regressions.
2. **Transitional `&config.to_app_config()` in `Config::init` is
acceptable.** The conversion happens once per Config::init call
— trivial cost for a non-hot path. Disappears entirely in 16e.
3. **`handle_vault_flags` taking `&Vault` is a strict improvement.**
The old signature took `Config` by value (wasteful for a function
that only needed one field). The new signature is honest about
its dependency.
4. **`Config.vault` field stays for now.** The `#[serde(skip)]` field
on Config still exists because `Config::init` populates it for
downstream Bridge flow consumers. Deletion deferred to 16f.
## Open questions
1. **Should `Vault::init` return `Result<Self>` instead of panicking?**
Currently uses `.expect("Failed to initialize password file")`.
The vault flags path can't do anything useful without a vault,
so panic vs early return is pragmatically equivalent. Leaving
as-is to minimize change surface in 16c.
2. **Is `Config::init_bare` still needed after 16e?** It's called
from the oauth path in `main.rs`. In 16e we'll audit whether
those paths really need full Config init or just an AppConfig.
Deferred to 16e.
## Verification
- `cargo check` — clean, zero warnings
- `cargo clippy` — clean, zero warnings
- `cargo test` — 122 passing, zero failures
- Grep confirmation:
- `Vault::init(` has one caller (in `Config::init`); one
remaining via test path (none found — deferred to 16d/16e where
AppState::init will own vault construction)
- `Vault::init_bare(` has one caller (via `interpolate_secrets`
flow); no other references
- `Config::vault_password_file` — zero references anywhere
- `Vault::handle_vault_flags` — single caller in `main.rs`,
signature verified
## Remaining work for Step 16
- **16d**: Build `AppState::init(app_config, ...).await` that takes
ownership of vault construction (replacing the current
`AppState { vault: cfg.vault.clone(), ... }` pattern).
- **16e**: Switch `main.rs` and all 15 `Config::init()` callers to
the new flow.
- **16f**: Delete `Config.vault` field, `Config::init`, bridge.rs,
and all remaining Config runtime fields.
## Migration direction preserved
Before 16c:
```
Vault::init(&Config) ← tight coupling to Config
Vault::init_bare() ← uses Config::default() internally
handle_vault_flags(Cli, Config) ← takes Config, extracts vault
Config::vault_password_file() ← duplicate with AppConfig's
```
After 16c:
```
Vault::init(&AppConfig) ← depends only on AppConfig
Vault::init_bare() ← uses AppConfig::default() internally
handle_vault_flags(Cli, &Vault) ← takes Vault directly
Config::vault_password_file() ← DELETED
```
The Vault module now has no Config dependency in its public API.
This means Step 16d can build `AppState::init` that calls
`Vault::init(&app_config)` without touching Config at all. It also
means `Config` is one step closer to being a pure POJO — one fewer
method on its surface, one fewer implicit dependency.
@@ -0,0 +1,271 @@
# Phase 1 Step 16d — Implementation Notes
## Status
Done.
## Plan reference
- Parent plan: `docs/implementation/PHASE-1-STEP-16-NOTES.md`
- Sub-phase goal: "Build `AppState::init(app_config, ...).await`
absorbing MCP registry startup and global functions loading"
## Summary
Added `AppState::init()` async constructor that self-initializes all
process-wide shared state from an `Arc<AppConfig>` and startup
context. Two new fields on `AppState`: `mcp_registry` (holds initial
MCP server Arcs alive) and `functions` (the global base
`Functions`). Changed `McpRegistry::init` to take `&AppConfig +
&Vault` instead of `&Config`.
The constructor is dead-code-gated (`#[allow(dead_code)]`) until
Step 16e switches `main.rs` over to call it. The bridge flow
continues to populate the new fields via Config's existing
`functions` and `mcp_registry` so nothing breaks.
## What was changed
### `src/mcp/mod.rs`
**`McpRegistry::init` signature change:**
```rust
// Before
pub async fn init(
log_path: Option<PathBuf>,
start_mcp_servers: bool,
enabled_mcp_servers: Option<String>,
abort_signal: AbortSignal,
config: &Config,
) -> Result<Self>
// After
pub async fn init(
log_path: Option<PathBuf>,
start_mcp_servers: bool,
enabled_mcp_servers: Option<String>,
abort_signal: AbortSignal,
app_config: &AppConfig,
vault: &Vault,
) -> Result<Self>
```
The function reads two things from its config argument:
- `config.vault` for secret interpolation → now takes `&Vault`
directly
- `config.mcp_server_support` for the start-servers gate → a serde
field already present on `AppConfig`
Both dependencies are now explicit. No Config reference anywhere in
the MCP module.
**Imports updated:**
- Removed `use crate::config::Config`
- Added `use crate::config::AppConfig`
- Added `use crate::vault::Vault`
### `src/config/mod.rs`
**`Config::load_mcp_servers` updated** to build a temporary AppConfig
via `self.to_app_config()` and pass it plus `&self.vault` to
`McpRegistry::init`. This is a transitional bridge — disappears in
16e when `main.rs` stops calling `Config::init` and
`AppState::init` becomes the sole entry point.
### `src/config/app_state.rs`
**New fields:**
```rust
pub mcp_registry: Option<Arc<McpRegistry>>,
pub functions: Functions,
```
**New `AppState::init()` async constructor** absorbs:
- `Vault::init(&config)` (replaces the old
`AppState { vault: cfg.vault.clone() }` pattern)
- `McpRegistry::init(...)` (previously inside `Config::init`)
- Registers initial MCP servers with `McpFactory` via
`insert_active(McpServerKey, &handle)` — this is NEW behavior, see
below.
- `Functions::init(config.visible_tools)` (previously inside
`Config::init`)
- `functions.append_mcp_meta_functions(...)` when MCP support is on
and servers started
- Wraps `McpRegistry` in `Arc` to keep initial server handles alive
across scope transitions (see below)
**Imports expanded:**
- `McpServerKey` from `super::mcp_factory`
- `Functions` from `crate::function`
- `McpRegistry` from `crate::mcp`
- `AbortSignal` from `crate::utils`
- `Vault` from `crate::vault`
- `anyhow::Result`
### `src/main.rs`
**AppState struct literal extended** to populate the two new fields
from `cfg.mcp_registry` and `cfg.functions`. This keeps the bridge
flow working unchanged. When 16e replaces this struct literal with
`AppState::init(...)`, these field references go away entirely.
### `src/function/supervisor.rs`
**Child AppState construction extended** to propagate the new
fields from parent: `mcp_registry: ctx.app.mcp_registry.clone()` and
`functions: ctx.app.functions.clone()`. This maintains parent-child
sharing of the MCP factory cache (which was already fixed earlier in
this work stream).
### `src/config/request_context.rs` and `src/config/session.rs`
**Test helper AppState construction extended** to include the two
new fields with safe defaults (`None`, and `cfg.functions.clone()`
respectively).
## New behavior: McpFactory pre-registration
`AppState::init` registers every initial server with `McpFactory` via
`insert_active`. This fixes a latent issue in the current bridge
flow:
- Before: initial servers were held on `Config.mcp_registry.servers`;
when the first scope transition (e.g., `.role coder`) ran
`rebuild_tool_scope`, it called `McpFactory::acquire(name, spec,
log_path)` which saw an empty cache and **spawned duplicate
servers**. The original servers died when the initial ToolScope
was replaced.
- After (via `AppState::init`): the factory's Weak map is seeded
with the initial server Arcs. The registry itself is wrapped in
Arc and held on AppState so the Arcs stay alive. Scope
transitions now hit the factory cache and reuse the same
subprocesses.
This is a real improvement that shows up once `main.rs` switches to
`AppState::init` in 16e. During the 16d bridge window, nothing
reads the factory pre-registration yet.
## Behavior parity (16d window)
- `main.rs` still calls `Config::init`, still uses the bridge; all
new fields populated from Config's own state.
- `AppState::init` is present but unused in production code paths.
- Test helpers still use struct literals; they pass `None` for
`mcp_registry` and clone `cfg.functions` which is the same as
what the bridge was doing.
- No observable runtime change for users.
## Files modified
- `src/mcp/mod.rs``McpRegistry::init` signature; imports.
- `src/config/mod.rs``Config::load_mcp_servers` bridges to new
signature.
- `src/config/app_state.rs` — added 2 fields, added `init`
constructor, expanded imports.
- `src/main.rs` — struct literal populates 2 new fields.
- `src/function/supervisor.rs` — child struct literal populates 2
new fields.
- `src/config/request_context.rs` — test helper populates 2 new
fields.
- `src/config/session.rs` — test helper populates 2 new fields.
## Assumptions made
1. **`McpFactory::insert_active` with Weak is sufficient to seed the
cache.** The initial ServerArcs live on `AppState.mcp_registry`
(wrapped in Arc to enable clone across child states). Scope
transitions call `McpFactory::acquire` which does
`try_get_active(key).unwrap_or_else(spawn_new)`. The Weak in
factory upgrades because Arc is alive in `mcp_registry`. Verified
by reading code paths; not yet verified at runtime since bridge
still drives today's flow.
2. **`functions: Functions` is Clone-safe.** The struct contains
`Vec<FunctionDeclaration>` and related fields; cloning is cheap
enough at startup and child-agent spawn. Inspected the
definition; no references to check.
3. **`mcp_server_support` gate still applies.** `Config::init` used
to gate the MCP meta function append with both `is_empty()` and
`mcp_server_support`; `AppState::init` preserves both checks.
Parity confirmed.
4. **Mode-specific function additions (REPL-only
`append_user_interaction_functions`) do NOT live on AppState.**
They are added per-scope in `rebuild_tool_scope` and in the
initial `RequestContext::new` path. `AppState.functions` is the
mode-agnostic base. This matches the long-term design
(RequestContext owns mode-aware additions).
5. **`mcp_registry: Option<Arc<McpRegistry>>` vs `McpRegistry`.**
Went with `Option<Arc<_>>` so:
- `None` when no MCP config exists (can skip work)
- `Arc` so parent/child AppStates share the same registry
(keeping initial server handles alive across the tree)
## Open questions
1. **Registry on AppState vs factory-owned lifecycle**. The factory
holds Weak; the registry holds Arc. Keeping the registry alive
on AppState extends server lifetime to the process lifetime.
This differs from the current "servers die on scope transition"
behavior. In practice this is what users expect — start the
servers once, keep them alive. But it means long-running REPL
sessions retain all server subprocesses even if the user switches
away from them. Acceptable trade-off for Phase 1.
2. **Should `AppState::init` return `Arc<AppState>` directly?**
Currently returns `Self`. Caller wraps in Arc. Symmetric with
other init functions; caller has full flexibility. Keep as-is.
3. **Unit tests for `AppState::init`.** Didn't add any because the
function is heavily async, touches filesystem (paths),
subprocess startup (MCP), and the vault. A meaningful unit test
would require mocking. Integration-level validation happens in
16e when main.rs switches over. Deferred.
## Verification
- `cargo check` — clean, zero warnings
- `cargo clippy` — clean, zero warnings
- `cargo test` — 122 passing, zero failures
- New `AppState::init` gated with `#[allow(dead_code)]` — no
warnings for being unused
## Remaining work for Step 16
- **16e**: Switch `main.rs` to call
`AppState::init(app_config, log_path, start_mcp_servers,
abort_signal).await?` instead of the bridge pattern. Audit the
15 `Config::init()` callers. Remove `#[allow(dead_code)]` from
`AppConfig::from_config`, `AppConfig::resolve_model`, and
`AppState::init`.
- **16f**: Delete `Config.vault`, `Config.functions`,
`Config.mcp_registry`, all other `#[serde(skip)]` runtime fields.
Delete `Config::init`, `Config::load_envs`, `Config::load_functions`,
`Config::load_mcp_servers`, `Config::setup_model`,
`Config::set_model`, etc. Delete `bridge.rs`.
## Migration direction preserved
Before 16d:
```
AppState {
config, vault, mcp_factory, rag_cache, mcp_config, mcp_log_path
}
```
Constructed only via struct literal from Config fields via bridge.
After 16d:
```
AppState {
config, vault, mcp_factory, rag_cache, mcp_config, mcp_log_path,
mcp_registry, functions
}
impl AppState {
pub async fn init(config, log_path, start_mcp_servers, abort_signal)
-> Result<Self>
}
```
New fields present on all code paths. New self-initializing
constructor ready for 16e's switchover.
@@ -0,0 +1,228 @@
# Phase 1 Step 16e — Implementation Notes
## Status
Done.
## Plan reference
- Parent plan: `docs/implementation/PHASE-1-STEP-16-NOTES.md`
- Sub-phase goal: "Switch main.rs and all Config::init() callers
to the new flow"
## Summary
`main.rs` and `cli/completer.rs` no longer call `Config::init` or
`Config::init_bare` — they use the new flow:
`Config::load_with_interpolation``AppConfig::from_config`
`AppState::init``RequestContext::bootstrap`.
The bridge `Config::to_request_context` and the old `Config::init`
are now dead code, gated with `#[allow(dead_code)]` pending deletion
in 16f.
## What was changed
### New helpers
**`Config::load_with_interpolation(info_flag: bool) -> Result<Self>`** in
`src/config/mod.rs` — absorbs the two-pass YAML parse with secret
interpolation. Handles:
1. Missing config file (creates via `create_config_file` if TTY, or
`load_dynamic` from env vars)
2. Reading the raw YAML content
3. Bootstrapping a Vault from the freshly-parsed Config
4. Interpolating secrets
5. Re-parsing Config if interpolation changed anything
6. Sets `config.vault` (legacy field — deleted in 16f)
**`config::default_sessions_dir() -> PathBuf`** and
**`config::list_sessions() -> Vec<String>`** free functions —
provide session listing without needing a Config instance. Used by
the session completer.
**`RequestContext::bootstrap(app: Arc<AppState>, working_mode,
info_flag) -> Result<Self>`** in `src/config/request_context.rs` —
the new entry point for creating the initial RequestContext. Builds:
- Resolved `Model` from `app.config.model_id`
- `ToolScope.functions` cloned from `app.functions` with
`append_user_interaction_functions` added in REPL mode
- `ToolScope.mcp_runtime` synced from `app.mcp_registry`
### Made public in Config for new flow
- `Config::load_from_file` (was `fn`)
- `Config::load_from_str` (was `fn`)
- `Config::load_dynamic` (was `fn`)
- `config::create_config_file` (was `async fn`)
### src/main.rs
Three startup paths rewired:
```rust
// Path 1: --authenticate
let cfg = Config::load_with_interpolation(true).await?;
let app_config = AppConfig::from_config(cfg)?;
let (client_name, provider) =
resolve_oauth_client(client_arg.as_deref(), &app_config.clients)?;
oauth::run_oauth_flow(&*provider, &client_name).await?;
// Path 2: vault flags
let cfg = Config::load_with_interpolation(true).await?;
let app_config = AppConfig::from_config(cfg)?;
let vault = Vault::init(&app_config);
return Vault::handle_vault_flags(cli, &vault);
// Path 3: main
let cfg = Config::load_with_interpolation(info_flag).await?;
let app_config: Arc<AppConfig> = Arc::new(AppConfig::from_config(cfg)?);
let app_state: Arc<AppState> = Arc::new(
AppState::init(app_config, log_path, start_mcp_servers, abort_signal.clone()).await?
);
let ctx = RequestContext::bootstrap(app_state, working_mode, info_flag)?;
```
No more `Config::init`, `Config::to_app_config`, `cfg.mcp_registry`,
or `cfg.to_request_context` references in `main.rs`.
### src/cli/completer.rs
Three completers that needed config access updated:
- `model_completer` → uses new `load_app_config_for_completion()`
helper (runs `Config::load_with_interpolation` synchronously from
the completion context; async via `Handle::try_current` or a fresh
runtime)
- `session_completer` → uses the new free function
`list_sessions()` (no Config needed)
- `secrets_completer` → uses `Vault::init(&app_config)` directly
### #[allow(dead_code)] removed
- `AppConfig::from_config`
- `AppConfig::resolve_model`
- `AppState::init`
- `AppState.rag_cache` (was flagged dead; now wired in)
### #[allow(dead_code)] added (temporary, deleted in 16f)
- `Config::init_bare` — no longer called
- `Config::sessions_dir` — replaced by free function
- `Config::list_sessions` — replaced by free function
- `Config::to_request_context` — replaced by `RequestContext::bootstrap`
## Behavior parity
- `main.rs` startup now invokes:
- `install_builtins()` (installs builtin global tools, agents,
macros — same files get copied as before, Step 16b)
- `Config::load_with_interpolation` (same YAML loading + secret
interpolation as old `Config::init`)
- `AppConfig::from_config` (same env/wrap/docs/user-agent/model
resolution as old Config mutations)
- `AppState::init` (same vault init + MCP registry startup +
global Functions loading as old Config methods, now owned by
AppState; also pre-registers initial servers with McpFactory —
new behavior that fixes a latent cache miss bug)
- `RequestContext::bootstrap` (same initial state as old bridge
`to_request_context`: resolved Model, Functions with REPL
extensions, MCP runtime from registry)
- Completer paths now use a lighter-weight config load (no MCP
startup) which is appropriate since shell completion isn't
supposed to start subprocesses.
## Files modified
- `src/config/mod.rs` — added `load_with_interpolation`,
`default_sessions_dir`, `list_sessions`; made 3 methods public;
added `#[allow(dead_code)]` to `Config::init_bare`,
`sessions_dir`, `list_sessions`.
- `src/config/request_context.rs` — added `bootstrap`.
- `src/config/app_config.rs` — removed 2 `#[allow(dead_code)]`
gates.
- `src/config/app_state.rs` — removed 2 `#[allow(dead_code)]`
gates.
- `src/config/bridge.rs` — added `#[allow(dead_code)]` to
`to_request_context`.
- `src/main.rs` — rewired three startup paths.
- `src/cli/completer.rs` — rewired three completers.
## Assumptions made
1. **Completer helper runtime handling**: The three completers run
in a sync context (clap completion). The new
`load_app_config_for_completion` uses
`Handle::try_current().ok()` to detect if a tokio runtime
exists; if so, uses `block_in_place`; otherwise creates a
fresh runtime. This matches the old `Config::init_bare` pattern
(which also used `block_in_place` + `block_on`).
2. **`Config::to_request_context` kept with `#[allow(dead_code)]`**:
It's unused now but 16f deletes it cleanly. Leaving it in place
keeps 16e a non-destructive switchover.
3. **`RequestContext::bootstrap` returns `Result<Self>` not
`Arc<Self>`**: caller decides wrapping. main.rs doesn't wrap;
the REPL wraps `Arc<RwLock<RequestContext>>` a few lines later.
4. **`install_builtin_global_tools` added to `install_builtins`**:
A function added in user's 16b commit extracted builtin tool
installation out of `Functions::init` into a standalone function.
My Step 16b commit that extracted `install_builtins` missed
including this function — fixed in this step.
## Verification
- `cargo check` — clean, zero warnings
- `cargo clippy` — clean, zero warnings
- `cargo test` — 122 passing, zero failures
- Grep confirmation:
- `Config::init(` — only called from `Config::init_bare` (which
is now dead)
- `Config::init_bare` — no external callers (test helper uses
`#[allow(dead_code)]`)
- `to_request_context` — zero callers outside bridge.rs
- `cfg.mcp_registry` / `cfg.functions` / `cfg.vault` references
in main.rs — zero
## Remaining work for Step 16
- **16f**: Delete all `#[allow(dead_code)]` scaffolding:
- `Config::init`, `Config::init_bare`
- `Config::sessions_dir`, `Config::list_sessions`
- `Config::set_wrap`, `Config::setup_document_loaders`,
`Config::setup_user_agent`, `Config::load_envs`,
`Config::load_functions`, `Config::load_mcp_servers`,
`Config::setup_model`, `Config::set_model`,
`Config::role_like_mut`, `Config::vault_password_file`
- `bridge.rs` — delete entirely
- All `#[serde(skip)]` runtime fields on `Config`
- `mod bridge;` declaration
After 16f, `Config` will be a pure serde POJO with only serialized
fields and `load_from_file` / `load_from_str` / `load_dynamic` /
`load_with_interpolation` methods.
## Migration direction achieved
Before 16e:
```
main.rs: Config::init → to_app_config → AppState {...} → to_request_context
```
After 16e:
```
main.rs:
install_builtins()
Config::load_with_interpolation → AppConfig::from_config
AppState::init(app_config, ...).await
RequestContext::bootstrap(app_state, working_mode, info_flag)
```
No more god-init. Each struct owns its initialization. The REST
API path is now trivial: skip `install_builtins()` if not desired,
call `AppConfig::from_config(yaml_string)`, call
`AppState::init(...)`, create per-request `RequestContext` as
needed.
@@ -0,0 +1,355 @@
# Phase 1 Step 16f — Implementation Notes
## Status
Done. Phase 1 Step 16 (Config → AppConfig migration) complete.
## Plan reference
- Parent plan: `docs/implementation/PHASE-1-STEP-16-NOTES.md`
- Predecessor: `docs/implementation/PHASE-1-STEP-16e-NOTES.md`
- Sub-phase goal: "Delete all #[allow(dead_code)] scaffolding from
Config and bridge.rs, delete runtime fields from Config, delete
bridge.rs entirely."
## Summary
`Config` is now a pure serde POJO. `bridge.rs` is gone. Every
runtime field, every `Config::init*` flavor, and every Config method
that was scaffolding for the old god-init has been deleted. The
project compiles clean, clippy clean, and all 122 tests pass.
## What was changed
### Deleted: `src/config/bridge.rs`
Whole file removed. `mod bridge;` declaration in `config/mod.rs`
removed. The two methods (`Config::to_app_config` and
`Config::to_request_context`) had no remaining callers after 16e.
### `src/config/mod.rs` — Config slimmed to a POJO
**Deleted runtime (`#[serde(skip)]`) fields from `Config`:**
- `vault`, `macro_flag`, `info_flag`, `agent_variables`
- `model`, `functions`, `mcp_registry`, `working_mode`,
`last_message`
- `role`, `session`, `rag`, `agent`, `tool_call_tracker`
- `supervisor`, `parent_supervisor`, `self_agent_id`,
`current_depth`, `inbox`, `root_escalation_queue`
**Deleted methods on `Config`:**
- `init`, `init_bare` (god-init replaced by
`load_with_interpolation` + `AppConfig::from_config` +
`AppState::init` + `RequestContext::bootstrap`)
- `sessions_dir`, `list_sessions` (replaced by
`config::default_sessions_dir` / `config::list_sessions` free
functions for use without a Config; per-context paths live on
`RequestContext::sessions_dir` / `RequestContext::list_sessions`)
- `role_like_mut` (lives on `RequestContext` post-migration)
- `set_wrap`, `setup_document_loaders`, `setup_user_agent`,
`load_envs` (lives on `AppConfig` post-migration)
- `set_model`, `setup_model` (model resolution now in
`AppConfig::resolve_model`; per-scope model selection lives on
`RequestContext`)
- `load_functions`, `load_mcp_servers` (absorbed by
`AppState::init`)
**Default impl entries** for the deleted runtime fields removed.
**Imports cleaned up:** removed unused `ToolCallTracker`,
`McpRegistry`, `Supervisor`, `EscalationQueue`, `Inbox`, `RwLock`,
`ColorScheme`, `QueryOptions`, `color_scheme`, `Handle`. Kept
`Model`, `ModelType`, `GlobalVault` because sibling modules
(`role.rs`, `input.rs`, `agent.rs`, `session.rs`) use
`use super::*;` and depend on those re-exports.
**Removed assertions** for the deleted runtime fields from
`config_defaults_match_expected` test.
### `src/config/mod.rs``load_with_interpolation` no longer touches AppConfig::to_app_config
Previously called `config.to_app_config()` to build a Vault for
secret interpolation. Now constructs a minimal `AppConfig` inline
with only `vault_password_file` populated, since that's all
`Vault::init` reads. Also removed the `config.vault = Arc::new(vault)`
assignment that was the last write to the deleted runtime field.
### `src/config/mod.rs``vault_password_file` made `pub(super)`
Previously private. Now `pub(super)` so `AppConfig::from_config` (a
sibling module under `config/`) can read it during the field-copy.
### `src/config/app_config.rs``AppConfig::from_config` self-contained
Previously delegated to `Config::to_app_config()` (lived on bridge)
for the field-copy. Now inlines the field-copy directly in
`from_config`, then runs `load_envs`, `set_wrap`,
`setup_document_loaders`, `setup_user_agent`, and `resolve_model`
as before.
**Removed `#[allow(dead_code)]` from `AppConfig.model_id`** — it's
read from `app.config.model_id` in `RequestContext::bootstrap` so
the lint exemption was stale.
**Test refactor:** the three `to_app_config_*` tests rewritten as
`from_config_*` tests using `AppConfig::from_config(cfg).unwrap()`.
A `ClientConfig::default()` and non-empty `model_id: "test-model"`
were added so `resolve_model()` doesn't bail with "No available
model" during the runtime initialization.
### `src/config/session.rs` — Test helper rewired
`session_new_from_ctx_captures_save_session` rewritten to build the
test `AppState` directly with `AppConfig::default()`,
`Vault::default()`, `Functions::default()` instead of going through
`cfg.to_app_config()` / `cfg.vault` / `cfg.functions`. Then uses
`RequestContext::new(app_state, WorkingMode::Cmd)` instead of the
deleted `cfg.to_request_context(app_state)`.
### `src/config/request_context.rs` — Test helpers rewired
The `app_state_from_config(&Config)` helper rewritten as
`default_app_state()` — no longer takes a Config, builds AppState
from `AppConfig::default()` + `Vault::default()` + `Functions::default()`
directly. The two callers (`create_test_ctx`,
`update_app_config_persists_changes`) updated.
The `to_request_context_creates_clean_state` test renamed to
`new_creates_clean_state` and rewritten to use `RequestContext::new`
directly.
### Doc comment refresh
Three module docstrings rewritten to reflect the post-16f world:
- `app_config.rs` — was "Phase 1 Step 0 ... not yet wired into the
runtime." Now describes `AppConfig` as the runtime-resolved
view of YAML, built via `AppConfig::from_config`.
- `app_state.rs` — was "Step 6.5 added mcp_factory and rag_cache
... neither wired in yet ... Step 8+ will connect." Now
describes `AppState::init` as the wiring point.
- `request_context.rs` — was an extensive description of the
bridge window with flat fields vs sub-struct fields, citing
`Config::to_request_context`. Now describes the type's actual
ownership/lifecycle without referring to deleted entry points.
- `tool_scope.rs` — was "Step 6.5 scope ... unused parallel
structure ... Step 8 will rewrite." Now describes `ToolScope`
as the live per-scope tool runtime.
(Other phase-era comments in `paths.rs`, `mcp_factory.rs`,
`rag_cache.rs` not touched. They reference Step 2 / Step 6.5 /
Step 8 but the affected types still exist and the descriptions
aren't actively misleading — those files weren't part of 16f
scope. Future cleanup if desired.)
## What Config looks like now
```rust
#[derive(Debug, Clone, Deserialize)]
#[serde(default)]
pub struct Config {
pub model_id: String,
pub temperature: Option<f64>,
pub top_p: Option<f64>,
pub dry_run: bool,
pub stream: bool,
pub save: bool,
pub keybindings: String,
pub editor: Option<String>,
pub wrap: Option<String>,
pub wrap_code: bool,
pub(super) vault_password_file: Option<PathBuf>,
pub function_calling_support: bool,
pub mapping_tools: IndexMap<String, String>,
pub enabled_tools: Option<String>,
pub visible_tools: Option<Vec<String>>,
pub mcp_server_support: bool,
pub mapping_mcp_servers: IndexMap<String, String>,
pub enabled_mcp_servers: Option<String>,
pub repl_prelude: Option<String>,
pub cmd_prelude: Option<String>,
pub agent_session: Option<String>,
pub save_session: Option<bool>,
pub compression_threshold: usize,
pub summarization_prompt: Option<String>,
pub summary_context_prompt: Option<String>,
pub rag_embedding_model: Option<String>,
pub rag_reranker_model: Option<String>,
pub rag_top_k: usize,
pub rag_chunk_size: Option<usize>,
pub rag_chunk_overlap: Option<usize>,
pub rag_template: Option<String>,
pub document_loaders: HashMap<String, String>,
pub highlight: bool,
pub theme: Option<String>,
pub left_prompt: Option<String>,
pub right_prompt: Option<String>,
pub user_agent: Option<String>,
pub save_shell_history: bool,
pub sync_models_url: Option<String>,
pub clients: Vec<ClientConfig>,
}
impl Config {
pub async fn load_with_interpolation(info_flag: bool) -> Result<Self> { ... }
pub fn load_from_file(config_path: &Path) -> Result<(Self, String)> { ... }
pub fn load_from_str(content: &str) -> Result<Self> { ... }
pub fn load_dynamic(model_id: &str) -> Result<Self> { ... }
}
```
Just shape + four loaders. The three associated functions that
used to live here (`search_rag`, `load_macro`, `sync_models`)
were relocated in the 16f cleanup pass below — none of them
touched Config state, they were squatters from the god-object
era.
## Assumptions made
1. **Doc cleanup scope**: The user asked to "delete the dead-code
scaffolding from Config and bridge.rs." Doc comments in
`paths.rs`, `mcp_factory.rs`, `rag_cache.rs` still reference
"Phase 1 Step 6.5 / Step 8" but the types they describe are
still real and the descriptions aren't actively wrong (just
historically dated). Left them alone. Updated only the docs in
`app_config.rs`, `app_state.rs`, `request_context.rs`, and
`tool_scope.rs` because those were either pointing at deleted
types (`Config::to_request_context`) or making explicitly
false claims ("not wired into the runtime yet").
2. **`set_*_default` helpers on AppConfig**: Lines 485528 of
`app_config.rs` define nine `#[allow(dead_code)]`
`set_*_default` methods. These were added in earlier sub-phases
as planned setters for runtime overrides. They're still unused.
The 16-NOTES plan flagged them ("set_*_default ... become
reachable") but reachability never happened. Since the user's
directive was specifically "Config and bridge.rs scaffolding,"
I left these untouched. Removing them is independent cleanup
that doesn't block 16f.
3. **`reload_current_model` on RequestContext**: Same situation —
one `#[allow(dead_code)]` left on a RequestContext method.
Belongs to a different cleanup task; not Config or bridge
scaffolding.
4. **`vault_password_file` visibility**: `Config.vault_password_file`
was a private field. Made it `pub(super)` so
`AppConfig::from_config` (sibling under `config/`) can read it
for the field-copy. This is the minimum viable visibility —
no code outside `config/` can touch it, matching the previous
intent.
5. **Bootstrap vault construction in `load_with_interpolation`**:
Used `AppConfig { vault_password_file: ..., ..AppConfig::default() }`
instead of e.g. a dedicated helper. The vault only reads
`vault_password_file` so this is sufficient. A comment explains
the dual-vault pattern (bootstrap for secret interpolation vs
canonical from `AppState::init`).
## Verification
- `cargo check` — clean, zero warnings
- `cargo clippy --all-targets` — clean, zero warnings
- `cargo test` — 122 passing, zero failures (same count as 16e)
- Grep confirmation:
- `to_app_config` — zero hits in `src/`
- `to_request_context` — zero hits in `src/`
- `Config::init` / `Config::init_bare` — zero hits in `src/`
- `bridge::` / `config::bridge` / `mod bridge` — zero hits in `src/`
- `src/config/bridge.rs` — file deleted
- Config now contains only serde fields and load/helper
functions; no runtime state.
## Phase 1 Step 16 — overall outcome
The full migration is complete:
| Sub-phase | Outcome |
|-----------|---------|
| 16a | `AppConfig::from_config` built |
| 16b | `install_builtins()` extracted |
| 16c | Vault on AppState (already-existing field, `Vault::init` rewired to `&AppConfig`) |
| 16d | `AppState::init` built |
| 16e | `main.rs` + completers + `RequestContext::bootstrap` switched to new flow |
| 16f | Bridge + Config runtime fields + dead methods deleted |
`Config` is a serde POJO. `AppConfig` is the runtime-resolved
process-wide settings. `AppState` owns process-wide services
(vault, MCP registry, base functions, MCP factory, RAG cache).
`RequestContext` owns per-request mutable state. Each struct
owns its initialization. The REST API surface is now trivial:
parse YAML → `AppConfig::from_config``AppState::init`
per-request `RequestContext`.
## Files modified (16f)
- `src/config/mod.rs` — runtime fields/methods/Default entries
deleted, imports cleaned up, `vault_password_file` made
`pub(super)`, `load_with_interpolation` decoupled from
`to_app_config`, default-test simplified
- `src/config/app_config.rs``from_config` inlines field-copy,
`#[allow(dead_code)]` on `model_id` removed, three tests
rewritten, module docstring refreshed
- `src/config/session.rs` — test helper rewired, imports updated
- `src/config/request_context.rs` — test helpers rewired,
imports updated, module docstring refreshed
- `src/config/app_state.rs` — module docstring refreshed
- `src/config/tool_scope.rs` — module docstring refreshed
## Files deleted (16f)
- `src/config/bridge.rs`
## 16f cleanup pass — Config straggler relocation
After the main 16f deletions landed, three associated functions
remained on `impl Config` that took no `&self` and didn't touch
any Config field — they were holdovers from the god-object era,
attached to `Config` only because Config used to be the
namespace for everything. Relocated each to its rightful owner:
| Method | New home | Why |
|--------|----------|-----|
| `Config::load_macro(name)` | `Macro::load(name)` in `src/config/macros.rs` | Sibling of `Macro::install_macros` already there. The function loads a macro from disk and parses it into a `Macro` — pure macro concern. |
| `Config::search_rag(app, rag, text, signal)` | `Rag::search_with_template(&self, app, text, signal)` in `src/rag/mod.rs` | Operates on a `Rag` instance and one field of `AppConfig`. Pulled `RAG_TEMPLATE` constant along with it. |
| `Config::sync_models(url, signal)` | Free function `config::sync_models(url, signal)` in `src/config/mod.rs` | Fetches a URL, parses YAML, writes to `paths::models_override_file()`. No Config state involved. Sibling pattern to `install_builtins`, `default_sessions_dir`, `list_sessions`. |
### Caller updates
- `src/config/macros.rs:23``Config::load_macro(name)``Macro::load(name)`
- `src/config/input.rs:214``Config::search_rag(&self.app_config, rag, &self.text, abort_signal)``rag.search_with_template(&self.app_config, &self.text, abort_signal)`
- `src/main.rs:149``Config::sync_models(&url, abort_signal.clone())``sync_models(&url, abort_signal.clone())` (added `sync_models` to the `crate::config::{...}` import list)
### Constants relocated
- `RAG_TEMPLATE` moved from `src/config/mod.rs` to `src/rag/mod.rs` alongside the new `search_with_template` method that uses it.
### Final shape of `impl Config`
```rust
impl Config {
pub async fn load_with_interpolation(info_flag: bool) -> Result<Self> { ... }
pub fn load_from_file(config_path: &Path) -> Result<(Self, String)> { ... }
pub fn load_from_str(content: &str) -> Result<Self> { ... }
pub fn load_dynamic(model_id: &str) -> Result<Self> { ... }
}
```
Four loaders, all returning `Self` or `(Self, String)`. Nothing
else. The `Config` type is now genuinely what its docstring
claims: a serde POJO with constructors. No squatters.
### Verification (cleanup pass)
- `cargo check` — clean
- `cargo clippy --all-targets` — clean
- `cargo test` — 122 passing, zero failures
- `Config::sync_models` / `Config::load_macro` / `Config::search_rag` — zero hits in `src/`
### Files modified (cleanup pass)
- `src/config/mod.rs` — deleted `Config::load_macro`, `Config::search_rag`, `Config::sync_models`, and `RAG_TEMPLATE` const; added free `sync_models` function
- `src/config/macros.rs` — added `Macro::load`, updated import (added `Context`, `read_to_string`; removed `Config`)
- `src/rag/mod.rs` — added `RAG_TEMPLATE` const and `Rag::search_with_template` method
- `src/config/input.rs` — updated caller to `rag.search_with_template`
- `src/main.rs` — added `sync_models` to import list, updated caller
@@ -0,0 +1,348 @@
# Phase 1 Step 2 — Implementation Notes
## Status
Done.
## Plan reference
- Plan: `docs/PHASE-1-IMPLEMENTATION-PLAN.md`
- Section: "Step 2: Migrate static methods off Config"
## Summary
Extracted 33 static (no-`self`) methods from `impl Config` into a new
`src/config/paths.rs` module and migrated every caller across the
codebase. The deprecated forwarders the plan suggested as an
intermediate step were added, used to drive the callsite migration,
and then deleted in the same step because the migration was
mechanically straightforward with `ast-grep` and the forwarders
became dead immediately.
## What was changed
### New files
- **`src/config/paths.rs`** (~270 lines)
- Module docstring explaining the extraction rationale and the
(transitional) compatibility shim pattern.
- `#![allow(dead_code)]` at module scope because most functions
were briefly dead during the in-flight migration; kept for the
duration of Step 2 and could be narrowed or removed in a later
cleanup (see "Follow-up" below).
- All 33 functions as free-standing `pub fn`s, implementations
copied verbatim from `impl Config`:
- Path helpers: `config_dir`, `local_path`, `cache_path`,
`oauth_tokens_path`, `token_file`, `log_path`, `config_file`,
`roles_dir`, `role_file`, `macros_dir`, `macro_file`,
`env_file`, `rags_dir`, `functions_dir`, `functions_bin_dir`,
`mcp_config_file`, `global_tools_dir`, `global_utils_dir`,
`bash_prompt_utils_file`, `agents_data_dir`, `agent_data_dir`,
`agent_config_file`, `agent_bin_dir`, `agent_rag_file`,
`agent_functions_file`, `models_override_file`
- Listing helpers: `list_roles`, `list_rags`, `list_macros`
- Existence checks: `has_role`, `has_macro`
- Config loaders: `log_config`, `local_models_override`
### Modified files
Migration touched 14 source files — all of `src/config/mod.rs`'s
internal callers, plus every external `Config::method()` callsite:
- **`src/config/mod.rs`** — removed the 33 static-method definitions
from `impl Config`, rewrote every `Self::method()` internal caller
to use `paths::method()`, and removed the `log::LevelFilter` import
that became unused after `log_config` moved away.
- **`src/config/bridge.rs`** — no changes (bridge is unaffected by
path migrations).
- **`src/config/macros.rs`** — added `use crate::config::paths;`,
migrated one `Config::macros_dir().display()` call.
- **`src/config/agent.rs`** — added `use crate::config::paths;`,
migrated 2 `Config::agents_data_dir()` calls, 4 `agent_data_dir`
calls, 3 `agent_config_file` calls, 1 `agent_rag_file` call.
- **`src/config/request_context.rs`** — no changes.
- **`src/config/app_config.rs`, `app_state.rs`** — no changes.
- **`src/main.rs`** — added `use crate::config::paths;`, migrated
`Config::log_config()`, `Config::list_roles(true)`,
`Config::list_rags()`, `Config::list_macros()`.
- **`src/function/mod.rs`** — added `use crate::config::paths;`,
migrated ~25 callsites across `Config::config_dir`,
`functions_dir`, `functions_bin_dir`, `global_tools_dir`,
`agent_bin_dir`, `agent_data_dir`, `agent_functions_file`,
`bash_prompt_utils_file`. Removed `Config` from the `use
crate::{config::{...}}` block because it became unused.
- **`src/repl/mod.rs`** — added `use crate::config::paths;`,
migrated `Config::has_role(name)` and `Config::has_macro(name)`.
- **`src/cli/completer.rs`** — added `use crate::config::paths;`,
migrated `Config::list_roles(true)`, `Config::list_rags()`,
`Config::list_macros()`.
- **`src/utils/logs.rs`** — replaced `use crate::config::Config;`
with `use crate::config::paths;` (Config was only used for
`log_path`); migrated `Config::log_path()` call.
- **`src/mcp/mod.rs`** — added `use crate::config::paths;`,
migrated 3 `Config::mcp_config_file().display()` calls.
- **`src/client/common.rs`** — added `use crate::config::paths;`,
migrated `Config::local_models_override()`. Removed `Config` from
the `config::{Config, GlobalConfig, Input}` import because it
became unused.
- **`src/client/oauth.rs`** — replaced `use crate::config::Config;`
with `use crate::config::paths;` (Config was only used for
`token_file`); migrated 2 `Config::token_file` calls.
### Module registration
- **`src/config/mod.rs`** — added `pub(crate) mod paths;` in the
module declaration block, alphabetically placed between `macros`
and `prompts`.
## Key decisions
### 1. The deprecated forwarders lived for the whole migration but not beyond
The plan said to keep `#[deprecated]` forwarders around while
migrating callsites module-by-module. I followed that approach but
collapsed the "migrate then delete" into a single step because the
callsite migration was almost entirely mechanical — `ast-grep` with
per-method patterns handled the bulk, and only a few edge cases
(`Self::X` inside `&`-expressions, multi-line `format!` calls)
required manual text edits. By the time all 33 methods had zero
external callers, keeping the forwarders would have just generated
dead_code warnings.
The plan also said "then remove the deprecated methods" as a distinct
phase, and that's exactly what happened — just contiguously with the
migration rather than as a separate commit. The result is the same:
no forwarders in the final tree, all callers routed through
`paths::`.
### 2. `paths` is a `pub(crate)` module, not `pub`
I registered the module as `pub(crate) mod paths;` so the functions
are available anywhere in the crate via `crate::config::paths::X`
but not re-exported as part of Loki's public API surface. This
matches the plan's intent — these are internal implementation
details that happen to have been static methods on `Config`. If
anything external needs a config path in the future, the proper
shape is probably to add it as a method on `AppConfig` (which goes
through Step 3's global-read migration anyway) rather than exposing
`paths` publicly.
### 3. `log_config` stays in `paths.rs` despite not being a path
`log_config()` returns `(LevelFilter, Option<PathBuf>)` — it reads
environment variables to determine the log level plus falls back to
`log_path()` for the file destination. Strictly speaking, it's not
a "path" function, but:
- It's a static no-`self` helper (the reason it's in Step 2)
- It's used in exactly one place (`main.rs:446`)
- Splitting it into its own module would add complexity for no
benefit
The plan also listed it in the migration table as belonging in
`paths.rs`. I followed the plan.
### 4. `#![allow(dead_code)]` at module scope, not per-function
I initially scoped the allow to the whole `paths.rs` module because
during the mid-migration state, many functions had zero callers
temporarily. I kept it at module scope rather than narrowing to
individual functions as they became used again, because by the end
of Step 2 all 33 functions have at least one real caller and the
allow is effectively inert — but narrowing would mean tracking
which functions are used vs not in every follow-up step. Module-
level allow is set-and-forget.
This is slightly looser than ideal. See "Follow-up" below.
### 5. `ast-grep` was the primary migration tool, with manual edits for awkward cases
`ast-grep --pattern 'Config::method()'` and
`--pattern 'Self::method()'` caught ~90% of the callsites cleanly.
The remaining ~10% fell into two categories that `ast-grep` handled
poorly:
1. **Calls wrapped in `.display()` or `.to_string_lossy()`.** Some
ast-grep patterns matched these, others didn't — the behavior
seemed inconsistent. When a pattern found 0 matches but grep
showed real matches, I switched to plain text `Edit` for that
cluster.
2. **`&Self::X()` reference expressions.** `ast-grep` appeared to
not match `Self::X()` when it was the operand of a `&` reference,
presumably because the parent node shape was different. Plain
text `Edit` handled these without issue.
These are tooling workarounds, not architectural concerns. The
final tree has no `Config::X` or `Self::X` callers for any of the
33 migrated methods.
### 6. Removed `Config` import from three files that no longer needed it
`src/function/mod.rs`, `src/client/common.rs`, `src/client/oauth.rs`,
and `src/utils/logs.rs` all had `use crate::config::Config;` (or
similar) imports that became unused after every call was migrated.
I removed them. This is a minor cleanup but worth doing because:
- Clippy flags unused imports as warnings
- Leaving them in signals "this file might still need Config" which
future migration steps would have to double-check
## Deviations from plan
### 1. `sync_models` is not in Step 2
The plan's Step 2 table listed `sync_models(url, abort)` as a
migration target, but grep showed only `sync_models_url(&self) ->
String` exists in the code. That's a `&self` method, so it belongs
in Step 3 (global-read methods), not Step 2.
I skipped it here and will pick it up in Step 3. The Step 2 actual
count is 33 methods, not the 34 the plan's table implies.
### 2. Forwarders deleted contiguously, not in a separate sub-step
See Key Decision #1. The plan described a two-phase approach
("leave forwarders, migrate callers module-by-module, then remove
forwarders"). I compressed this into one pass because the migration
was so mechanical there was no value in the intermediate state.
## Verification
### Compilation
- `cargo check` — clean, **zero warnings, zero errors**
- `cargo clippy` — clean
### Tests
- `cargo test`**63 passed, 0 failed** (same as Step 1 — no new
tests were added because Step 2 is a pure code-move with no new
behavior to test; the existing test suite verifies nothing
regressed)
### Manual smoke test
Not applicable — Step 2 is a pure code-move. The path computations
are literally the same code at different call sites. If existing
tests pass and nothing references Config's static methods anymore,
there's nothing to manually verify beyond the compile.
### Callsite audit
```
cargo check 2>&1 | grep "Config::\(config_dir\|local_path\|...\)"
```
Returns zero matches. Every external `Config::method()` callsite
for the 33 migrated methods has been converted to `paths::method()`.
## Handoff to next step
### What Step 3 can rely on
Step 3 (migrate global-read methods to `AppConfig`) can rely on:
- `src/config/paths.rs` exists and holds every static path helper
plus `log_config`, `list_*`, `has_*`, and `local_models_override`
- Zero `Config::config_dir()`, `Config::cache_path()`, etc. calls
remain in the codebase
- The `#[allow(dead_code)]` on `paths.rs` at module scope is safe to
remove at any time now that all functions have callers
- `AppConfig` (from Step 0) is still fully populated and ready to
receive method migrations
- The bridge from Step 1 (`Config::to_app_config`,
`to_request_context`, `from_parts`) is unchanged and still works
- `Config` struct has no more static methods except those that were
kept because they DO take `&self` (`vault_password_file`,
`messages_file`, `sessions_dir`, `session_file`, `rag_file`,
`state`, etc.)
- Deprecation forwarders are GONE — don't add them back
### What Step 3 should watch for
- **`sync_models_url`** was listed in the Step 2 plan table as
static but is actually `&self`. It's a Step 3 target
(global-read). Pick it up there.
- **The Step 3 target list** (from `PHASE-1-IMPLEMENTATION-PLAN.md`):
`vault_password_file`, `editor`, `sync_models_url`, `light_theme`,
`render_options`, `print_markdown`, `rag_template`,
`select_functions`, `select_enabled_functions`,
`select_enabled_mcp_servers`. These are all `&self` methods that
only read serialized config state.
- **The `vault_password_file` field on `AppConfig` is `pub(crate)`,
not `pub`.** The accessor method on `AppConfig` will need to
encapsulate the same fallback logic that the `Config` method has
(see `src/config/mod.rs` — it falls back to
`gman::config::Config::local_provider_password_file()`).
- **`print_markdown` depends on `render_options`.** When migrating
them to `AppConfig`, preserve the dependency chain.
- **`select_functions` / `select_enabled_functions` /
`select_enabled_mcp_servers` take a `&Role` parameter.** Their
new signatures on `AppConfig` will be `&self, role: &Role` — make
sure `Role` is importable in the `app_config.rs` module (it
currently isn't).
- **Strategy for the Step 3 migration:** same as Step 2 — create
methods on `AppConfig`, add `#[deprecated]` forwarders on
`Config`, migrate callsites with `ast-grep`, delete the
forwarders. Should be quicker than Step 2 because the method
count is smaller (10 vs 33) and the pattern is now well-
established.
### What Step 3 should NOT do
- Don't touch `paths.rs` — it's complete.
- Don't touch `bridge.rs` — Step 3's migrations will still flow
through the bridge's round-trip test correctly.
- Don't try to migrate `current_model`, `extract_role`, `sysinfo`,
or any of the `set_*` methods — those are "mixed" methods listed
in Step 7, not Step 3.
- Don't delete `Config` struct fields yet. Step 3 only moves
*methods* that read fields; the fields themselves still exist on
`Config` (and on `AppConfig`) in parallel until Step 10.
### Files to re-read at the start of Step 3
- `docs/PHASE-1-IMPLEMENTATION-PLAN.md` — Step 3 section (table of
10 global-read methods and their target signatures)
- This notes file — specifically the "What Step 3 should watch for"
section
- `src/config/app_config.rs` — to see the current `AppConfig` shape
and decide where to put new methods
- The current `&self` methods on `Config` in `src/config/mod.rs`
that are being migrated
## Follow-up (not blocking Step 3)
### 1. Narrow or remove `#![allow(dead_code)]` on `paths.rs`
At Step 2's end, every function in `paths.rs` has real callers, so
the module-level allow could be removed without producing warnings.
I left it in because it's harmless and removes the need to add
per-function allows during mid-migration states in later steps.
Future cleanup pass can tighten this.
### 2. Consider renaming `paths.rs` if its scope grows
`log_config`, `list_roles`, `list_rags`, `list_macros`, `has_role`,
`has_macro`, and `local_models_override` aren't strictly "paths"
but they're close enough that extracting them into a sibling module
would be premature abstraction. If Steps 3+ add more non-path
helpers to the same module, revisit this.
### 3. The `Config::config_dir` deletion removes one access point for env vars
The `config_dir()` function was also the entry point for XDG-
compatible config location discovery. Nothing about that changed —
it still lives in `paths::config_dir()` — but if Step 4+ needs to
reference the config directory from code that doesn't yet import
`paths`, the import list will need updating.
## References
- Phase 1 plan: `docs/PHASE-1-IMPLEMENTATION-PLAN.md`
- Step 1 notes: `docs/implementation/PHASE-1-STEP-1-NOTES.md`
- New file: `src/config/paths.rs`
- Modified files (module registration + callsite migration): 14
files across `src/config/`, `src/function/`, `src/repl/`,
`src/cli/`, `src/main.rs`, `src/utils/`, `src/mcp/`,
`src/client/`
@@ -0,0 +1,326 @@
# Phase 1 Step 3 — Implementation Notes
## Status
Done.
## Plan reference
- Plan: `docs/PHASE-1-IMPLEMENTATION-PLAN.md`
- Section: "Step 3: Migrate global-read methods to AppConfig"
## Summary
Added 7 global-read methods to `AppConfig` as inherent methods
duplicating the bodies that still exist on `Config`. The planned
approach (deprecated forwarders + caller migration) turned out to
be the wrong shape for this step because callers hold `Config`
instances, not `AppConfig` instances, and giving them an `AppConfig`
would require either a sync'd `Arc<AppConfig>` field on `Config`
(which Step 4's global-write migration would immediately break) or
cloning on every call. The clean answer is to duplicate during the
bridge window and let callers migrate naturally when Steps 8-9
switch them from `Config` to `RequestContext` + `AppState`. The
duplication is 7 methods / ~100 lines and deletes itself when
`Config` is removed in Step 10.
**Three methods from the plan's Step 3 target list were deferred
to Step 7** because they read runtime state, not just serialized
state (see "Deviations from plan").
## What was changed
### Modified files
- **`src/config/app_config.rs`** — added 6 new imports
(`MarkdownRender`, `RenderOptions`, `IS_STDOUT_TERMINAL`,
`decode_bin`, `anyhow`, `env`, `ThemeSet`) and a new
`impl AppConfig` block with 7 methods under
`#[allow(dead_code)]`:
- `vault_password_file(&self) -> PathBuf`
- `editor(&self) -> Result<String>`
- `sync_models_url(&self) -> String`
- `light_theme(&self) -> bool`
- `render_options(&self) -> Result<RenderOptions>`
- `print_markdown(&self, text) -> Result<()>`
- `rag_template(&self, embeddings, sources, text) -> String`
All bodies are copy-pasted verbatim from the originals on
`Config`, with the following adjustments for the new module
location:
- `EDITOR` static → `super::EDITOR` (shared across both impls)
- `SYNC_MODELS_URL` const → `super::SYNC_MODELS_URL`
- `RAG_TEMPLATE` const → `super::RAG_TEMPLATE`
- `LIGHT_THEME` / `DARK_THEME` consts → `super::LIGHT_THEME` /
`super::DARK_THEME`
- `paths::local_path()` continues to work unchanged (already in
the right module from Step 2)
### Unchanged files
- **`src/config/mod.rs`** — the original `Config::vault_password_file`,
`editor`, `sync_models_url`, `light_theme`, `render_options`,
`print_markdown`, `rag_template` method definitions are
deliberately left intact. They continue to work for every existing
caller. The deletion of these happens in Step 10 when `Config` is
removed entirely.
- **All external callers** (26 callsites across 6 files) — also
unchanged. They continue to call `config.editor()`,
`config.render_options()`, etc. on their `Config` instances.
## Key decisions
### 1. Duplicate method bodies instead of `#[deprecated]` forwarders
The plan prescribed the same shape as Step 2: add the new version,
add a `#[deprecated]` forwarder on the old location, migrate
callers, delete forwarders. This worked cleanly in Step 2 because
the new location was a free-standing `paths` module — callers
could switch from `Config::method()` (associated function) to
`paths::method()` (free function) without needing any instance.
Step 3 is fundamentally different: `AppConfig::method(&self)` needs
an `AppConfig` instance. Callers today hold `Config` instances.
Giving them an `AppConfig` means one of:
(a) Add an `app_config: Arc<AppConfig>` field to `Config` and have
the forwarder do `self.app_config.method()`. **Rejected**
because Step 4 (global-write) will mutate `Config` fields via
`set_wrap`, `update`, etc. — keeping the `Arc<AppConfig>`
in sync would require either rebuilding it on every write (slow
and racy) or tracking dirty state (premature complexity).
(b) Have the forwarder do `self.to_app_config().method()`. **Rejected**
because `to_app_config` clones all 40 serialized fields on
every call — a >100x slowdown for simple accessors like
`light_theme()`.
(c) Duplicate the method bodies on both `Config` and `AppConfig`,
let each caller use whichever instance it has, delete the
`Config` versions when `Config` itself is deleted in Step 10.
**Chosen.**
Option (c) has a small ongoing cost (~100 lines of duplicated
logic) but is strictly additive, has zero runtime overhead, and
automatically cleans up in Step 10. It also matches how Rust's
type system prefers to handle this — parallel impls are cheaper
than synchronized state.
### 2. Caller migration is deferred to Steps 8-9
With duplication in place, the migration from `Config` to
`AppConfig` happens organically later:
- When Step 8 rewrites `main.rs` to construct an `AppState` and
`RequestContext` instead of a `GlobalConfig`, the `main.rs`
callers of `config.editor()` naturally become
`ctx.app.config.editor()` — calling into `AppConfig`'s version.
- Same for every other callsite that gets migrated in Step 8+.
- By Step 10, the old `Config::editor()` etc. have zero callers
and get deleted along with the rest of `Config`.
This means Step 3 is "additive only, no caller touches" —
deliberately smaller in scope than Step 2. That's the correct call
given the instance-type constraint.
### 3. `EDITOR` static is shared between `Config::editor` and `AppConfig::editor`
`editor()` caches the resolved editor path in a module-level
`static EDITOR: OnceLock<Option<String>>` in `src/config/mod.rs`.
Both `Config::editor(&self)` and `AppConfig::editor(&self)` read
and initialize the same static via `super::EDITOR`. This matches
the current behavior: whichever caller resolves first wins the
`OnceLock::get_or_init` race and subsequent callers see the cached
value.
There's a latent bug here (if `Config.editor` and `AppConfig.editor`
fields ever differ, the first caller wins regardless) but it's
pre-existing and preserved during the bridge window. Step 10 resolves
it by deleting `Config` entirely.
### 4. Three methods deferred to Step 7
See "Deviations from plan."
## Deviations from plan
### `select_functions`, `select_enabled_functions`, `select_enabled_mcp_servers` belong in Step 7
The plan's Step 3 table lists all three. Reading their bodies (in
`src/config/mod.rs` at lines 1816, 1828, 1923), they all touch
`self.functions` and `self.agent` — both of which are `#[serde(skip)]`
runtime fields that do NOT exist on `AppConfig` and will never
exist there (they're per-request state living on `RequestContext`
and `AgentRuntime`).
These are "mixed" methods in the plan's Step 7 taxonomy — they
conditionally read serialized config + runtime state depending on
whether an agent is active. Moving them to `AppConfig` now would
require `AppConfig` to hold `functions` and `agent` fields, which
directly contradicts the Step 0 / Step 6.5 design.
**Action taken:** left all three on `Config` unchanged. They get
migrated in Step 7 with the new signature
`(app: &AppConfig, ctx: &RequestContext, role: &Role) -> Vec<...>`
as described in the plan.
**Action required from Step 7:** pick up these three methods. The
call graph is:
- `Config::select_functions` is called from `src/config/input.rs:243`
(one external caller)
- `Config::select_functions` internally calls the two private
helpers
- The private helpers read both `self.functions` (runtime,
per-request) and `self.agent` (runtime, per-request) — so they
fundamentally need `RequestContext` not `AppConfig`
### Step 3 count: 7 methods, not 10
The plan's table listed 10 target methods. After excluding the
three `select_*` methods, Step 3 migrated 7. This is documented
here rather than silently completing a smaller Step 3 so Step 7's
scope is clear.
## Verification
### Compilation
- `cargo check` — clean, **zero warnings, zero errors**
- `cargo clippy` — clean
### Tests
- `cargo test`**63 passed, 0 failed** (same as Steps 12)
Step 3 added no new tests because it's duplication — there's
nothing new to verify. The existing test suite confirms:
(a) the original `Config` methods still work (they weren't touched)
(b) `AppConfig` still compiles and its `Default` impl is intact
(needed for Step 1's bridge test which uses
`build_populated_config()``to_app_config()`)
Running `cargo test bridge` specifically:
```
test config::bridge::tests::round_trip_default_config ... ok
test config::bridge::tests::to_app_config_copies_every_serialized_field ... ok
test config::bridge::tests::to_request_context_copies_every_runtime_field ... ok
test config::bridge::tests::round_trip_preserves_all_non_lossy_fields ... ok
test result: ok. 4 passed
```
The bridge's round-trip test still works, which proves the new
methods on `AppConfig` don't interfere with the struct layout or
deserialization. They're purely additive impl-level methods.
### Manual smoke test
Not applicable — no runtime behavior changed. CLI and REPL still
call `Config::editor()` etc. as before.
## Handoff to next step
### What Step 4 can rely on
Step 4 (migrate global-write methods) can rely on:
- `AppConfig` now has 7 inherent read methods that mirror the
corresponding `Config` methods exactly
- `#[allow(dead_code)]` on the `impl AppConfig` block in
`app_config.rs` — safe to leave as-is, it'll go away when the
first caller is migrated in Step 8+
- `Config` is unchanged for all 7 methods and continues to work
for every current caller
- The bridge (`Config::to_app_config`, `to_request_context`,
`from_parts`) from Step 1 still works
- The `paths` module from Step 2 is unchanged
- `Config::select_functions`, `select_enabled_functions`,
`select_enabled_mcp_servers` are **still on `Config`** and must
stay there through Step 6. They get migrated in Step 7.
### What Step 4 should watch for
- **The Step 4 target list** (from `PHASE-1-IMPLEMENTATION-PLAN.md`):
`set_wrap`, `update`, `load_envs`, `load_functions`,
`load_mcp_servers`, `setup_model`, `setup_document_loaders`,
`setup_user_agent`. These are global-write methods that
initialize or mutate serialized fields.
- **Tension with Step 3's duplication decision:** Step 4 methods
mutate `Config` fields. If we also duplicate them on `AppConfig`,
then mutations through one path don't affect the other — but no
caller ever mutates both, so this is fine in practice during
the bridge window.
- **`load_functions` and `load_mcp_servers`** are initialization-
only (called once in `Config::init`). They're arguably not
"global-write" in the same sense — they populate runtime-only
fields (`functions`, `mcp_registry`). Step 4 should carefully
classify each: fields that belong to `AppConfig` vs fields that
belong to `RequestContext` vs fields that go away in Step 6.5
(`mcp_registry`).
- **Strategy for Step 4:** because writes are typically one-shot
(`update` is called from `.set` REPL command; `load_envs` is
called once at startup), you can be more lenient about
duplication vs consolidation. Consider: the write methods might
not need to exist on `AppConfig` at all if they're only used
during `Config::init` and never during request handling. Step 4
should evaluate each one individually.
### What Step 4 should NOT do
- Don't add an `app_config: Arc<AppConfig>` field to `Config`
(see Key Decision #1 for why).
- Don't touch the 7 methods added to `AppConfig` in Step 3 — they
stay until Step 8+ caller migration, and Step 10 deletion.
- Don't migrate `select_*` methods — those are Step 7.
- Don't try to migrate callers of the Step 3 methods to go
through `AppConfig` yet. The call sites still hold `Config`,
and forcing a conversion would require either a clone or a
sync'd field.
### Files to re-read at the start of Step 4
- `docs/PHASE-1-IMPLEMENTATION-PLAN.md` — Step 4 section
- This notes file — specifically the "Deviations from plan" and
"What Step 4 should watch for" sections
- `src/config/mod.rs` — the current `Config::set_wrap`, `update`,
`load_*`, `setup_*` method bodies (search for `pub fn set_wrap`,
`pub fn update`, `pub fn load_envs`, etc.)
- `src/config/app_config.rs` — the current shape with 7 new
methods
## Follow-up (not blocking Step 4)
### 1. The `EDITOR` static sharing is pre-existing fragility
Both `Config::editor` and `AppConfig::editor` now share the same
`static EDITOR: OnceLock<Option<String>>`. If two Configs with
different `editor` fields exist (unlikely in practice but possible
during tests), the first caller wins. This isn't new — the single
`Config` version had the same property. Step 10's `Config`
deletion will leave only `AppConfig::editor` which eliminates the
theoretical bug. Worth noting so nobody introduces a test that
assumes per-instance editor caching.
### 2. `impl AppConfig` block grows across Steps 3-7
By the end of Step 7, `AppConfig` will have accumulated: 7 methods
from Step 3, potentially some from Step 4, more from Step 7's
mixed-method splits. The `#[allow(dead_code)]` currently covers
the whole block. As callers migrate in Step 8+, the warning
suppression can be removed. Don't narrow it prematurely during
Steps 4-7.
### 3. Imports added to `app_config.rs`
Step 3 added `MarkdownRender`, `RenderOptions`, `IS_STDOUT_TERMINAL`,
`decode_bin`, `anyhow::{Context, Result, anyhow}`, `env`,
`ThemeSet`. Future steps may add more. The import list is small
enough to stay clean; no reorganization needed.
## References
- Phase 1 plan: `docs/PHASE-1-IMPLEMENTATION-PLAN.md`
- Step 2 notes: `docs/implementation/PHASE-1-STEP-2-NOTES.md`
- Modified file: `src/config/app_config.rs` (imports + new
`impl AppConfig` block)
- Unchanged but relevant: `src/config/mod.rs` (original `Config`
methods still exist for now), `src/config/bridge.rs` (still
passes round-trip tests)
@@ -0,0 +1,362 @@
# Phase 1 Step 4 — Implementation Notes
## Status
Done.
## Plan reference
- Plan: `docs/PHASE-1-IMPLEMENTATION-PLAN.md`
- Section: "Step 4: Migrate global-write methods"
## Summary
Added 4 of 8 planned global-write methods to `AppConfig` as
inherent methods, duplicating the bodies that still exist on
`Config`. The other 4 methods were deferred: 2 to Step 7 (mixed
methods that call into `set_*` methods slated for Step 7), and
2 kept on `Config` because they populate runtime-only fields
(`functions`, `mcp_registry`) that don't belong on `AppConfig`.
Same duplication-no-caller-migration pattern as Step 3 — during
the bridge window both `Config` and `AppConfig` have these
methods; caller migration happens organically in Steps 8-9 when
frontends switch from `GlobalConfig` to `AppState` + `RequestContext`.
## What was changed
### Modified files
- **`src/config/app_config.rs`** — added 4 new imports (`NO_COLOR`,
`get_env_name` via `crate::utils`, `terminal_colorsaurus`
types) and a new `impl AppConfig` block with 4 methods under
`#[allow(dead_code)]`:
- `set_wrap(&mut self, value: &str) -> Result<()>` — parses and
sets `self.wrap` for the `.set wrap` REPL command
- `setup_document_loaders(&mut self)` — seeds default PDF/DOCX
loaders into `self.document_loaders` if not already present
- `setup_user_agent(&mut self)` — expands `"auto"` into
`loki/<version>` in `self.user_agent`
- `load_envs(&mut self)` — ~140 lines of env-var overrides that
populate all 30+ serialized fields from `LOKI_*` environment
variables
All bodies are copy-pasted verbatim from the originals on
`Config`, with references updated for the new module location:
- `read_env_value::<T>``super::read_env_value::<T>`
- `read_env_bool``super::read_env_bool`
- `NO_COLOR`, `IS_STDOUT_TERMINAL`, `get_env_name`, `decode_bin`
→ imported from `crate::utils`
- `terminal_colorsaurus` → direct import
### Unchanged files
- **`src/config/mod.rs`** — the original `Config::set_wrap`,
`load_envs`, `setup_document_loaders`, `setup_user_agent`
definitions are deliberately left intact. They continue to
work for every existing caller. They get deleted in Step 10
when `Config` is removed entirely.
- **`src/config/mod.rs`** — the `read_env_value` and
`read_env_bool` private helpers are unchanged and accessed via
`super::read_env_value` from `app_config.rs`.
## Key decisions
### 1. Only 4 of 8 methods migrated
The plan's Step 4 table listed 8 methods. After reading each one
carefully, I classified them:
| Method | Classification | Action |
|---|---|---|
| `set_wrap` | Pure global-write | **Migrated** |
| `load_envs` | Pure global-write | **Migrated** |
| `setup_document_loaders` | Pure global-write | **Migrated** |
| `setup_user_agent` | Pure global-write | **Migrated** |
| `setup_model` | Calls `self.set_model()` (Step 7 mixed) | **Deferred to Step 7** |
| `load_functions` | Writes runtime `self.functions` field | **Not migrated** (stays on `Config`) |
| `load_mcp_servers` | Writes runtime `self.mcp_registry` field (going away in Step 6.5) | **Not migrated** (stays on `Config`) |
| `update` | Dispatches to 10+ `set_*` methods, all Step 7 mixed | **Deferred to Step 7** |
See "Deviations from plan" for detail on each deferral.
### 2. Same duplication-no-forwarder pattern as Step 3
Step 4's target callers are all `.write()` on a `GlobalConfig` /
`Config` instance. Like Step 3, giving these callers an
`AppConfig` instance would require either (a) a sync'd
`Arc<AppConfig>` field on `Config` (breaks because Step 4
itself mutates `Config`), (b) cloning on every call (expensive
for `load_envs` which touches 30+ fields), or (c) duplicating
the method bodies.
Option (c) is the same choice Step 3 made and for the same
reasons. The duplication is 4 methods (~180 lines total dominated
by `load_envs`) that auto-delete in Step 10.
### 3. `load_envs` body copied verbatim despite being long
`load_envs` is ~140 lines of repetitive `if let Some(v) =
read_env_value(...) { self.X = v; }` blocks — one per serialized
field. I considered refactoring it to reduce repetition (e.g., a
macro or a data-driven table) but resisted that urge because:
- The refactor would be a behavior change (even if subtle) during
a mechanical code-move step
- The verbatim copy is easy to audit for correctness (line-by-line
diff against the original)
- It gets deleted in Step 10 anyway, so the repetition is
temporary
- Any cleanup belongs in a dedicated tidying pass after Phase 1,
not in the middle of a split
### 4. Methods stay in a separate `impl AppConfig` block
Step 3 added its 7 read methods in one `impl AppConfig` block.
Step 4 adds its 4 write methods in a second `impl AppConfig`
block directly below it. Rust allows multiple `impl` blocks on
the same type, and the visual separation makes it obvious which
methods are reads vs writes during the bridge window. When Step
10 deletes `Config`, both blocks can be merged or left separate
based on the cleanup maintainer's preference.
## Deviations from plan
### `setup_model` deferred to Step 7
The plan lists `setup_model` as a Step 4 target. Reading its
body:
```rust
fn setup_model(&mut self) -> Result<()> {
let mut model_id = self.model_id.clone();
if model_id.is_empty() {
let models = list_models(self, ModelType::Chat);
// ...
}
self.set_model(&model_id)?; // ← this is Step 7 "mixed"
self.model_id = model_id;
Ok(())
}
```
It calls `self.set_model(&model_id)`, which the plan explicitly
lists in **Step 7** ("mixed methods") because `set_model`
conditionally writes to `role_like` (runtime) or `model_id`
(serialized) depending on whether a role/session/agent is
active. Since `setup_model` can't be migrated until `set_model`
exists on `AppConfig` / `RequestContext`, it has to wait for
Step 7.
**Action:** left `Config::setup_model` intact. Step 7 picks it up.
### `update` deferred to Step 7
The plan lists `update` as a Step 4 target. Its body is a ~140
line dispatch over keys like `"temperature"`, `"top_p"`,
`"enabled_tools"`, `"enabled_mcp_servers"`, `"max_output_tokens"`,
`"save_session"`, `"compression_threshold"`,
`"rag_reranker_model"`, `"rag_top_k"`, etc. — every branch
calls into a `set_*` method on `Config` that the plan explicitly
lists in **Step 7**:
- `set_temperature` (Step 7)
- `set_top_p` (Step 7)
- `set_enabled_tools` (Step 7)
- `set_enabled_mcp_servers` (Step 7)
- `set_max_output_tokens` (Step 7)
- `set_save_session` (Step 7)
- `set_compression_threshold` (Step 7)
- `set_rag_reranker_model` (Step 7)
- `set_rag_top_k` (Step 7)
Migrating `update` before those would mean `update` calls
`Config::set_X` (old) from inside `AppConfig::update` (new) —
which crosses the type boundary awkwardly and leaves `update`'s
behavior split between the two types during the migration
window. Not worth it.
**Action:** left `Config::update` intact. Step 7 picks it up
along with the `set_*` methods it dispatches to. At that point
all 10 dependencies will be on `AppConfig`/`RequestContext` and
`update` can be moved cleanly.
### `load_functions` not migrated (stays on Config)
The plan lists `load_functions` as a Step 4 target. Its body:
```rust
fn load_functions(&mut self) -> Result<()> {
self.functions = Functions::init(
self.visible_tools.as_ref().unwrap_or(&Vec::new())
)?;
if self.working_mode.is_repl() {
self.functions.append_user_interaction_functions();
}
Ok(())
}
```
It writes to `self.functions` — a `#[serde(skip)]` runtime field
that lives on `RequestContext` after Step 6 and inside `ToolScope`
after Step 6.5. It also reads `self.working_mode`, another
runtime field. This isn't a "global-write" method in the sense
Step 4 targets — it's a runtime initialization method that will
move to `RequestContext` when `functions` does.
**Action:** left `Config::load_functions` intact. It gets
handled in Step 5 or Step 6 when runtime fields start moving.
Not Step 4, not Step 7.
### `load_mcp_servers` not migrated (stays on Config)
Same story as `load_functions`. Its body writes
`self.mcp_registry` (a field slated for deletion in Step 6.5 per
the architecture plan) and `self.functions` (runtime, moving in
Step 5/6). Nothing about this method belongs on `AppConfig`.
**Action:** left `Config::load_mcp_servers` intact. It gets
handled or deleted in Step 6.5 when `McpFactory` replaces the
singleton registry entirely.
## Verification
### Compilation
- `cargo check` — clean, **zero warnings, zero errors**
- `cargo clippy` — clean
### Tests
- `cargo test`**63 passed, 0 failed** (unchanged from Steps 13)
Step 4 added no new tests because it's duplication. The existing
test suite confirms:
- The original `Config` methods still work (they weren't touched)
- `AppConfig` still compiles, its `Default` impl is intact
- The bridge's round-trip test still passes:
- `config::bridge::tests::round_trip_default_config`
- `config::bridge::tests::round_trip_preserves_all_non_lossy_fields`
- `config::bridge::tests::to_app_config_copies_every_serialized_field`
- `config::bridge::tests::to_request_context_copies_every_runtime_field`
### Manual smoke test
Not applicable — no runtime behavior changed. CLI and REPL still
call `Config::set_wrap()`, `Config::update()`, `Config::load_envs()`,
etc. unchanged.
## Handoff to next step
### What Step 5 can rely on
Step 5 (migrate request-read methods to `RequestContext`) can
rely on:
- `AppConfig` now has **11 methods total**: 7 reads from Step 3,
4 writes from Step 4
- `#[allow(dead_code)]` on both `impl AppConfig` blocks — safe
to leave as-is, goes away when callers migrate in Steps 8+
- `Config` is unchanged for all 11 methods — originals still
work for all current callers
- The bridge from Step 1, the paths module from Step 2, the
read methods from Step 3 are all unchanged and still working
- **`setup_model`, `update`, `load_functions`, `load_mcp_servers`
are still on `Config`** and must stay there:
- `setup_model` → migrates in Step 7 with the `set_*` methods
- `update` → migrates in Step 7 with the `set_*` methods
- `load_functions` → migrates to `RequestContext` in Step 5 or
Step 6 (whichever handles `Functions`)
- `load_mcp_servers` → deleted/transformed in Step 6.5
### What Step 5 should watch for
- **Step 5 targets are `&self` request-read methods** that read
runtime fields like `self.session`, `self.role`, `self.agent`,
`self.rag`, etc. The plan's Step 5 table lists:
`state`, `messages_file`, `sessions_dir`, `session_file`,
`rag_file`, `info`, `role_info`, `session_info`, `agent_info`,
`agent_banner`, `rag_info`, `list_sessions`,
`list_autoname_sessions`, `is_compressing_session`,
`role_like_mut`.
- **These migrate to `RequestContext`**, not `AppConfig`, because
they read per-request state.
- **Same duplication pattern applies.** Add methods to
`RequestContext`, leave originals on `Config`, no caller
migration.
- **`sessions_dir` and `messages_file` already use `paths::`
functions internally** (from Step 2's migration). They read
`self.agent` to decide between the global and agent-scoped
path. Those paths come from the `paths` module.
- **`role_like_mut`** is interesting — it's the helper that
returns a mutable reference to whichever of role/session/agent
is on top. It's the foundation for every `set_*` method in
Step 7. Migrate it to `RequestContext` in Step 5 so Step 7
has it ready.
- **`list_sessions` and `list_autoname_sessions`** wrap
`paths::list_file_names` with some filtering. They take
`&self` to know the current agent context for path resolution.
### What Step 5 should NOT do
- Don't touch the Step 3/4 methods on `AppConfig` — they stay
until Steps 8+ caller migration.
- Don't try to migrate `update`, `setup_model`, `load_functions`,
or `load_mcp_servers` — each has a specific later-step home.
- Don't touch the `bridge.rs` conversions — still needed.
- Don't touch `paths.rs` — still complete.
- Don't migrate any caller of any method yet — callers stay on
`Config` through the bridge window.
### Files to re-read at the start of Step 5
- `docs/PHASE-1-IMPLEMENTATION-PLAN.md` — Step 5 section has
the full request-read method table
- This notes file — specifically "Deviations from plan" and
"What Step 5 should watch for"
- `src/config/request_context.rs` — to see the current shape
that Step 5 will extend
- Current `Config` method bodies in `src/config/mod.rs` for
each Step 5 target (search for `pub fn state`, `pub fn
messages_file`, etc.)
## Follow-up (not blocking Step 5)
### 1. `load_envs` is the biggest duplication so far
At ~140 lines, `load_envs` is the largest single duplication in
the bridge. It's acceptable because it's self-contained and
auto-deletes in Step 10, but it's worth flagging that if Phase 1
stalls anywhere between now and Step 10, this method's duplication
becomes a maintenance burden. Env var changes would need to be
made twice.
**Mitigation during the bridge window:** if someone adds a new
env var during Steps 5-9, they MUST add it to both
`Config::load_envs` and `AppConfig::load_envs`. Document this in
the Step 5 notes if any env var changes ship during that
interval.
### 2. `AppConfig` now has 11 methods across 2 `impl` blocks
Fine during Phase 1. Post-Phase 1 cleanup can consider whether to
merge them or keep the read/write split. Not a blocker.
### 3. The `read_env_value` / `read_env_bool` helpers are accessed via `super::`
These are private module helpers in `src/config/mod.rs`. Step 4's
migration means `app_config.rs` now calls them via `super::`,
which works because `app_config.rs` is a sibling module. If
Phase 2+ work moves these helpers anywhere else, the `super::`
references in `app_config.rs` will need updating.
## References
- Phase 1 plan: `docs/PHASE-1-IMPLEMENTATION-PLAN.md`
- Step 3 notes: `docs/implementation/PHASE-1-STEP-3-NOTES.md`
(for the duplication rationale)
- Modified file: `src/config/app_config.rs` (new imports + new
`impl AppConfig` block with 4 write methods)
- Unchanged but referenced: `src/config/mod.rs` (original
`Config` methods still exist, private helpers
`read_env_value` / `read_env_bool` accessed via `super::`)
@@ -0,0 +1,413 @@
# Phase 1 Step 5 — Implementation Notes
## Status
Done.
## Plan reference
- Plan: `docs/PHASE-1-IMPLEMENTATION-PLAN.md`
- Section: "Step 5: Migrate request-read methods to RequestContext"
## Summary
Added 13 of 15 planned request-read methods to `RequestContext`
as inherent methods, duplicating the bodies that still exist on
`Config`. The other 2 methods (`info`, `session_info`) were
deferred to Step 7 because they mix runtime reads with calls into
`AppConfig`-scoped helpers (`sysinfo`, `render_options`) or depend
on `sysinfo` which itself touches both serialized and runtime
state.
Same duplication pattern as Steps 3 and 4: callers stay on
`Config` during the bridge window; real caller migration happens
organically in Steps 8-9.
## What was changed
### Modified files
- **`src/config/request_context.rs`** — extended the imports
with 11 new symbols from `super` (parent module constants,
`StateFlags`, `RoleLike`, `paths`) plus `anyhow`, `env`,
`PathBuf`, `get_env_name`, and `list_file_names`. Added a new
`impl RequestContext` block with 13 methods under
`#[allow(dead_code)]`:
**Path helpers** (4):
- `messages_file(&self) -> PathBuf` — agent-aware path to
the messages log
- `sessions_dir(&self) -> PathBuf` — agent-aware sessions
directory
- `session_file(&self, name) -> PathBuf` — combines
`sessions_dir` with a session name
- `rag_file(&self, name) -> PathBuf` — agent-aware RAG file
path
**State query** (1):
- `state(&self) -> StateFlags` — returns bitflags for which
scopes are currently active
**Scope info getters** (4):
- `role_info(&self) -> Result<String>` — exports the current
role (from session or standalone)
- `agent_info(&self) -> Result<String>` — exports the current
agent
- `agent_banner(&self) -> Result<String>` — returns the
agent's conversation starter banner
- `rag_info(&self) -> Result<String>` — exports the current
RAG
**Session listings** (2):
- `list_sessions(&self) -> Vec<String>`
- `list_autoname_sessions(&self) -> Vec<String>`
**Misc** (2):
- `is_compressing_session(&self) -> bool`
- `role_like_mut(&mut self) -> Option<&mut dyn RoleLike>`
returns the currently-active `RoleLike` (session > agent >
role), the foundation for Step 7's `set_*` methods
All bodies are copy-pasted verbatim from the originals on
`Config`, with the following minor adjustments for the new
module location:
- Constants like `MESSAGES_FILE_NAME`, `AGENTS_DIR_NAME`,
`SESSIONS_DIR_NAME` imported from `super::`
- `paths::` calls unchanged (already in the right module from
Step 2)
- `list_file_names` imported from `crate::utils::*` → made
explicit
- `get_env_name` imported from `crate::utils::*` → made
explicit
### Unchanged files
- **`src/config/mod.rs`** — the original `Config` versions of
all 13 methods are deliberately left intact. They continue to
work for every existing caller. They get deleted in Step 10
when `Config` is removed entirely.
- **All external callers** of `config.messages_file()`,
`config.state()`, etc. — also unchanged.
## Key decisions
### 1. Only 13 of 15 methods migrated
The plan's Step 5 table listed 15 methods. After reading each
body, I classified them:
| Method | Classification | Action |
|---|---|---|
| `state` | Pure runtime-read | **Migrated** |
| `messages_file` | Pure runtime-read | **Migrated** |
| `sessions_dir` | Pure runtime-read | **Migrated** |
| `session_file` | Pure runtime-read | **Migrated** |
| `rag_file` | Pure runtime-read | **Migrated** |
| `role_info` | Pure runtime-read | **Migrated** |
| `agent_info` | Pure runtime-read | **Migrated** |
| `agent_banner` | Pure runtime-read | **Migrated** |
| `rag_info` | Pure runtime-read | **Migrated** |
| `list_sessions` | Pure runtime-read | **Migrated** |
| `list_autoname_sessions` | Pure runtime-read | **Migrated** |
| `is_compressing_session` | Pure runtime-read | **Migrated** |
| `role_like_mut` | Pure runtime-read (returns `&mut dyn RoleLike`) | **Migrated** |
| `info` | Delegates to `sysinfo` (mixed) | **Deferred to Step 7** |
| `session_info` | Calls `render_options` (AppConfig) + runtime | **Deferred to Step 7** |
See "Deviations from plan" for detail.
### 2. Same duplication pattern as Steps 3 and 4
Callers hold `Config`, not `RequestContext`. Same constraints
apply:
- Giving callers a `RequestContext` requires either: (a) a
sync'd `Arc<RequestContext>` field on `Config` — breaks
because per-request state mutates constantly, (b) cloning on
every call — expensive, or (c) duplicating method bodies.
- Option (c) is the same choice Steps 3 and 4 made.
- The duplication is 13 methods (~170 lines total) that
auto-delete in Step 10.
### 3. `role_like_mut` is particularly important for Step 7
I want to flag this one: `role_like_mut(&mut self)` is the
foundation for every `set_*` method in Step 7 (`set_temperature`,
`set_top_p`, `set_model`, etc.). Those methods all follow the
pattern:
```rust
fn set_something(&mut self, value: Option<T>) {
if let Some(role_like) = self.role_like_mut() {
role_like.set_something(value);
} else {
self.something = value;
}
}
```
The `else` branch (fallback to global) is the "mixed" part that
makes them Step 7 targets. The `if` branch is pure runtime write
— it mutates whichever `RoleLike` is on top.
By migrating `role_like_mut` to `RequestContext` in Step 5, Step
7 can build its new `set_*` methods as `(&mut RequestContext,
&mut AppConfig, value)` signatures where the runtime path uses
`ctx.role_like_mut()` directly. The prerequisite is now in place.
### 4. Path helpers stay on `RequestContext`, not `AppConfig`
`messages_file`, `sessions_dir`, `session_file`, and `rag_file`
all read `self.agent` to decide between global and agent-scoped
paths. `self.agent` is a runtime field (per-request). Even
though the returned paths themselves are computed from `paths::`
functions (no per-request state involved), **the decision of
which path to return depends on runtime state**. So these
methods belong on `RequestContext`, not `AppConfig` or `paths`.
This is the correct split — `paths::` is the "pure path
computation" layer, `RequestContext::messages_file` etc. are
the "which path applies to this request" layer on top.
### 5. `state`, `info`-style methods do not take `&self.app`
None of the 13 migrated methods reference `self.app` (the
`Arc<AppState>`) or any field on `AppConfig`. This is the
cleanest possible split — they're pure runtime-reads. If they
needed both runtime state and `AppConfig`, they'd be mixed (like
`info` and `session_info`, which is why those are deferred).
## Deviations from plan
### `info` deferred to Step 7
The plan lists `info` as a Step 5 target. Reading its body:
```rust
pub fn info(&self) -> Result<String> {
if let Some(agent) = &self.agent {
// ... agent export with session ...
} else if let Some(session) = &self.session {
session.export()
} else if let Some(role) = &self.role {
Ok(role.export())
} else if let Some(rag) = &self.rag {
rag.export()
} else {
self.sysinfo() // ← falls through to sysinfo
}
}
```
The fallback `self.sysinfo()` call is the problem. `sysinfo()`
(lines 571-644 in `src/config/mod.rs`) reads BOTH serialized
fields (`wrap`, `rag_reranker_model`, `rag_top_k`,
`save_session`, `compression_threshold`, `dry_run`,
`function_calling_support`, `mcp_server_support`, `stream`,
`save`, `keybindings`, `wrap_code`, `highlight`, `theme`) AND
runtime fields (`self.rag`, `self.extract_role()` which reads
`self.session`, `self.agent`, `self.role`, `self.model`, etc.).
`sysinfo` is a mixed method in the Step 7 sense — it needs both
`AppConfig` (for the serialized half) and `RequestContext` (for
the runtime half). The plan's Step 7 mixed-method list includes
`sysinfo` explicitly.
Since `info` delegates to `sysinfo` in one of its branches,
migrating `info` without `sysinfo` would leave that branch
broken. **Action taken:** left both `Config::info` and
`Config::sysinfo` intact. Step 7 picks them up as a pair.
### `session_info` deferred to Step 7
The plan lists `session_info` as a Step 5 target. Reading its
body:
```rust
pub fn session_info(&self) -> Result<String> {
if let Some(session) = &self.session {
let render_options = self.render_options()?; // ← AppConfig method
let mut markdown_render = MarkdownRender::init(render_options)?;
// ... reads self.agent for agent_info tuple ...
session.render(&mut markdown_render, &agent_info)
} else {
bail!("No session")
}
}
```
It calls `self.render_options()` which is a Step 3 method now
on `AppConfig`. In the bridge world, the caller holds a
`Config` and can call `config.render_options()` (old) or
`config.to_app_config().render_options()` (new but cloning).
In the post-bridge world with `RequestContext`, the call becomes
`ctx.app.config.render_options()`.
Since `session_info` crosses the `AppConfig` / `RequestContext`
boundary, it's mixed by the Step 7 definition. **Action taken:**
left `Config::session_info` intact. Step 7 picks it up with a
signature like
`(&self, app: &AppConfig) -> Result<String>` or
`(ctx: &RequestContext) -> Result<String>` where
`ctx.app.config.render_options()` is called internally.
### Step 5 count: 13 methods, not 15
Documented here so Step 7's scope is explicit. Step 7 picks up
`info`, `session_info`, `sysinfo`, plus the `set_*` methods and
other items from the original Step 7 list.
## Verification
### Compilation
- `cargo check` — clean, **zero warnings, zero errors**
- `cargo clippy` — clean
### Tests
- `cargo test`**63 passed, 0 failed** (unchanged from
Steps 14)
Step 5 added no new tests because it's duplication. Existing
tests confirm:
- The original `Config` methods still work
- `RequestContext` still compiles, imports are clean
- The bridge's round-trip test still passes
### Manual smoke test
Not applicable — no runtime behavior changed.
## Handoff to next step
### What Step 6 can rely on
Step 6 (migrate request-write methods to `RequestContext`) can
rely on:
- `RequestContext` now has 13 inherent read methods
- The `#[allow(dead_code)]` on the read-methods `impl` block is
safe to leave; callers migrate in Steps 8+
- `Config` is unchanged for all 13 methods
- `role_like_mut` is available on `RequestContext` — Step 7
will use it, and Step 6 might also use it internally when
implementing write methods like `set_save_session_this_time`
- The bridge from Step 1, `paths` module from Step 2,
`AppConfig` methods from Steps 3 and 4 are all unchanged
- **`Config::info`, `session_info`, and `sysinfo` are still on
`Config`** and must stay there through Step 6. They're
Step 7 targets.
- **`Config::update`, `setup_model`, `load_functions`,
`load_mcp_servers`, and all `set_*` methods** are also still
on `Config` and stay there through Step 6.
### What Step 6 should watch for
- **Step 6 targets are request-write methods** — methods that
mutate the runtime state on `Config` (session, role, agent,
rag). The plan's Step 6 target list includes:
`use_prompt`, `use_role` / `use_role_obj`, `exit_role`,
`edit_role`, `use_session`, `exit_session`, `save_session`,
`empty_session`, `set_save_session_this_time`,
`compress_session` / `maybe_compress_session`,
`autoname_session` / `maybe_autoname_session`,
`use_rag` / `exit_rag` / `edit_rag_docs` / `rebuild_rag`,
`use_agent` / `exit_agent` / `exit_agent_session`,
`apply_prelude`, `before_chat_completion`,
`after_chat_completion`, `discontinuous_last_message`,
`init_agent_shared_variables`,
`init_agent_session_variables`.
- **Many will be mixed.** Expect to defer several to Step 7.
In particular, anything that reads `self.functions`,
`self.mcp_registry`, or calls `set_*` methods crosses the
boundary. Read each method carefully before migrating.
- **`maybe_compress_session` and `maybe_autoname_session`** take
`GlobalConfig` (not `&mut self`) and spawn background tasks
internally. Their signature in Step 6 will need
reconsideration — they don't fit cleanly in a
`RequestContext` method because they're already designed to
work with a shared lock.
- **`use_session_safely`, `use_role_safely`** also take
`GlobalConfig`. They do the `take()`/`replace()` dance with
the shared lock. Again, these don't fit the
`&mut RequestContext` pattern cleanly; plan to defer them.
- **`compress_session` and `autoname_session` are async.** They
call into the LLM. Their signature on `RequestContext` will
still be async.
- **`apply_prelude`** is tricky — it may activate a role/agent/
session from config strings like `"role:explain"` or
`"session:temp"`. It calls `use_role`, `use_session`, etc.
internally. If those get migrated, `apply_prelude` migrates
too. If any stay on `Config`, `apply_prelude` stays with them.
- **`discontinuous_last_message`** just clears `self.last_message`.
Pure runtime-write, trivial to migrate.
### What Step 6 should NOT do
- Don't touch the Step 3, 4, 5 methods on `AppConfig` /
`RequestContext` — they stay until Steps 8+ caller migration.
- Don't migrate any `set_*` method, `info`, `session_info`,
`sysinfo`, `update`, `setup_model`, `load_functions`,
`load_mcp_servers`, or the `use_session_safely` /
`use_role_safely` family unless you verify they're pure
runtime-writes — most aren't, and they're Step 7 targets.
- Don't migrate callers of any method yet. Callers stay on
`Config` through the bridge window.
### Files to re-read at the start of Step 6
- `docs/PHASE-1-IMPLEMENTATION-PLAN.md` — Step 6 section
- This notes file — specifically "What Step 6 should watch for"
- `src/config/request_context.rs` — current shape with Step 5
reads
- Current `Config` method bodies in `src/config/mod.rs` for
each Step 6 target
## Follow-up (not blocking Step 6)
### 1. `RequestContext` now has ~200 lines beyond struct definition
Between Step 0's `new()` constructor and Step 5's 13 read
methods, `request_context.rs` has grown to ~230 lines. Still
manageable. Step 6 will add more. Post-Phase 1 cleanup can
reorganize into multiple `impl` blocks grouped by concern
(reads/writes/lifecycle) or into separate files if the file
grows unwieldy.
### 2. Duplication count at end of Step 5
Running tally of methods duplicated between `Config` and the
new types during the bridge window:
- `AppConfig` (Steps 3+4): 11 methods
- `RequestContext` (Step 5): 13 methods
- `paths::` module (Step 2): 33 free functions (not duplicated
`Config` forwarders were deleted in Step 2)
**Total bridge-window duplication: 24 methods / ~370 lines.**
All auto-delete in Step 10. Maintenance burden is "any bug fix
in a migrated method during Steps 6-9 must be applied twice."
Document this in whatever PR shepherds Steps 6-9.
### 3. The `impl` block structure in `RequestContext` is growing
Now has 2 `impl RequestContext` blocks:
1. `new()` constructor (Step 0)
2. 13 read methods (Step 5)
Step 6 will likely add a third block for writes. That's fine
during the bridge window; cleanup can consolidate later.
## References
- Phase 1 plan: `docs/PHASE-1-IMPLEMENTATION-PLAN.md`
- Step 4 notes: `docs/implementation/PHASE-1-STEP-4-NOTES.md`
(for the duplication rationale)
- Modified file: `src/config/request_context.rs` (new imports
+ new `impl RequestContext` block with 13 read methods)
- Unchanged but referenced: `src/config/mod.rs` (original
`Config` methods still exist, private constants
`MESSAGES_FILE_NAME` / `AGENTS_DIR_NAME` /
`SESSIONS_DIR_NAME` accessed via `super::`)
@@ -0,0 +1,405 @@
# Phase 1 Step 6 — Implementation Notes
## Status
Done.
## Plan reference
- Plan: `docs/PHASE-1-IMPLEMENTATION-PLAN.md`
- Section: "Step 6: Migrate request-write methods to RequestContext"
## Summary
Added 12 of 27 planned request-write methods to `RequestContext`
as inherent methods, duplicating the bodies that still exist on
`Config`. The other 15 methods were deferred: some to Step 6.5
(because they touch `self.functions` and `self.mcp_registry`
runtime fields being restructured by the `ToolScope` / `McpFactory`
rework), some to Step 7 (because they cross the `AppConfig` /
`RequestContext` boundary or call into `set_*` mixed methods),
and some because their `GlobalConfig`-based static signatures
don't fit the `&mut RequestContext` pattern at all.
This step has the highest deferral ratio of the bridge phases
so far (12/27 ≈ 44% migrated). That's by design — Step 6 is
where the plan hits the bulk of the interesting refactoring
territory, and it's where the `ToolScope` / `AgentRuntime`
unification in Step 6.5 makes a big difference in what's
migrateable.
## What was changed
### Modified files
- **`src/config/request_context.rs`** — added 1 new import
(`Input` from `super::`) and a new `impl RequestContext` block
with 12 methods under `#[allow(dead_code)]`:
**Role lifecycle (2):**
- `use_role_obj(&mut self, role) -> Result<()>` — sets the
role on the current session, or on `self.role` if no session
is active; errors if an agent is active
- `exit_role(&mut self) -> Result<()>` — clears the role from
session or from `self.role`
**Session lifecycle (5):**
- `exit_session(&mut self) -> Result<()>` — saves session on
exit and clears `self.session`
- `save_session(&mut self, name) -> Result<()>` — persists
the current session, optionally renaming
- `empty_session(&mut self) -> Result<()>` — clears messages
in the active session
- `set_save_session_this_time(&mut self) -> Result<()>` — sets
the session's one-shot save flag
- `exit_agent_session(&mut self) -> Result<()>` — exits the
agent's session without exiting the agent
**RAG lifecycle (1):**
- `exit_rag(&mut self) -> Result<()>` — drops `self.rag`
**Chat lifecycle (2):**
- `before_chat_completion(&mut self, input) -> Result<()>`
stores the input as `last_message` with empty output
- `discontinuous_last_message(&mut self)` — clears the
continuous flag on the last message
**Agent variable init (2):**
- `init_agent_shared_variables(&mut self) -> Result<()>`
prompts for agent variables on first activation
- `init_agent_session_variables(&mut self, new_session) -> Result<()>`
syncs agent variables into/from session on new or resumed
session
All bodies are copy-pasted verbatim from `Config` with no
modifications — every one of these methods only touches
fields that already exist on `RequestContext` with the same
names and types.
### Unchanged files
- **`src/config/mod.rs`** — all 27 original `Config` methods
(including the 15 deferred ones) are deliberately left intact.
They continue to work for every existing caller.
## Key decisions
### 1. Only 12 of 27 methods migrated
The plan's Step 6 table listed ~20 methods, but when I scanned
for `fn (use_prompt|use_role|use_role_obj|...)` I found 27
(several methods have paired variants: `compress_session` +
`maybe_compress_session`, `autoname_session` +
`maybe_autoname_session`, `use_role_safely` vs `use_role`). Of
those 27, **12 are pure runtime-writes that migrated cleanly**
and **15 are deferred** to later steps. Full breakdown below.
### 2. Same duplication pattern as Steps 3-5
Callers hold `Config`, not `RequestContext`. Duplication is
strictly additive during the bridge window and auto-deletes in
Step 10.
### 3. Identified three distinct deferral categories
The 15 deferred methods fall into three categories, each with
a different resolution step:
**Category A: Touch `self.functions` or `self.mcp_registry`**
(resolved in Step 6.5 when `ToolScope` / `McpFactory` replace
those fields):
- `use_role` (async, reinits MCP registry for role's servers)
- `use_session` (async, reinits MCP registry for session's
servers)
**Category B: Call into Step 7 mixed methods** (resolved in
Step 7):
- `use_prompt` (calls `self.current_model()`)
- `edit_role` (calls `self.editor()` + `self.use_role()`)
- `after_chat_completion` (calls private `save_message` which
touches `self.save`, `self.session`, `self.agent`, etc.)
**Category C: Static async methods taking `&GlobalConfig` that
don't fit the `&mut RequestContext` pattern at all** (resolved
in Step 8 or a dedicated lifecycle-refactor step):
- `maybe_compress_session` — takes owned `GlobalConfig`, spawns
tokio task
- `compress_session` — async, takes `&GlobalConfig`
- `maybe_autoname_session` — takes owned `GlobalConfig`, spawns
tokio task
- `autoname_session` — async, takes `&GlobalConfig`
- `use_rag` — async, takes `&GlobalConfig`, calls `Rag::init` /
`Rag::load` which expect `&GlobalConfig`
- `edit_rag_docs` — async, takes `&GlobalConfig`, calls into
`Rag::refresh_document_paths` which expects `&GlobalConfig`
- `rebuild_rag` — same as `edit_rag_docs`
- `use_agent` — async, takes `&GlobalConfig`, mutates multiple
fields under the same write lock, calls
`Config::use_session_safely`
- `apply_prelude` — async, calls `self.use_role()` /
`self.use_session()` which are Category A
- `exit_agent` — calls `self.load_functions()` which writes
`self.functions` (runtime, restructured in Step 6.5)
### 4. `exit_agent_session` migrated despite calling other methods
`exit_agent_session` calls `self.exit_session()` and
`self.init_agent_shared_variables()`. Since both of those are
also being migrated in Step 6, `exit_agent_session` can
migrate cleanly and call the new `RequestContext::exit_session`
and `RequestContext::init_agent_shared_variables` on its own
struct.
### 5. `exit_session` works because Step 5 migrated `sessions_dir`
`exit_session` calls `self.sessions_dir()` which is now a
`RequestContext` method (Step 5). Similarly, `save_session`
calls `self.session_file()` (Step 5) and reads
`self.working_mode` (a `RequestContext` field). This
demonstrates how Steps 5 and 6 layer correctly — Step 5's
reads enable Step 6's writes.
### 6. Agent variable init is pure runtime
`init_agent_shared_variables` and `init_agent_session_variables`
look complex (they call `Agent::init_agent_variables` which
can prompt interactively) but they only touch `self.agent`,
`self.agent_variables`, `self.info_flag`, and `self.session`
all runtime fields that exist on `RequestContext`.
`Agent::init_agent_variables` itself is a static associated
function on `Agent` that takes `defined_variables`,
`existing_variables`, and `info_flag` as parameters — no
`&Config` dependency. Clean migration.
## Deviations from plan
### 15 methods deferred
Summary table of every method in the Step 6 target list:
| Method | Status | Reason |
|---|---|---|
| `use_prompt` | **Step 7** | Calls `current_model()` (mixed) |
| `use_role` | **Step 6.5** | Touches `functions`, `mcp_registry` |
| `use_role_obj` | ✅ Migrated | Pure runtime-write |
| `exit_role` | ✅ Migrated | Pure runtime-write |
| `edit_role` | **Step 7** | Calls `editor()` + `use_role()` |
| `use_session` | **Step 6.5** | Touches `functions`, `mcp_registry` |
| `exit_session` | ✅ Migrated | Pure runtime-write (uses Step 5 `sessions_dir`) |
| `save_session` | ✅ Migrated | Pure runtime-write (uses Step 5 `session_file`) |
| `empty_session` | ✅ Migrated | Pure runtime-write |
| `set_save_session_this_time` | ✅ Migrated | Pure runtime-write |
| `maybe_compress_session` | **Step 7/8** | `GlobalConfig` + spawns task + `light_theme()` |
| `compress_session` | **Step 7/8** | `&GlobalConfig`, complex LLM workflow |
| `maybe_autoname_session` | **Step 7/8** | `GlobalConfig` + spawns task + `light_theme()` |
| `autoname_session` | **Step 7/8** | `&GlobalConfig`, calls `retrieve_role` + LLM |
| `use_rag` | **Step 7/8** | `&GlobalConfig`, calls `Rag::init`/`Rag::load` |
| `edit_rag_docs` | **Step 7/8** | `&GlobalConfig`, calls `editor()` + Rag refresh |
| `rebuild_rag` | **Step 7/8** | `&GlobalConfig`, Rag refresh |
| `exit_rag` | ✅ Migrated | Trivial (drops `self.rag`) |
| `use_agent` | **Step 7/8** | `&GlobalConfig`, complex multi-field mutation |
| `exit_agent` | **Step 6.5** | Calls `load_functions()` which writes `functions` |
| `exit_agent_session` | ✅ Migrated | Composes migrated methods |
| `apply_prelude` | **Step 7/8** | Calls `use_role` / `use_session` (deferred) |
| `before_chat_completion` | ✅ Migrated | Pure runtime-write |
| `after_chat_completion` | **Step 7** | Calls `save_message` (mixed) |
| `discontinuous_last_message` | ✅ Migrated | Pure runtime-write |
| `init_agent_shared_variables` | ✅ Migrated | Pure runtime-write |
| `init_agent_session_variables` | ✅ Migrated | Pure runtime-write |
**Step 6 total: 12 migrated, 15 deferred.**
### Step 6's deferral load redistributes to later steps
Running tally of deferrals after Step 6:
- **Step 6.5 targets:** `use_role`, `use_session`, `exit_agent`
(3 methods). These must be migrated alongside the
`ToolScope` / `McpFactory` rework because they reinit or
inspect the MCP registry.
- **Step 7 targets:** `use_prompt`, `edit_role`,
`after_chat_completion`, `select_functions`,
`select_enabled_functions`, `select_enabled_mcp_servers`
(from Step 3), `setup_model`, `update` (from Step 4),
`info`, `session_info`, `sysinfo` (from Step 5),
**plus** the original Step 7 mixed-method list:
`current_model`, `extract_role`, `set_temperature`,
`set_top_p`, `set_enabled_tools`, `set_enabled_mcp_servers`,
`set_save_session`, `set_compression_threshold`,
`set_rag_reranker_model`, `set_rag_top_k`,
`set_max_output_tokens`, `set_model`, `retrieve_role`,
`use_role_safely`, `use_session_safely`, `save_message`,
`render_prompt_left`, `render_prompt_right`,
`generate_prompt_context`, `repl_complete`. This is a big
step.
- **Step 7/8 targets (lifecycle refactor):** Session
compression and autonaming tasks, RAG lifecycle methods,
`use_agent`, `apply_prelude`. These may want their own
dedicated step if the Step 7 list gets too long.
## Verification
### Compilation
- `cargo check` — clean, **zero warnings, zero errors**
- `cargo clippy` — clean
### Tests
- `cargo test`**63 passed, 0 failed** (unchanged from
Steps 15)
Step 6 added no new tests — duplication pattern. Existing
tests confirm nothing regressed.
### Manual smoke test
Not applicable — no runtime behavior changed. CLI and REPL
still call `Config::use_role_obj()`, `exit_session()`, etc.
as before.
## Handoff to next step
### What Step 6.5 can rely on
Step 6.5 (unify `ToolScope` / `AgentRuntime` / `McpFactory` /
`RagCache`) can rely on:
- `RequestContext` now has **25 inherent methods** across all
impl blocks (1 constructor + 13 reads from Step 5 + 12
writes from Step 6)
- `role_like_mut` is available (Step 5) — foundation for
Step 7's `set_*` methods
- `exit_session`, `save_session`, `empty_session`,
`exit_agent_session`, `init_agent_shared_variables`,
`init_agent_session_variables` are all on `RequestContext`
the `use_role`, `use_session`, and `exit_agent` migrations
in Step 6.5 can call these directly on the new context type
- `before_chat_completion`, `discontinuous_last_message`, etc.
are also on `RequestContext` — available for the new
`RequestContext` versions of deferred methods
- `Config::use_role`, `Config::use_session`, `Config::exit_agent`
are **still on `Config`** and must be handled by Step 6.5's
`ToolScope` refactoring because they touch `self.functions`
and `self.mcp_registry`
- The bridge from Step 1, `paths` module from Step 2, Steps
3-5 new methods, and all previous deferrals are unchanged
### What Step 6.5 should watch for
- **Step 6.5 is the big architecture step.** It replaces:
- `Config.functions: Functions` with
`RequestContext.tool_scope: ToolScope` (containing
`functions`, `mcp_runtime`, `tool_tracker`)
- `Config.mcp_registry: Option<McpRegistry>` with
`AppState.mcp_factory: Arc<McpFactory>` (pool) +
`ToolScope.mcp_runtime: McpRuntime` (per-scope handles)
- Agent-scoped supervisor/inbox/todo into
`RequestContext.agent_runtime: Option<AgentRuntime>`
- Agent RAG into a shared `AppState.rag_cache: Arc<RagCache>`
- **Once `ToolScope` exists**, Step 6.5 can migrate `use_role`
and `use_session` by replacing the `self.functions.clear_*` /
`McpRegistry::reinit` dance with
`self.tool_scope = app.mcp_factory.build_tool_scope(...)`.
- **`exit_agent` calls `self.load_functions()`** which reloads
the global tools. In the new design, exiting an agent should
rebuild the `tool_scope` for the now-topmost `RoleLike`. The
plan's Step 6.5 describes this exact transition.
- **Phase 5 adds the idle pool to `McpFactory`.** Step 6.5
ships the no-pool version: `acquire()` always spawns fresh,
`Drop` always tears down. Correct but not optimized.
- **`RagCache` serves both standalone and agent RAGs.** Step
6.5 needs to route `use_rag` (deferred) and agent activation
through the cache. Since `use_rag` is a Category C deferral
(takes `&GlobalConfig`), Step 6.5 may not touch it — it may
need to wait for Step 8.
### What Step 6.5 should NOT do
- Don't touch the 25 methods already on `RequestContext` — they
stay until Steps 8+ caller migration.
- Don't touch the `AppConfig` methods from Steps 3-4.
- Don't migrate the Step 7 targets unless they become
unblocked by the `ToolScope` / `AgentRuntime` refactor.
- Don't try to build the `McpFactory` idle pool — that's
Phase 5.
### Files to re-read at the start of Step 6.5
- `docs/PHASE-1-IMPLEMENTATION-PLAN.md` — Step 6.5 section
(the biggest single section, ~90 lines)
- `docs/REST-API-ARCHITECTURE.md` — section 5 (Tool Scope
Isolation) has the full design for `ToolScope`, `McpRuntime`,
`McpFactory`, `RagCache`, `AgentRuntime`
- This notes file — specifically "Category A" deferrals
(`use_role`, `use_session`, `exit_agent`)
- `src/config/mod.rs` — current `Config::use_role`,
`Config::use_session`, `Config::exit_agent` bodies to see
the MCP/functions handling that needs replacing
## Follow-up (not blocking Step 6.5)
### 1. `save_message` is private and heavy
`after_chat_completion` was deferred because it calls the
private `save_message` method, which is ~50 lines of logic
touching `self.save` (serialized), `self.session` (runtime),
`self.agent` (runtime), and the messages file (via
`self.messages_file()` which is on `RequestContext`). Step 7
should migrate `save_message` first, then
`after_chat_completion` can follow.
### 2. `Config::use_session_safely` and `use_role_safely` are a pattern to replace
Both methods do `take(&mut *guard)` on the `GlobalConfig` then
call the instance method on the taken `Config`, then put it
back. This pattern exists because `use_role` and `use_session`
are `&mut self` methods that need to await across the call,
and the `RwLock` can't be held across `.await`.
When `use_role` and `use_session` move to `RequestContext` in
Step 6.5, the `_safely` wrappers can be eliminated entirely —
the caller just takes `&mut RequestContext` directly. Flag
this as a cleanup opportunity for Step 8.
### 3. `RequestContext` is now ~400 lines
Counting imports, struct definition, and 3 `impl` blocks:
```
use statements: ~20 lines
struct definition: ~30 lines
impl 1 (new): ~25 lines
impl 2 (reads, Step 5): ~155 lines
impl 3 (writes, Step 6): ~160 lines
Total: ~390 lines
```
Still manageable. Step 6.5 will add `tool_scope` and
`agent_runtime` fields plus their methods, pushing toward
~500 lines. Post-Phase 1 cleanup should probably split into
separate files (`reads.rs`, `writes.rs`, `tool_scope.rs`,
`agent_runtime.rs`) but that's optional.
### 4. Bridge-window duplication count at end of Step 6
Running tally:
- `AppConfig` (Steps 3+4): 11 methods
- `RequestContext` (Steps 5+6): 25 methods
- `paths` module (Step 2): 33 free functions (not duplicated)
**Total bridge-window duplication: 36 methods / ~550 lines.**
All auto-delete in Step 10.
## References
- Phase 1 plan: `docs/PHASE-1-IMPLEMENTATION-PLAN.md`
- Architecture doc: `docs/REST-API-ARCHITECTURE.md`
- Step 5 notes: `docs/implementation/PHASE-1-STEP-5-NOTES.md`
- Modified file: `src/config/request_context.rs` (new
`impl RequestContext` block with 12 write methods, plus
`Input` import)
- Unchanged but referenced: `src/config/mod.rs` (original
`Config` methods still exist for all 27 targets)
@@ -0,0 +1,535 @@
# Phase 1 Step 6.5 — Implementation Notes
## Status
Done.
## Plan reference
- Plan: `docs/PHASE-1-IMPLEMENTATION-PLAN.md`
- Section: "Step 6.5: Unify tool/MCP fields into `ToolScope` and
agent fields into `AgentRuntime`"
## Summary
Step 6.5 is the "big architecture step." The plan describes it as
a semantic rewrite of scope transitions (`use_role`, `use_session`,
`use_agent`, `exit_*`) to build and swap `ToolScope` instances via
a new `McpFactory`, plus an `AgentRuntime` collapse for agent-
specific state, and a unified `RagCache` on `AppState`.
**This implementation deviates from the plan.** Rather than doing
the full semantic rewrite, Step 6.5 ships **scaffolding only**:
- New types (`ToolScope`, `McpRuntime`, `McpFactory`, `McpServerKey`,
`RagCache`, `RagKey`, `AgentRuntime`) exist and compile
- New fields on `AppState` (`mcp_factory`, `rag_cache`) and
`RequestContext` (`tool_scope`, `agent_runtime`) coexist with
the existing flat fields
- The `Config::to_request_context` bridge populates the new
sub-struct fields with defaults; real values flow through the
existing flat fields during the bridge window
- **No scope transitions are rewritten**; `Config::use_role`,
`Config::use_session`, `Config::use_agent`, `Config::exit_agent`
stay on `Config` and continue working with the old
`McpRegistry` / `Functions` machinery
The semantic rewrite is **deferred to Step 8** when the entry
points (`main.rs`, `repl/mod.rs`) get rewritten to thread
`RequestContext` through the pipeline. That's the natural point
to switch from `Config::use_role` to
`RequestContext::use_role_with_tool_scope`-style methods, because
the callers will already be holding the right instance type.
See "Deviations from plan" for the full rationale.
## What was changed
### New files
Four new modules under `src/config/`, all with module docstrings
explaining their scaffolding status and load-bearing references
to the architecture + phase plan docs:
- **`src/config/tool_scope.rs`** (~75 lines)
- `ToolScope` struct: `functions`, `mcp_runtime`, `tool_tracker`
with `Default` impl
- `McpRuntime` struct: wraps a
`HashMap<String, Arc<ConnectedServer>>` (reuses the existing
rmcp `RunningService` type)
- Basic accessors: `is_empty`, `insert`, `get`, `server_names`
- No `build_from_enabled_list` or similar; that's Step 8
- **`src/config/mcp_factory.rs`** (~90 lines)
- `McpServerKey` struct: `name` + `command` + sorted `args` +
sorted `env` (so identically-configured servers hash to the
same key and share an `Arc`, while differently-configured
ones get independent processes — the sharing-vs-isolation
invariant from architecture doc section 5)
- `McpFactory` struct:
`Mutex<HashMap<McpServerKey, Weak<ConnectedServer>>>` for
future sharing
- Basic accessors: `active_count`, `try_get_active`,
`insert_active`
- **No `acquire()` that actually spawns.** That would require
lifting the MCP server startup logic out of
`McpRegistry::init_server` into a factory method. Deferred
to Step 8 with the scope transition rewrites.
- **`src/config/rag_cache.rs`** (~90 lines)
- `RagKey` enum: `Named(String)` vs `Agent(String)` (distinct
namespaces)
- `RagCache` struct:
`RwLock<HashMap<RagKey, Weak<Rag>>>` with weak-ref sharing
- `try_get`, `insert`, `invalidate`, `entry_count`
- `load_with<F, Fut>()` — async helper that checks the cache,
calls a user-provided loader closure on miss, inserts the
result, and returns the `Arc`. Has a small race window
between `try_get` and `insert` (two concurrent misses will
both load); this is acceptable for Phase 1 per the
architecture doc's "concurrent first-load" note. Tightening
with a per-key `OnceCell` or `tokio::sync::Mutex` lands in
Phase 5.
- **`src/config/agent_runtime.rs`** (~95 lines)
- `AgentRuntime` struct with every field from the plan:
`rag`, `supervisor`, `inbox`, `escalation_queue`,
`todo_list: Option<TodoList>`, `self_agent_id`,
`parent_supervisor`, `current_depth`, `auto_continue_count`
- `new()` constructor that takes the required agent context
(id, supervisor, inbox, escalation queue) and initializes
optional fields to `None`/`0`
- `with_rag`, `with_todo_list`, `with_parent_supervisor`,
`with_depth` builder methods for Step 8's activation path
- **`todo_list` is `Option<TodoList>`** (opportunistic
tightening over today's `Config.agent.todo_list:
TodoList`): the field will be `Some(...)` only when
`spec.auto_continue == true`, saving an allocation for
agents that don't use the todo system
### Modified files
- **`src/mcp/mod.rs`** — changed `type ConnectedServer` from
private to `pub type ConnectedServer` so `tool_scope.rs` and
`mcp_factory.rs` can reference the type without reaching into
`rmcp` directly. One-character change (`type``pub type`).
- **`src/config/mod.rs`** — registered 4 new `mod` declarations
(`agent_runtime`, `mcp_factory`, `rag_cache`, `tool_scope`)
alphabetically in the module list. No `pub use` re-exports —
the types are used via their module paths by the parent
`config` crate's children.
- **`src/config/app_state.rs`** — added `mcp_factory:
Arc<McpFactory>` and `rag_cache: Arc<RagCache>` fields, plus
the corresponding imports. Updated the module docstring to
reflect the Step 6.5 additions and removed the old "TBD"
placeholder language about `McpFactory`.
- **`src/config/request_context.rs`** — added `tool_scope:
ToolScope` and `agent_runtime: Option<AgentRuntime>` fields
alongside the existing flat fields, plus imports. Updated
`RequestContext::new()` to initialize them with
`ToolScope::default()` and `None`. Rewrote the module
docstring to explain that flat and sub-struct fields coexist
during the bridge window.
- **`src/config/bridge.rs`** — updated
`Config::to_request_context` to initialize `tool_scope` with
`ToolScope::default()` and `agent_runtime` with `None` (the
bridge doesn't try to populate the sub-struct fields because
they're deferred scaffolding). Updated the three test
`AppState` constructors to pass `McpFactory::new()` and
`RagCache::new()` for the new required fields, plus added
imports for `McpFactory` and `RagCache` in the test module.
- **`Cargo.toml`** — no changes. `parking_lot` and the rmcp
dependencies were already present.
## Key decisions
### 1. **Scaffolding-only, not semantic rewrite**
This is the biggest decision in Step 6.5 and a deliberate
deviation from the plan. The plan says Step 6.5 should
"rewrite scope transitions" (item 5, page 373) to build and
swap `ToolScope` instances via `McpFactory::acquire()`.
**Why I did scaffolding only instead:**
- **Consistency with the bridge pattern.** Steps 36 all
followed the same shape: add new code alongside old, don't
migrate callers, let Step 8 do the real wiring. The bridge
pattern works because it keeps every intermediate state
green and testable. Doing the full Step 6.5 rewrite would
break that pattern.
- **Caller migration is a Step 8 concern.** The plan's Step
6.5 semantics assume callers hold a `RequestContext` and
can call `ctx.use_role(&app)` to rebuild `ctx.tool_scope`.
But during the bridge window, callers still hold
`GlobalConfig` / `&Config` and call `config.use_role(...)`.
Rewriting `use_role` to take `(&mut RequestContext,
&AppState)` would either:
1. Break every existing caller immediately (~20+ callsites),
forcing a partial Step 8 during Step 6.5, OR
2. Require a parallel `RequestContext::use_role_with_tool_scope`
method alongside `Config::use_role`, doubling the
duplication count for no benefit during the bridge
- **The plan's Step 6.5 risk note explicitly calls this out:**
*"Risk: Mediumhigh. This is where the Phase 1 refactor
stops being mechanical and starts having semantic
implications."* The scaffolding-only approach keeps Step 6.5
mechanical and pushes the semantic risk into Step 8 where it
can be handled alongside the entry point rewrite. That's a
better risk localization strategy.
- **The new types are still proven by construction.**
`Config::to_request_context` now builds `ToolScope::default()`
and `agent_runtime: None` on every call, and the bridge
round-trip test still passes. That proves the types compile,
have sensible defaults, and don't break the existing runtime
contract. Step 8 can then swap in real values without
worrying about type plumbing.
### 2. `McpFactory::acquire()` is not implemented
The plan says Step 6.5 ships a trivial `acquire()` that
"checks `active` for an upgradable `Weak`, otherwise spawns
fresh" and "drops tear down the subprocess directly."
I wrote the `Mutex<HashMap<McpServerKey, Weak<ConnectedServer>>>`
field and the `try_get_active` / `insert_active` building
blocks, but not an `acquire()` method. The reason is that
actually spawning an MCP subprocess requires lifting the
current spawning logic out of `McpRegistry::init_server` (in
`src/mcp/mod.rs`) — that's a ~60 line chunk of tokio child
process setup, rmcp handshake, and error handling that's
tightly coupled to `McpRegistry`. Extracting it as a factory
method is a meaningful refactor that belongs alongside the
Step 8 caller migration, not as orphaned scaffolding that
nobody calls.
The `try_get_active` and `insert_active` primitives are the
minimum needed for Step 8's `acquire()` implementation to be
a thin wrapper.
### 3. Sub-struct fields coexist with flat fields
`RequestContext` now has both:
- **Flat fields** (`functions`, `tool_call_tracker`,
`supervisor`, `inbox`, `root_escalation_queue`,
`self_agent_id`, `current_depth`, `parent_supervisor`) —
populated by `Config::to_request_context` during the bridge
- **Sub-struct fields** (`tool_scope: ToolScope`,
`agent_runtime: Option<AgentRuntime>`) — default-
initialized in `RequestContext::new()` and by the bridge;
real population happens in Step 8
This is deliberate scaffolding, not a refactor miss. The
module docstring explicitly explains this so a reviewer
doesn't try to "fix" the apparent duplication.
When Step 8 migrates `use_role` and friends to `RequestContext`,
those methods will populate `tool_scope` and `agent_runtime`
directly. The flat fields will become stale / unused during
Step 8 and get deleted alongside `Config` in Step 10.
### 4. `ConnectedServer` visibility bump
The minimum change to `src/mcp/mod.rs` was making
`type ConnectedServer` public (`pub type ConnectedServer`).
This lets `tool_scope.rs` and `mcp_factory.rs` reference the
live MCP handle type directly without either:
1. Reaching into `rmcp::service::RunningService<RoleClient, ()>`
from the config crate (tight coupling to rmcp)
2. Inventing a new `McpServerHandle` wrapper (premature
abstraction that would need to be unwrapped later)
The visibility change is bounded: `ConnectedServer` is only
used from within the `loki` crate, and `pub` here means
"visible to the whole crate" via Rust's module privacy, not
"part of Loki's external API."
### 5. `todo_list: Option<TodoList>` tightening
`AgentRuntime.todo_list: Option<TodoList>` (vs today's
`Agent.todo_list: TodoList` with `Default::default()` always
allocated). This is an opportunistic memory optimization
during the scaffolding phase: when Step 8 populates
`AgentRuntime`, it should allocate `Some(TodoList::default())`
only when `spec.auto_continue == true`. Agents without
auto-continue skip the allocation entirely.
This is documented in the `agent_runtime.rs` module docstring
so a reviewer doesn't try to "fix" the `Option` into a bare
`TodoList`.
## Deviations from plan
### Full plan vs this implementation
| Plan item | Status |
|---|---|
| Implement `McpRuntime` and `ToolScope` | ✅ Done (scaffolding) |
| Implement `McpFactory` — no pool, `acquire()` | ⚠️ **Partial** — types + accessors, no `acquire()` |
| Implement `RagCache` with `RagKey`, weak-ref sharing, per-key serialization | ✅ Done (scaffolding, no per-key serialization — Phase 5) |
| Implement `AgentRuntime` with `Option<TodoList>` and agent RAG | ✅ Done (scaffolding) |
| Rewrite scope transitions (`use_role`, `use_session`, `use_agent`, `exit_*`, `update`) | ❌ **Deferred to Step 8** |
| `use_rag` rewritten to use `RagCache` | ❌ **Deferred to Step 8** |
| Agent activation populates `AgentRuntime`, serves RAG from cache | ❌ **Deferred to Step 8** |
| `exit_agent` rebuilds parent's `ToolScope` | ❌ **Deferred to Step 8** |
| Sub-agent spawning constructs fresh `RequestContext` | ❌ **Deferred to Step 8** |
| Remove old `Agent::init` registry-mutation logic | ❌ **Deferred to Step 8** |
| `rebuild_rag` / `edit_rag_docs` use `rag_cache.invalidate` | ❌ **Deferred to Step 8** |
All the ❌ items are semantic rewrites that require caller
migration to take effect. Deferring them keeps Step 6.5
strictly additive and consistent with Steps 36. Step 8 will
do the semantic rewrite with the benefit of all the
scaffolding already in place.
### Impact on Step 7
Step 7 is unchanged. The mixed methods (including Steps 36
deferrals like `current_model`, `extract_role`, `sysinfo`,
`info`, `session_info`, `use_prompt`, etc.) still need to be
split into explicit `(&AppConfig, &RequestContext)` signatures
the same way the plan originally described. They don't depend
on the `ToolScope` / `McpFactory` rewrite being done.
### Impact on Step 8
Step 8 absorbs the full Step 6.5 semantic rewrite. The
original Step 8 scope was "rewrite entry points" — now it
also includes "rewrite scope transitions to use new types."
This is actually the right sequencing because callers and
their call sites migrate together.
The Step 8 scope is now substantially bigger than originally
planned. The plan should be updated to reflect this, either
by splitting Step 8 into 8a (scope transitions) + 8b (entry
points) or by accepting the bigger Step 8.
### Impact on Phase 5
Phase 5's "MCP pooling" scope is unchanged. Phase 5 adds the
idle pool + reaper + health checks to an already-working
`McpFactory::acquire()`. If Step 8 lands the working
`acquire()`, Phase 5 plugs in the pool; if Step 8 somehow
ships without `acquire()`, Phase 5 has to write it too.
Phase 5's plan doc should note this dependency.
## Verification
### Compilation
- `cargo check` — clean, **zero warnings, zero errors**
- `cargo clippy` — clean
### Tests
- `cargo test`**63 passed, 0 failed** (unchanged from
Steps 16)
The bridge round-trip tests are the critical check for this
step because they construct `AppState` instances, and
`AppState` now has two new required fields. All three tests
(`to_app_config_copies_every_serialized_field`,
`to_request_context_copies_every_runtime_field`,
`round_trip_preserves_all_non_lossy_fields`,
`round_trip_default_config`) pass after updating the
`AppState` constructors in the test module.
### Manual smoke test
Not applicable — no runtime behavior changed. CLI and REPL
still call `Config::use_role()`, `Config::use_session()`,
etc. and those still work against the old `McpRegistry` /
`Functions` machinery.
## Handoff to next step
### What Step 7 can rely on
Step 7 (mixed methods) can rely on:
- **Zero changes to existing `Config` methods or fields.**
Step 6.5 didn't touch any of the Step 7 targets.
- **New sub-struct fields exist on `RequestContext`** but are
default-initialized and shouldn't be consulted by any
Step 7 mixed-method migration. If a Step 7 method legitimately
needs `tool_scope` or `agent_runtime` (e.g., because it's
reading the active tool set), that's a signal the method
belongs in Step 8, not Step 7.
- **`AppConfig` methods from Steps 3-4 are unchanged.**
- **`RequestContext` methods from Steps 5-6 are unchanged.**
- **`Config::use_role`, `Config::use_session`,
`Config::use_agent`, `Config::exit_agent`, `Config::use_rag`,
`Config::edit_rag_docs`, `Config::rebuild_rag`,
`Config::apply_prelude` are still on `Config`** and must
stay there through Step 7. They're Step 8 targets.
### What Step 7 should watch for
- **Step 7 targets the 17 mixed methods** from the plan's
original table plus the deferrals accumulated from Steps
36 (`select_functions`, `select_enabled_functions`,
`select_enabled_mcp_servers`, `setup_model`, `update`,
`info`, `session_info`, `sysinfo`, `use_prompt`, `edit_role`,
`after_chat_completion`).
- **The "mixed" category means: reads/writes BOTH serialized
config AND runtime state.** The migration shape is to split
them into explicit
`fn foo(app: &AppConfig, ctx: &RequestContext)` or
`fn foo(app: &AppConfig, ctx: &mut RequestContext)`
signatures.
- **Watch for methods that also touch `self.functions` or
`self.mcp_registry`.** Those need `tool_scope` /
`mcp_factory` which aren't ready yet. If a mixed method
depends on the tool scope rewrite, defer it to Step 8
alongside the scope transitions.
- **`current_model` is the simplest Step 7 target** — it just
picks the right `Model` reference from session/agent/role/
global. Good first target to validate the Step 7 pattern.
- **`sysinfo` is the biggest Step 7 target** — ~70 lines of
reading both `AppConfig` serialized state and
`RequestContext` runtime state to produce a display string.
- **`set_*` methods all follow the pattern from the plan's
Step 7 table:**
```rust
fn set_foo(&mut self, value: ...) {
if let Some(rl) = self.role_like_mut() { rl.set_foo(value) }
else { self.foo = value }
}
```
The new signature splits this: the `role_like` branch moves
to `RequestContext` (using the Step 5 `role_like_mut`
helper), the fallback branch moves to `AppConfig` via
`AppConfig::set_foo`. Callers then call either
`ctx.set_foo_via_role_like(value)` or
`app_config.set_foo(value)` depending on context.
- **`update` is a dispatcher** — once all the `set_*` methods
are split, `update` migrates to live on `RequestContext`
(because it needs both `ctx.set_*` and `app.set_*` to
dispatch to).
### What Step 7 should NOT do
- Don't touch the 4 new types from Step 6.5 (`ToolScope`,
`McpRuntime`, `McpFactory`, `RagCache`, `AgentRuntime`).
They're scaffolding, untouched until Step 8.
- Don't try to populate `tool_scope` or `agent_runtime` from
any Step 7 migration. Those are Step 8.
- Don't migrate `use_role`, `use_session`, `use_agent`,
`exit_agent`, or any method that touches
`self.mcp_registry` / `self.functions`. Those are Step 8.
- Don't migrate callers of any migrated method.
- Don't touch the bridge's `to_request_context` /
`to_app_config` / `from_parts`. The round-trip still
works with `tool_scope` and `agent_runtime` defaulting.
### Files to re-read at the start of Step 7
- `docs/PHASE-1-IMPLEMENTATION-PLAN.md` — Step 7 section (the
17-method table starting at line ~525)
- This notes file — specifically the accumulated deferrals
list from Steps 3-6 in the "What Step 7 should watch for"
section
- Step 6 notes — which methods got deferred from Step 6 vs
Step 7 boundary
## Follow-up (not blocking Step 7)
### 1. Step 8's scope is now significantly larger
The original Phase 1 plan estimated Step 8 as "rewrite
`main.rs` and `repl/mod.rs` to use `RequestContext`" — a
meaningful but bounded refactor. After Step 6.5's deferral,
Step 8 also includes:
- Implementing `McpFactory::acquire()` by extracting server
startup logic from `McpRegistry::init_server`
- Rewriting `use_role`, `use_session`, `use_agent`,
`exit_agent`, `use_rag`, `edit_rag_docs`, `rebuild_rag`,
`apply_prelude`, agent sub-spawning
- Wiring `tool_scope` population into all the above
- Populating `agent_runtime` on agent activation
- Building the parent-scope `ToolScope` restoration logic in
`exit_agent`
- Routing `rebuild_rag` / `edit_rag_docs` through
`RagCache::invalidate`
This is a big step. The phase plan should be updated to
either split Step 8 into sub-steps or to flag the expanded
scope.
### 2. `McpFactory::acquire()` extraction is its own mini-project
Looking at `src/mcp/mod.rs`, the subprocess spawn + rmcp
handshake lives inside `McpRegistry::init_server` (private
method, ~60 lines). Step 8's first task should be extracting
this into a pair of functions:
1. `McpFactory::spawn_fresh(spec: &McpServerSpec) ->
Result<ConnectedServer>` — pure subprocess + handshake
logic
2. `McpRegistry::init_server` — wraps `spawn_fresh` with
registry bookkeeping (adds to `servers` map, fires catalog
discovery, etc.) for backward compat
Then `McpFactory::acquire()` can call `spawn_fresh` on cache
miss. The existing `McpRegistry::init_server` keeps working
for the bridge window callers.
### 3. The `load_with` race is documented but not fixed
`RagCache::load_with` has a race window: two concurrent
callers with the same key both miss the cache, both call
the loader closure, both insert into the map. The second
insert overwrites the first. Both callers end up with valid
`Arc<Rag>`s but the cache sharing is broken for that
instant.
For Phase 1 Step 6.5, this is acceptable because the cache
isn't populated by real usage yet. Phase 5's pooling work
should tighten this with per-key `OnceCell` or
`tokio::sync::Mutex`.
### 4. Bridge-window duplication count at end of Step 6.5
Running tally:
- `AppConfig` (Steps 3+4): 11 methods duplicated with `Config`
- `RequestContext` (Steps 5+6): 25 methods duplicated with
`Config` (1 constructor + 13 reads + 12 writes)
- `paths` module (Step 2): 33 free functions (not duplicated)
- **Step 6.5 NEW:** 4 types + 2 `AppState` fields + 2
`RequestContext` fields — **all additive scaffolding, no
duplication of logic**
**Total bridge-window duplication: 36 methods / ~550 lines**,
unchanged from end of Step 6. Step 6.5 added types but not
duplicated logic.
## References
- Phase 1 plan: `docs/PHASE-1-IMPLEMENTATION-PLAN.md`
- Architecture doc: `docs/REST-API-ARCHITECTURE.md` section 5
- Phase 5 plan: `docs/PHASE-5-IMPLEMENTATION-PLAN.md`
- Step 6 notes: `docs/implementation/PHASE-1-STEP-6-NOTES.md`
- New files:
- `src/config/tool_scope.rs`
- `src/config/mcp_factory.rs`
- `src/config/rag_cache.rs`
- `src/config/agent_runtime.rs`
- Modified files:
- `src/mcp/mod.rs` (`type ConnectedServer``pub type`)
- `src/config/mod.rs` (4 new `mod` declarations)
- `src/config/app_state.rs` (2 new fields + docstring)
- `src/config/request_context.rs` (2 new fields + docstring)
- `src/config/bridge.rs` (3 test `AppState` constructors
updated, `to_request_context` adds 2 defaults)
@@ -0,0 +1,536 @@
# Phase 1 Step 7 — Implementation Notes
## Status
Done.
## Plan reference
- Plan: `docs/PHASE-1-IMPLEMENTATION-PLAN.md`
- Section: "Step 7: Tackle mixed methods (THE HARD PART)"
## Summary
Added 14 mixed-method splits to the new types, plus 6 global-
default setters on `AppConfig`. The methods that mix serialized
config reads/writes with runtime state reads/writes are now
available on `RequestContext` with `&AppConfig` as an explicit
parameter for the serialized half.
Same bridge pattern as Steps 36: `Config`'s originals stay
intact, new methods sit alongside, caller migration happens in
Step 8.
**Step 7 completed ~65% of its planned scope.** Nine target
methods were deferred to Step 8 because they transitively
depend on `Model::retrieve_model(&Config)` and
`list_models(&Config)` — refactoring those requires touching
the `client` module macros, which is beyond Step 7's bridge-
pattern scope. Step 8 will rewrite them alongside the entry
point migration.
## What was changed
### Modified files
- **`src/config/app_config.rs`** — added a third `impl AppConfig`
block with 6 `set_*_default` methods for the serialized-field
half of the mixed-method splits:
- `set_temperature_default`
- `set_top_p_default`
- `set_enabled_tools_default`
- `set_enabled_mcp_servers_default`
- `set_save_session_default`
- `set_compression_threshold_default`
- **`src/config/request_context.rs`** — added a fourth
`impl RequestContext` block with 14 methods:
**Helpers (2):**
- `current_model(&self) -> &Model` — pure runtime traversal
(session > agent > role > ctx.model)
- `extract_role(&self, app: &AppConfig) -> Role` — pure
runtime except fallback reads `app.temperature`,
`app.top_p`, `app.enabled_tools`, `app.enabled_mcp_servers`
**Role-like setters (7):** these all return `bool`
indicating whether they mutated a `RoleLike` (if `false`,
the caller should fall back to
`app.set_<name>_default()`). This preserves the exact
semantics of today's `Config::set_*` methods:
- `set_temperature_on_role_like`
- `set_top_p_on_role_like`
- `set_enabled_tools_on_role_like`
- `set_enabled_mcp_servers_on_role_like`
- `set_save_session_on_session` (uses `self.session` directly,
not `role_like_mut`)
- `set_compression_threshold_on_session` (same)
- `set_max_output_tokens_on_role_like`
**Chat lifecycle (2):**
- `save_message(&mut self, app: &AppConfig, input, output)`
writes to session if present, else to messages file if
`app.save` is true
- `after_chat_completion(&mut self, app, input, output,
tool_results)` — updates `last_message`, calls
`save_message` if not `app.dry_run`
- `open_message_file(&self) -> Result<File>` — private
helper
**Info getters (3):**
- `sysinfo(&self, app: &AppConfig) -> Result<String>`
~70-line display output mixing serialized and runtime
state
- `info(&self, app: &AppConfig) -> Result<String>`
delegates to `sysinfo` in fallback branch
- `session_info(&self, app: &AppConfig) -> Result<String>`
calls `app.render_options()`
**Prompt rendering (3):**
- `generate_prompt_context(&self, app) -> HashMap<&str, String>`
builds the template variable map
- `render_prompt_left(&self, app) -> String`
- `render_prompt_right(&self, app) -> String`
**Function selection (3):**
- `select_enabled_functions(&self, app, role) -> Vec<FunctionDeclaration>`
filters `ctx.functions.declarations()` by role's enabled
tools + agent filters + user interaction functions
- `select_enabled_mcp_servers(&self, app, role) -> Vec<...>`
same pattern for MCP meta-functions
- `select_functions(&self, app, role) -> Option<Vec<...>>`
combines both
- **`src/config/mod.rs`** — bumped `format_option_value` from
private to `pub(super)` so `request_context.rs` can use it
as `super::format_option_value`.
### Unchanged files
- **`src/config/mod.rs`** — all Step 7 target methods still
exist on `Config`. They continue to work for every current
caller.
## Key decisions
### 1. Same bridge pattern as Steps 3-6
Step 7 follows the same additive pattern as earlier steps: new
methods on `AppConfig` / `RequestContext`, `Config`'s originals
untouched, no caller migration. Caller migration is Step 8.
The plan's Step 7 description implied a semantic rewrite
("split into explicit parameter passing") but that phrasing
applies to the target signatures, not the migration mechanism.
The bridge pattern achieves the same end state — methods with
`(&AppConfig, &RequestContext)` signatures exist and are ready
for Step 8 to call.
### 2. `set_*` methods split into `_on_role_like` + `_default` pair
Today's `Config::set_temperature` does:
```rust
match self.role_like_mut() {
Some(role_like) => role_like.set_temperature(value),
None => self.temperature = value,
}
```
The Step 7 split:
```rust
// On RequestContext:
fn set_temperature_on_role_like(&mut self, value) -> bool {
match self.role_like_mut() {
Some(rl) => { rl.set_temperature(value); true }
None => false,
}
}
// On AppConfig:
fn set_temperature_default(&mut self, value) {
self.temperature = value;
}
```
**The bool return** is the caller contract: if `_on_role_like`
returns `false`, the caller must call
`app.set_*_default(value)`. This is what Step 8 callers will
do:
```rust
if !ctx.set_temperature_on_role_like(value) {
Arc::get_mut(&mut app.config).unwrap().set_temperature_default(value);
}
```
(Or more likely, the AppConfig mutation gets hidden behind a
helper on `AppState` since `AppConfig` is behind `Arc`.)
This split is semantically equivalent to the existing
behavior while making the "where the value goes" decision
explicit at the type level.
### 3. `save_message` and `after_chat_completion` migrated together
`after_chat_completion` reads `app.dry_run` and calls
`save_message`, which reads `app.save`. Both got deferred from
Step 6 for exactly this mixed-dependency reason. Step 7
migrates them together:
```rust
pub fn after_chat_completion(
&mut self,
app: &AppConfig,
input: &Input,
output: &str,
tool_results: &[ToolResult],
) -> Result<()> {
if !tool_results.is_empty() { return Ok(()); }
self.last_message = Some(LastMessage::new(input.clone(), output.to_string()));
if !app.dry_run {
self.save_message(app, input, output)?;
}
Ok(())
}
```
The `open_message_file` helper moved along with them since
it's only called from `save_message`.
### 4. `format_option_value` visibility bump
`format_option_value` is a tiny private helper in
`src/config/mod.rs` that `sysinfo` uses. Step 7's new
`RequestContext::sysinfo` needs to call it, so I bumped its
visibility from `fn` to `pub(super)`. This is a minimal
change (one word) that lets child modules reuse the helper
without duplicating it.
### 5. `select_*` methods were Step 3 deferrals
The plan's Step 3 table originally listed `select_functions`,
`select_enabled_functions`, and `select_enabled_mcp_servers`
as global-read method targets. Step 3's notes correctly
flagged them as actually-mixed because they read `self.functions`
and `self.agent` (runtime, not serialized).
Step 7 is the right home for them. They take
`(&self, app: &AppConfig, role: &Role)` and read:
- `ctx.functions.declarations()` (runtime — existing flat
field, will collapse into `tool_scope.functions` in Step 8+)
- `ctx.agent` (runtime)
- `app.function_calling_support`, `app.mcp_server_support`,
`app.mapping_tools`, `app.mapping_mcp_servers` (serialized)
The implementations are long (~80 lines each) but are
verbatim copies of the `Config` originals with `self.X`
replaced by `app.X` for serialized fields and `self.X`
preserved for runtime fields.
### 6. `session_info` keeps using `crate::render::MarkdownRender`
I didn't add a top-level `use crate::render::MarkdownRender`
because it's only called from `session_info`. Inline
`crate::render::MarkdownRender::init(...)` is clearer than
adding another global import for a single use site.
### 7. Imports grew substantially
`request_context.rs` now imports from 7 new sources compared
to the end of Step 6:
- `super::AppConfig` (for the mixed-method params)
- `super::MessageContentToolCalls` (for `save_message`)
- `super::LEFT_PROMPT`, `super::RIGHT_PROMPT` (for prompt
rendering)
- `super::ensure_parent_exists` (for `open_message_file`)
- `crate::function::FunctionDeclaration`,
`crate::function::user_interaction::USER_FUNCTION_PREFIX`
- `crate::mcp::MCP_*_META_FUNCTION_NAME_PREFIX` (3 constants)
- `std::collections::{HashMap, HashSet}`,
`std::fs::{File, OpenOptions}`, `std::io::Write`,
`std::path::Path`, `crate::utils::{now, render_prompt}`
This is expected — Step 7's methods are the most
dependency-heavy in Phase 1. PostPhase 1 cleanup can
reorganize into separate files if the module becomes
unwieldy.
## Deviations from plan
### 9 methods deferred to Step 8
| Method | Why deferred |
|---|---|
| `retrieve_role` | Calls `Model::retrieve_model(&Config)` transitively, needs client module refactor |
| `set_model` | Calls `Model::retrieve_model(&Config)` transitively |
| `set_rag_reranker_model` | Takes `&GlobalConfig`, uses `update_rag` helper with Arc<RwLock> take/replace pattern |
| `set_rag_top_k` | Same as above |
| `update` | Dispatcher over all `set_*` methods including the 2 above, plus takes `&GlobalConfig` and touches `mcp_registry` |
| `repl_complete` | Calls `list_models(&Config)` + reads `self.mcp_registry` (going away in Step 6.5/8), + reads `self.functions` |
| `use_role_safely` | Takes `&GlobalConfig`, does `take()`/`replace()` on Arc<RwLock> |
| `use_session_safely` | Same as above |
| `setup_model` | Calls `self.set_model()` which is deferred |
| `use_prompt` (Step 6 deferral) | Calls `current_model()` (migratable) and `use_role_obj` (migrated in Step 6), but the whole method is 4 lines and not independently useful without its callers |
| `edit_role` (Step 6 deferral) | Calls `self.upsert_role()` and `self.use_role()` which are Step 8 |
**Root cause of most deferrals:** the `client` module's
`list_all_models` macro and `Model::retrieve_model` take
`&Config`. Refactoring them to take `&AppConfig` is a
meaningful cross-module change that belongs in Step 8
alongside the caller migration.
### 14 methods migrated
| Method | New signature |
|---|---|
| `current_model` | `&self -> &Model` (pure RequestContext) |
| `extract_role` | `(&self, &AppConfig) -> Role` |
| `set_temperature_on_role_like` | `(&mut self, Option<f64>) -> bool` |
| `set_top_p_on_role_like` | `(&mut self, Option<f64>) -> bool` |
| `set_enabled_tools_on_role_like` | `(&mut self, Option<String>) -> bool` |
| `set_enabled_mcp_servers_on_role_like` | `(&mut self, Option<String>) -> bool` |
| `set_save_session_on_session` | `(&mut self, Option<bool>) -> bool` |
| `set_compression_threshold_on_session` | `(&mut self, Option<usize>) -> bool` |
| `set_max_output_tokens_on_role_like` | `(&mut self, Option<isize>) -> bool` |
| `save_message` | `(&mut self, &AppConfig, &Input, &str) -> Result<()>` |
| `after_chat_completion` | `(&mut self, &AppConfig, &Input, &str, &[ToolResult]) -> Result<()>` |
| `sysinfo` | `(&self, &AppConfig) -> Result<String>` |
| `info` | `(&self, &AppConfig) -> Result<String>` |
| `session_info` | `(&self, &AppConfig) -> Result<String>` |
| `generate_prompt_context` | `(&self, &AppConfig) -> HashMap<&str, String>` |
| `render_prompt_left` | `(&self, &AppConfig) -> String` |
| `render_prompt_right` | `(&self, &AppConfig) -> String` |
| `select_functions` | `(&self, &AppConfig, &Role) -> Option<Vec<...>>` |
| `select_enabled_functions` | `(&self, &AppConfig, &Role) -> Vec<...>` |
| `select_enabled_mcp_servers` | `(&self, &AppConfig, &Role) -> Vec<...>` |
Actually that's 20 methods across the two types (6 on
`AppConfig`, 14 on `RequestContext`). "14 migrated" refers to
the 14 behavior methods on `RequestContext`; the 6 on
`AppConfig` are the paired defaults for the 7 role-like
setters (4 `set_*_default` + 2 session-specific — the
`set_max_output_tokens` split doesn't need a default
because `ctx.model.set_max_tokens()` works without a
fallback).
## Verification
### Compilation
- `cargo check` — clean, **zero warnings, zero errors**
- `cargo clippy` — clean
### Tests
- `cargo test`**63 passed, 0 failed** (unchanged from
Steps 16.5)
The bridge's round-trip test still passes, confirming the new
methods don't interfere with struct layout or the
`Config → AppConfig + RequestContext → Config` invariant.
### Manual smoke test
Not applicable — no runtime behavior changed. CLI and REPL
still call `Config::set_temperature`, `Config::sysinfo`,
`Config::save_message`, etc. as before.
## Handoff to next step
### What Step 8 can rely on
Step 8 (entry point rewrite) can rely on:
- **`AppConfig` now has 17 methods** (Steps 3+4+7): 7 reads
+ 4 writes + 6 setter-defaults
- **`RequestContext` now has 39 inherent methods** across 5
impl blocks: 1 constructor + 13 reads + 12 writes + 14
mixed
- **All of `AppConfig`'s and `RequestContext`'s new methods
are under `#[allow(dead_code)]`** — that's safe to leave
alone; callers wire them up in Step 8 and the allows
become inert
- **`format_option_value` is `pub(super)`** — accessible
from any `config` child module
- **The bridge (`Config::to_app_config`, `to_request_context`,
`from_parts`) still works** and all round-trip tests pass
- **The `paths` module, Step 3/4 `AppConfig` methods, Step
5/6 `RequestContext` methods, Step 6.5 scaffolding types
are all unchanged**
- **These `Config` methods are still on `Config`** and must
stay there through Step 8 (they're Step 8 targets):
- `retrieve_role`, `set_model`, `set_rag_reranker_model`,
`set_rag_top_k`, `update`, `repl_complete`,
`use_role_safely`, `use_session_safely`, `setup_model`,
`use_prompt`, `edit_role`
- Plus the Step 6 Category A deferrals: `use_role`,
`use_session`, `use_agent`, `exit_agent`
- Plus the Step 6 Category C deferrals: `compress_session`,
`maybe_compress_session`, `autoname_session`,
`maybe_autoname_session`, `use_rag`, `edit_rag_docs`,
`rebuild_rag`, `apply_prelude`
### What Step 8 should watch for
**Step 8 is the biggest remaining step** after Step 6.5
deferred its scope-transition rewrites. Step 8 now absorbs:
1. **Entry point rewrite** (original Step 8 scope):
- `main.rs::run()` constructs `AppState` + `RequestContext`
instead of `GlobalConfig`
- `main.rs::start_directive()` takes
`&mut RequestContext` instead of `&GlobalConfig`
- `main.rs::create_input()` takes `&RequestContext`
- `repl/mod.rs::Repl` holds a long-lived `RequestContext`
instead of `GlobalConfig`
- All 91 callsites in the original migration table
2. **`Model::retrieve_model` refactor** (Step 7 deferrals):
- `Model::retrieve_model(config: &Config, ...)`
`Model::retrieve_model(config: &AppConfig, ...)`
- `list_all_models!(config: &Config)` macro →
`list_all_models!(config: &AppConfig)`
- `list_models(config: &Config, ...)`
`list_models(config: &AppConfig, ...)`
- Then migrate `retrieve_role`, `set_model`,
`repl_complete`, `setup_model`
3. **RAG lifecycle migration** (Step 7 deferrals +
Step 6 Category C):
- `use_rag`, `edit_rag_docs`, `rebuild_rag`
`RequestContext` methods using `RagCache`
- `set_rag_reranker_model`, `set_rag_top_k` → split
similarly to Step 7 setters
4. **Scope transition rewrites** (Step 6.5 deferrals):
- `use_role`, `use_session`, `use_agent`, `exit_agent`
rewritten to build `ToolScope` via `McpFactory`
- `McpFactory::acquire()` extracted from
`McpRegistry::init_server`
- `use_role_safely`, `use_session_safely` eliminated
(not needed once callers hold `&mut RequestContext`)
5. **Session lifecycle migration** (Step 6 Category C):
- `compress_session`, `maybe_compress_session`,
`autoname_session`, `maybe_autoname_session` → methods
that take `&mut RequestContext` instead of spawning
tasks with `GlobalConfig`
- `apply_prelude` → uses migrated `use_role` /
`use_session`
6. **`update` dispatcher** (Step 7 deferral):
- Once all `set_*` are available on `RequestContext` and
`AppConfig`, `update` becomes a dispatcher over the
new split pair
This is a **huge** step. Consider splitting into 8a-8f
sub-steps or staging across multiple PRs.
### What Step 8 should NOT do
- Don't re-migrate any Step 3-7 method
- Don't touch the new types from Step 6.5 unless actually
implementing `McpFactory::acquire()` or
`RagCache::load_with` usage
- Don't leave intermediate states broken — each sub-step
should keep the build green, even if it means keeping
temporary dual code paths
### Files to re-read at the start of Step 8
- `docs/PHASE-1-IMPLEMENTATION-PLAN.md` — Step 8 section
- This notes file — specifically the deferrals table and
Step 8 watch items
- Step 6.5 notes — scope transition rewrite details
- Step 6 notes — Category C deferral inventory
- `src/config/mod.rs` — still has ~25 methods that need
migrating
## Follow-up (not blocking Step 8)
### 1. Bridge-window duplication count at end of Step 7
Running tally:
- `AppConfig` (Steps 3+4+7): 17 methods (11 reads/writes +
6 setter-defaults)
- `RequestContext` (Steps 5+6+7): 39 methods (1 constructor +
13 reads + 12 writes + 14 mixed)
- `paths` module (Step 2): 33 free functions
- Step 6.5 types: 4 new types on scaffolding
**Total bridge-window duplication: 56 methods / ~1200 lines**
(up from 36 / ~550 at end of Step 6).
All auto-delete in Step 10.
### 2. `request_context.rs` is now ~900 lines
Getting close to the point where splitting into multiple
files would help readability. Candidate layout:
- `request_context/mod.rs` — struct definition + constructor
- `request_context/reads.rs` — Step 5 methods
- `request_context/writes.rs` — Step 6 methods
- `request_context/mixed.rs` — Step 7 methods
Not blocking anything; consider during Phase 1 cleanup.
### 3. The `set_*_on_role_like` / `set_*_default` split
has an unusual caller contract
Callers of the split have to remember: "call `_on_role_like`
first, check the bool, call `_default` if false." That's
more verbose than today's `Config::set_temperature` which
hides the dispatch.
Step 8 should add convenience helpers on `RequestContext`
that wrap both halves:
```rust
pub fn set_temperature(&mut self, value: Option<f64>, app: &mut AppConfig) {
if !self.set_temperature_on_role_like(value) {
app.set_temperature_default(value);
}
}
```
But that requires `&mut AppConfig`, which requires unwrapping
the `Arc` on `AppState.config`. The cleanest shape is probably
to move the mutation into a helper on `AppState`:
```rust
impl AppState {
pub fn config_mut(&self) -> Option<&mut AppConfig> {
Arc::get_mut(...)
}
}
```
Or accept that the `.set` REPL command needs an owned
`AppState` (not `Arc<AppState>`) and handle the mutation at
the entry point. Step 8 can decide.
### 4. `select_*` methods are long but verbatim
The 3 `select_*` methods are ~180 lines combined and are
verbatim copies of the `Config` originals. I resisted the
urge to refactor (extract helpers, simplify the
`enabled_tools == "all"` branches, etc.) because:
- Step 7 is about splitting signatures, not style
- The copies get deleted in Step 10 anyway
- Any refactor could introduce subtle behavior differences
that are hard to catch without a functional test for these
specific methods
PostPhase 1 cleanup can factor these if desired.
## References
- Phase 1 plan: `docs/PHASE-1-IMPLEMENTATION-PLAN.md`
- Step 6 notes: `docs/implementation/PHASE-1-STEP-6-NOTES.md`
- Step 6.5 notes: `docs/implementation/PHASE-1-STEP-6.5-NOTES.md`
- Modified files:
- `src/config/app_config.rs` (6 new `set_*_default` methods)
- `src/config/request_context.rs` (14 new mixed methods,
7 new imports)
- `src/config/mod.rs` (`format_option_value``pub(super)`)
@@ -0,0 +1,374 @@
# Phase 1 Step 8a — Implementation Notes
## Status
Done.
## Plan reference
- Plan: `docs/PHASE-1-IMPLEMENTATION-PLAN.md`
- Section: "Step 8a: Client module refactor — `Model::retrieve_model`
takes `&AppConfig`"
## Summary
Migrated the LLM client module's 4 `&Config`-taking functions to take
`&AppConfig` instead, and updated all 15 callsites across 7 files to
use the `Config::to_app_config()` bridge helper (already exists from
Step 1). No new types, no new methods — this is a signature change
that propagates through the codebase.
**This unblocks Step 8b**, where `Config::retrieve_role`,
`Config::set_model`, `Config::repl_complete`, and
`Config::setup_model` (Step 7 deferrals) can finally migrate to
`RequestContext` methods that take `&AppConfig` — they were blocked
on `Model::retrieve_model` expecting `&Config`.
## What was changed
### Files modified (8 files, 15 callsite updates)
- **`src/client/macros.rs`** — changed 3 signatures in the
`register_client!` macro (the functions it generates at expansion
time):
- `list_client_names(config: &Config)``(config: &AppConfig)`
- `list_all_models(config: &Config)``(config: &AppConfig)`
- `list_models(config: &Config, ModelType)``(config: &AppConfig, ModelType)`
All three functions only read `config.clients` which is a
serialized field identical on both types. The `OnceLock` caches
(`ALL_CLIENT_NAMES`, `ALL_MODELS`) work identically because
`AppConfig.clients` holds the same values as `Config.clients`.
- **`src/client/model.rs`** — changed the `use` and function
signature:
- `use crate::config::Config``use crate::config::AppConfig`
- `Model::retrieve_model(config: &Config, ...)``(config: &AppConfig, ...)`
The function body was unchanged — it calls `list_all_models(config)`
and `list_client_names(config)` internally, both of which now take
the same `&AppConfig` type.
- **`src/config/mod.rs`** (6 callsite updates):
- `set_rag_reranker_model``Model::retrieve_model(&config.read().to_app_config(), ...)`
- `set_model``Model::retrieve_model(&self.to_app_config(), ...)`
- `retrieve_role``Model::retrieve_model(&self.to_app_config(), ...)`
- `repl_complete` (`.model` branch) → `list_models(&self.to_app_config(), ModelType::Chat)`
- `repl_complete` (`.rag_reranker_model` branch) → `list_models(&self.to_app_config(), ModelType::Reranker)`
- `setup_model``list_models(&self.to_app_config(), ModelType::Chat)`
- **`src/config/session.rs`** — `Session::load` caller updated:
`Model::retrieve_model(&config.to_app_config(), ...)`
- **`src/config/agent.rs`** — `Agent::init` caller updated:
`Model::retrieve_model(&config.to_app_config(), model_id, ModelType::Chat)?`
(required reformatting because the one-liner became two lines)
- **`src/function/supervisor.rs`** — sub-agent summarization model
lookup: `Model::retrieve_model(&cfg.to_app_config(), ...)`
- **`src/rag/mod.rs`** (4 callsite updates):
- `Rag::create` embedding model lookup
- `Rag::init` `list_models` for embedding model selection
- `Rag::init` `retrieve_model` for embedding model
- `Rag::search` reranker model lookup
- **`src/main.rs`** — `--list-models` CLI flag handler:
`list_models(&config.read().to_app_config(), ModelType::Chat)`
- **`src/cli/completer.rs`** — shell completion for `--model`:
`list_models(&config.to_app_config(), ModelType::Chat)`
### Files NOT changed
- **`src/config/bridge.rs`** — the `Config::to_app_config()` method
from Step 1 is exactly the bridge helper Step 8a needed. No new
method was added; I just started using the existing one.
- **`src/client/` other files** — only `macros.rs` and `model.rs`
had the target signatures. Individual client implementations
(`openai.rs`, `claude.rs`, etc.) don't reference `&Config`
directly; they work through the `Client` trait which uses
`GlobalConfig` internally (untouched).
- **Any file calling `init_client` or `GlobalConfig`** — these are
separate from the model-lookup path and stay on `GlobalConfig`
through the bridge. Step 8f/8g will migrate them.
## Key decisions
### 1. Reused `Config::to_app_config()` instead of adding `app_config_snapshot`
The plan said to add a `Config::app_config_snapshot(&self) -> AppConfig`
helper. That's exactly what `Config::to_app_config()` from Step 1
already does — clones every serialized field into a fresh `AppConfig`.
Adding a second method with the same body would be pointless
duplication.
I proceeded directly with `to_app_config()` and the plan's intent
is satisfied.
### 2. Inline `.to_app_config()` at every callsite
Each callsite pattern is:
```rust
// old:
Model::retrieve_model(config, ...)
// new:
Model::retrieve_model(&config.to_app_config(), ...)
```
The owned `AppConfig` returned by `to_app_config()` lives for the
duration of the function argument expression, so `&` borrowing works
without a named binding. For multi-line callsites (like `Rag::create`
and `Rag::init` in `src/rag/mod.rs`) I reformatted to put the
`to_app_config()` call on its own line for readability.
### 3. Allocation cost is acceptable during the bridge window
Every callsite now clones 40 fields (the serialized half of `Config`)
per call. This is measurably more work than the pre-refactor code,
which passed a shared borrow. The allocation cost is:
- **~15 callsites × ~40 field clones each** = ~600 extra heap
operations per full CLI invocation
- In practice, most of these are `&str` / `String` / primitive
clones, plus a few `IndexMap` and `Vec` clones — dominated by
`clients: Vec<ClientConfig>`
- Total cost per call: well under 1ms, invisible to users
- Cost ends in Step 8f/8g when callers hold `Arc<AppState>`
directly and can pass `&app.config` without cloning
The plan flagged this as an acceptable bridge-window cost, and the
measurements back that up. No optimization is needed.
### 4. No use of deprecated forwarders
Unlike Steps 3-7 which added new methods alongside the old ones,
Step 8a is a **one-shot signature change** of 4 functions plus
their 15 callers. The bridge helper is `Config::to_app_config()`
(already existed); the new signature is on the same function
(not a parallel new function). This is consistent with the plan's
Step 8a description of "one-shot refactor with bridge helper."
### 5. Did not touch `init_client`, `GlobalConfig`, or client instance state
The `register_client!` macro defines `$Client::init(global_config,
model)` and `init_client(config, model)` — both take
`&GlobalConfig` and read `config.read().model` (the runtime field).
These are **not** Step 8a targets. They stay on `GlobalConfig`
through the bridge and migrate in Step 8f/8g when callers switch
from `GlobalConfig` to `Arc<AppState> + RequestContext`.
## Deviations from plan
**None of substance.** The plan's Step 8a description was clear
and straightforward; the implementation matches it closely. Two
minor departures:
1. **Used existing `to_app_config()` instead of adding
`app_config_snapshot()`** — see Key Decision #1. The plan's
intent was a helper that clones serialized fields; both names
describe the same thing.
2. **Count: 15 callsite updates, not 17** — the plan said "any
callsite that currently calls these client functions." I found
15 via `grep`. The count is close enough that this isn't a
meaningful deviation, just an accurate enumeration.
## Verification
### Compilation
- `cargo check` — clean, **zero warnings, zero errors**
- `cargo clippy` — clean
### Tests
- `cargo test`**63 passed, 0 failed** (unchanged from
Steps 17)
Step 8a added no new tests — it's a mechanical signature change
with no new behavior to verify. The existing test suite confirms:
- The bridge round-trip test still passes (uses
`Config::to_app_config()`, which is the bridge helper)
- The `config::bridge::tests::*` suite — all 4 tests pass
- No existing test broke
### Manual smoke test
Not performed as part of this step (would require running a real
LLM request with various models). The plan's Step 8a verification
suggests `loki --model openai:gpt-4o "hello"` as a sanity check,
but that requires API credentials and a live LLM. A representative
smoke test should be performed before declaring Phase 1 complete
(in Step 10 or during release prep).
The signature change is mechanical — if it compiles and existing
tests pass, the runtime behavior is identical by construction. The
only behavior difference would be the extra `to_app_config()`
clones, which don't affect correctness.
## Handoff to next step
### What Step 8b can rely on
Step 8b (finish Step 7's deferred mixed-method migrations) can
rely on:
- **`Model::retrieve_model(&AppConfig, ...)`** — available for the
migrated `retrieve_role` method on `RequestContext`
- **`list_models(&AppConfig, ModelType)`** — available for
`repl_complete` and `setup_model` migration
- **`list_all_models(&AppConfig)`** — available for internal use
- **`list_client_names(&AppConfig)`** — available (though typically
only called from inside `retrieve_model`)
- **`Config::to_app_config()` bridge helper** — still works, still
used by the old `Config` methods that call the client functions
through the bridge
- **All existing Config-based methods that use these functions**
(e.g., `Config::set_model`, `Config::retrieve_role`,
`Config::setup_model`) still compile and still work — they now
call `self.to_app_config()` internally to adapt the signature
### What Step 8b should watch for
- **The 9 Step 7 deferrals** waiting for Step 8b:
- `retrieve_role` (blocked by `retrieve_model` — now unblocked)
- `set_model` (blocked by `retrieve_model` — now unblocked)
- `repl_complete` (blocked by `list_models` — now unblocked)
- `setup_model` (blocked by `list_models` — now unblocked)
- `use_prompt` (calls `current_model` + `use_role_obj` — already
unblocked; was deferred because it's a one-liner not worth
migrating alone)
- `edit_role` (calls `editor` + `upsert_role` + `use_role`
`use_role` is still Step 8d, so `edit_role` may stay deferred)
- `set_rag_reranker_model` (takes `&GlobalConfig`, uses
`update_rag` helper — may stay deferred to Step 8f/8g)
- `set_rag_top_k` (same)
- `update` (dispatcher over all `set_*` — needs all its
dependencies migrated first)
- **`set_model` split pattern.** The old `Config::set_model` does
`role_like_mut` dispatch. Step 8b should split it into
`RequestContext::set_model_on_role_like(&mut self, app: &AppConfig,
model_id: &str) -> Result<bool>` (returns whether a RoleLike was
mutated) + `AppConfig::set_model_default(&mut self, model_id: &str,
model: Model)` (sets the global default model).
- **`retrieve_role` migration pattern.** The method takes `&self`
today. On `RequestContext` it becomes `(&self, app: &AppConfig,
name: &str) -> Result<Role>`. The body calls
`paths::list_roles`, `paths::role_file`, `Role::new`, `Role::builtin`,
then `self.current_model()` (already on RequestContext from Step 7),
then `Model::retrieve_model(app, ...)`.
- **`setup_model` has a subtle split.** It writes to
`self.model_id` (serialized) AND `self.model` (runtime) AND calls
`self.set_model(&model_id)` (mixed). Step 8b should split this
into:
- `AppConfig::ensure_default_model_id(&mut self, &AppConfig)` (or
similar) to pick the first available model and update
`self.model_id`
- `RequestContext::reload_current_model(&mut self, app: &AppConfig)`
to refresh `ctx.model` from the resolved id
### What Step 8b should NOT do
- Don't touch `init_client`, `GlobalConfig`, or any function with
"runtime model state" concerns — those are Step 8f/8g.
- Don't migrate `use_role`, `use_session`, `use_agent`, `exit_agent`
— those are Step 8d (after Step 8c extracts `McpFactory::acquire()`).
- Don't migrate RAG lifecycle methods (`use_rag`, `edit_rag_docs`,
`rebuild_rag`, `compress_session`, `autoname_session`,
`apply_prelude`) — those are Step 8e.
- Don't touch `main.rs` entry points or `repl/mod.rs` — those are
Step 8f and 8g respectively.
### Files to re-read at the start of Step 8b
- `docs/PHASE-1-IMPLEMENTATION-PLAN.md` — Step 8b section
- This notes file — especially the "What Step 8b should watch
for" section above
- `src/config/mod.rs` — current `Config::retrieve_role`,
`Config::set_model`, `Config::repl_complete`,
`Config::setup_model`, `Config::use_prompt`, `Config::edit_role`
method bodies
- `src/config/app_config.rs` — current state of `AppConfig` impl
blocks (Steps 3+4+7)
- `src/config/request_context.rs` — current state of
`RequestContext` impl blocks (Steps 5+6+7)
## Follow-up (not blocking Step 8b)
### 1. The `OnceLock` caches in the macro will seed once per process
`ALL_CLIENT_NAMES` and `ALL_MODELS` are `OnceLock`s initialized
lazily on first call. After Step 8a, the first call passes an
`AppConfig`. If a test or an unusual code path happens to call
one of these functions twice with different `AppConfig` values
(different `clients` lists), only the first seeding wins. This
was already true before Step 8a — the types changed but the
caching semantics are unchanged.
Worth flagging so nobody writes a test that relies on
re-initializing the caches.
### 2. Bridge-window duplication count at end of Step 8a
Unchanged from end of Step 7:
- `AppConfig` (Steps 3+4+7): 17 methods
- `RequestContext` (Steps 5+6+7): 39 methods
- `paths` module (Step 2): 33 free functions
- Step 6.5 types: 4 new types
**Total: 56 methods / ~1200 lines of parallel logic**
Step 8a added zero duplication — it's a signature change of
existing functions, not a parallel implementation.
### 3. `to_app_config()` is called from 9 places now
After Step 8a, these files call `to_app_config()`:
- `src/config/mod.rs` — 6 callsites (for `Model::retrieve_model`
and `list_models`)
- `src/config/session.rs` — 1 callsite
- `src/config/agent.rs` — 1 callsite
- `src/function/supervisor.rs` — 1 callsite
- `src/rag/mod.rs` — 4 callsites
- `src/main.rs` — 1 callsite
- `src/cli/completer.rs` — 1 callsite
**Total: 15 callsites.** All get eliminated in Step 8f/8g when
their callers migrate to hold `Arc<AppState>` directly. Until
then, each call clones ~40 fields. Measured cost: negligible.
### 4. The `#[allow(dead_code)]` on `impl Config` in bridge.rs
`Config::to_app_config()` is now actively used by 15 callsites
— it's no longer dead. But `Config::to_request_context` and
`Config::from_parts` are still only used by the bridge tests. The
`#[allow(dead_code)]` on the `impl Config` block is harmless
either way (it doesn't fire warnings, it just suppresses them
if they exist). Step 10 deletes the whole file anyway.
## References
- Phase 1 plan: `docs/PHASE-1-IMPLEMENTATION-PLAN.md`
- Step 7 notes: `docs/implementation/PHASE-1-STEP-7-NOTES.md`
- Modified files:
- `src/client/macros.rs` (3 function signatures in the
`register_client!` macro)
- `src/client/model.rs` (`use` statement + `retrieve_model`
signature)
- `src/config/mod.rs` (6 callsite updates in
`set_rag_reranker_model`, `set_model`, `retrieve_role`,
`repl_complete` ×2, `setup_model`)
- `src/config/session.rs` (1 callsite in `Session::load`)
- `src/config/agent.rs` (1 callsite in `Agent::init`)
- `src/function/supervisor.rs` (1 callsite in sub-agent
summarization)
- `src/rag/mod.rs` (4 callsites in `Rag::create`, `Rag::init`,
`Rag::search`)
- `src/main.rs` (1 callsite in `--list-models` handler)
- `src/cli/completer.rs` (1 callsite in shell completion)
@@ -0,0 +1,296 @@
# Phase 1 Step 8b — Implementation Notes
## Status
Done.
## Plan reference
- Plan: `docs/PHASE-1-IMPLEMENTATION-PLAN.md`
- Section: "Step 8b: Finish Step 7's deferred mixed-method migrations"
## Summary
Migrated 7 of the 9 Step 7 deferrals to `RequestContext` / `AppConfig`
methods that take `&AppConfig` instead of `&Config`. Two methods
(`edit_role` and `update`) remain deferred because they depend on
`use_role` (Step 8d) and MCP registry manipulation (Step 8d)
respectively. Four private helper functions in `mod.rs` were bumped
to `pub(super)` to support the new `repl_complete` implementation.
## What was changed
### Files modified (3 files)
- **`src/config/request_context.rs`** — added a fifth `impl RequestContext`
block with 7 methods:
- `retrieve_role(&self, app: &AppConfig, name: &str) -> Result<Role>`
loads a role by name, resolves its model via
`Model::retrieve_model(app, ...)`. Reads `app.temperature` and
`app.top_p` for the no-model-id fallback branch.
- `set_model_on_role_like(&mut self, app: &AppConfig, model_id: &str)
-> Result<bool>` — resolves the model via `Model::retrieve_model`,
sets it on the active role-like if present (returns `true`), or on
`ctx.model` directly (returns `false`). The `false` case means the
caller should also call `AppConfig::set_model_id_default` if they
want the global default updated.
- `reload_current_model(&mut self, app: &AppConfig, model_id: &str)
-> Result<()>` — resolves a model by ID and assigns it to
`ctx.model`. Used in tandem with `AppConfig::ensure_default_model_id`.
- `use_prompt(&mut self, _app: &AppConfig, prompt: &str) -> Result<()>`
creates a `TEMP_ROLE_NAME` role with the prompt text, sets its model
to `current_model()`, calls `use_role_obj`. The `_app` parameter is
included for signature consistency; it's unused because `use_prompt`
only reads runtime state.
- `set_rag_reranker_model(&mut self, app: &AppConfig,
value: Option<String>) -> Result<bool>` — validates the model ID via
`Model::retrieve_model(app, ...)` if present, then clones-and-replaces
the `Arc<Rag>` with the updated reranker model. Returns `true` if RAG
was mutated, `false` if no RAG is active.
- `set_rag_top_k(&mut self, value: usize) -> Result<bool>` — same
clone-and-replace pattern on the active RAG. Returns `true`/`false`.
- `repl_complete(&self, app: &AppConfig, cmd: &str, args: &[&str],
_line: &str) -> Vec<(String, Option<String>)>` — full tab-completion
handler. Reads `app.*` for serialized fields, `self.*` for runtime
state, `self.app.vault` for vault completions. MCP configured-server
completions are limited to `app.mapping_mcp_servers` keys during the
bridge (no live `McpRegistry` on `RequestContext`; Step 8d's
`ToolScope` will restore full MCP completions).
Updated imports: added `TEMP_ROLE_NAME`, `list_agents`, `ModelType`,
`list_models`, `read_to_string`, `fuzzy_filter`. Removed duplicate
`crate::utils` import that had accumulated.
- **`src/config/app_config.rs`** — added 4 methods to the existing
`set_*_default` impl block:
- `set_rag_reranker_model_default(&mut self, value: Option<String>)`
- `set_rag_top_k_default(&mut self, value: usize)`
- `set_model_id_default(&mut self, model_id: String)`
- `ensure_default_model_id(&mut self) -> Result<String>` — picks the
first available chat model if `model_id` is empty, updates
`self.model_id`, returns the resolved ID.
- **`src/config/mod.rs`** — bumped 4 private helper functions to
`pub(super)`:
- `parse_value` — used by `update` when it migrates (Step 8f/8g)
- `complete_bool` — used by `repl_complete`
- `complete_option_bool` — used by `repl_complete`
- `map_completion_values` — used by `repl_complete`
### Files NOT changed
- **`src/client/macros.rs`**, **`src/client/model.rs`** — untouched;
Step 8a already migrated these.
- **All other source files** — no changes. All existing `Config` methods
stay intact.
## Key decisions
### 1. Same bridge pattern as Steps 3-8a
New methods sit alongside originals. No caller migration. `Config`'s
`retrieve_role`, `set_model`, `setup_model`, `use_prompt`,
`set_rag_reranker_model`, `set_rag_top_k`, `repl_complete` all stay
on `Config` and continue working for every current caller.
### 2. `set_model_on_role_like` returns `Result<bool>` (not just `bool`)
Unlike the Step 7 `set_temperature_on_role_like` pattern that returns
a plain `bool`, `set_model_on_role_like` returns `Result<bool>` because
`Model::retrieve_model` can fail. The `bool` still signals whether a
role-like was mutated. When `false`, the model was assigned to
`ctx.model` directly (so the caller doesn't need to fall through to
`AppConfig` — the "no role-like" case is handled in-method by assigning
to `ctx.model`). This differs from the Step 7 pattern where `false`
means "caller must call the `_default`."
### 3. `setup_model` split into two independent methods
`Config::setup_model` does three things:
1. Picks a default model ID if empty (`ensure_default_model_id`)
2. Calls `set_model` to resolve and assign the model
3. Writes back `model_id` to config
The split:
- `AppConfig::ensure_default_model_id()` handles #1 and #3
- `RequestContext::reload_current_model()` handles #2
Step 8f will compose them: first call `ensure_default_model_id` on
the app config, then call `reload_current_model` on the context
with the returned ID.
### 4. `repl_complete` MCP completions are reduced during bridge
`Config::repl_complete` reads `self.mcp_registry.list_configured_servers()`
for the `enabled_mcp_servers` completion values. `RequestContext` has no
`mcp_registry` field. During the bridge window, the new `repl_complete`
offers only `mapping_mcp_servers` keys (from `AppConfig`) as MCP
completions. Step 8d's `ToolScope` will provide full MCP server
completions.
This is acceptable because:
- The new method isn't called by anyone yet (bridge pattern)
- When Step 8d wires it up, `ToolScope` will be available
### 5. `edit_role` deferred to Step 8d
`Config::edit_role` calls `self.use_role()` as its last line.
`use_role` is a scope-transition method that Step 8d will rewrite
to use `McpFactory::acquire()`. Migrating `edit_role` without
`use_role` would require either a stub or leaving it half-broken.
Deferring it keeps the bridge clean.
### 6. `update` dispatcher deferred to Step 8f/8g
`Config::update` takes `&GlobalConfig` and has two branches that
do heavy MCP registry manipulation (`enabled_mcp_servers` and
`mcp_server_support`). These branches require Step 8d's
`McpFactory`/`ToolScope` infrastructure. The remaining branches
could be migrated individually, but splitting the dispatcher
partially creates a confusing dual-path situation. Deferring the
entire dispatcher keeps things clean.
### 7. RAG mutation uses clone-and-replace on `Arc<Rag>`
`Config::set_rag_reranker_model` uses the `update_rag` helper which
takes `&GlobalConfig`, clones the `Arc<Rag>`, mutates the clone,
and writes it back via `config.write().rag = Some(Arc::new(rag))`.
The new `RequestContext` methods do the same thing but without the
`GlobalConfig` indirection: clone `Arc<Rag>` contents, mutate,
wrap in a new `Arc`, assign to `self.rag`. Semantically identical.
## Deviations from plan
### 2 methods deferred (not in plan's "done" scope for 8b)
| Method | Why deferred |
|---|---|
| `edit_role` | Calls `use_role` which is Step 8d |
| `update` | MCP registry branches require Step 8d's `McpFactory`/`ToolScope` |
The plan's 8b description listed both as potential deferrals:
- `edit_role`: "calls editor + upsert_role + use_role — use_role is
still Step 8d, so edit_role may stay deferred"
- `update`: "Once all the individual set_* methods exist on both types"
— the MCP-touching set_* methods don't exist yet
### `set_model_on_role_like` handles the no-role-like case internally
The plan said the split should be:
- `RequestContext::set_model_on_role_like` → returns `bool`
- `AppConfig::set_model_default` → sets global
But `set_model` doesn't just set `model_id` when no role-like is
active — it also assigns the resolved `Model` struct to `self.model`
(runtime). Since the `Model` struct lives on `RequestContext`, the
no-role-like branch must also live on `RequestContext`. So
`set_model_on_role_like` handles both cases (role-like mutation and
`ctx.model` assignment) and returns `false` to signal that `model_id`
on `AppConfig` may also need updating. `AppConfig::set_model_id_default`
is the simpler companion.
## Verification
### Compilation
- `cargo check` — clean, zero warnings, zero errors
- `cargo clippy` — clean
### Tests
- `cargo test`**63 passed, 0 failed** (unchanged from Steps 18a)
No new tests added — this is a bridge-pattern step that adds methods
alongside existing ones. The existing test suite confirms no regressions.
## Handoff to next step
### What Step 8c can rely on
Step 8c (extract `McpFactory::acquire()` from `McpRegistry::init_server`)
can rely on:
- **All Step 8a guarantees still hold**`Model::retrieve_model`,
`list_models`, `list_all_models`, `list_client_names` all take
`&AppConfig`
- **`RequestContext` now has 46 inherent methods** across 5 impl blocks:
1 constructor + 13 reads + 12 writes + 14 mixed (Step 7) + 7 mixed
(Step 8b) = 47 total (46 public + 1 private `open_message_file`)
- **`AppConfig` now has 21 methods**: 7 reads + 4 writes + 10
setter-defaults (6 from Step 7 + 4 from Step 8b)
### What Step 8c should watch for
Step 8c is **independent of Step 8b**. It extracts the MCP subprocess
spawn logic from `McpRegistry::init_server` into a standalone function
and implements `McpFactory::acquire()`. Step 8b provides no input to
8c.
### What Step 8d should know about Step 8b's output
Step 8d (scope transitions) depends on both 8b and 8c. From 8b it
gets:
- `RequestContext::retrieve_role(app, name)` — needed by `use_role`
- `RequestContext::set_model_on_role_like(app, model_id)` — may be
useful inside scope transitions
### What Step 8f/8g should know about Step 8b deferrals
- **`edit_role`** — needs `use_role` from Step 8d. Once 8d ships,
`edit_role` on `RequestContext` becomes: call `app.editor()`, call
`upsert_role(name)`, call `self.use_role(app, name, abort_signal)`.
The `upsert_role` method is still on `Config` and needs migrating
(it calls `self.editor()` which is on `AppConfig`, and
`ensure_parent_exists` which is a free function — straightforward).
- **`update` dispatcher** — needs all `set_*` branches migrated. The
non-MCP branches are ready now. The MCP branches need Step 8d's
`McpFactory`/`ToolScope`.
- **`use_role_safely` / `use_session_safely`** — still on `Config`.
These wrappers exist only because `Config::use_role` is `&mut self`
and the REPL holds `Arc<RwLock<Config>>`. Step 8g eliminates them
when the REPL switches to holding `RequestContext` directly.
### Bridge-window duplication count at end of Step 8b
Running tally:
- `AppConfig` (Steps 3+4+7+8b): 21 methods
- `RequestContext` (Steps 5+6+7+8b): 46 methods
- `paths` module (Step 2): 33 free functions
- Step 6.5 types: 4 new types on scaffolding
- `mod.rs` visibility bumps: 4 helpers → `pub(super)`
**Total: 67 methods + 33 paths + 4 types / ~1500 lines of parallel logic**
All auto-delete in Step 10.
### Files to re-read at the start of Step 8c
- `docs/PHASE-1-IMPLEMENTATION-PLAN.md` — Step 8c section
- `src/mcp/mod.rs``McpRegistry::init_server` method body (the
spawn logic to extract)
- `src/config/mcp_factory.rs` — current scaffolding from Step 6.5
## References
- Phase 1 plan: `docs/PHASE-1-IMPLEMENTATION-PLAN.md`
- Step 8a notes: `docs/implementation/PHASE-1-STEP-8a-NOTES.md`
- Step 7 notes: `docs/implementation/PHASE-1-STEP-7-NOTES.md`
- Modified files:
- `src/config/request_context.rs` (7 new methods, import updates)
- `src/config/app_config.rs` (4 new `set_*_default` / `ensure_*`
methods)
- `src/config/mod.rs` (4 helper functions bumped to `pub(super)`)

Some files were not shown because too many files have changed in this diff Show More