Merge pull request #17 from Sewer56/rework-preamble-builder-2

Enhance PreambleBuilder with system_prompt, add_context, and allowed_paths support

Author: Sewer56

src/.cargo/config.toml

@@ -0,0 +1,2 @@
+[build]
+rustdocflags = ["-D", "warnings"]

src/.cargo/verify.ps1

@@ -0,0 +1,39 @@
+# Post-change verification script
+# All steps must pass without warnings
+# Keep in sync with verify.sh
+#
+# Note: llm-coding-tools-rig and llm-coding-tools-serdesai are async-only (implement async Tool traits).
+# The blocking feature only applies to llm-coding-tools-core.
+
+$ErrorActionPreference = "Stop"
+
+Write-Host "Building..."
+cargo build -p llm-coding-tools-core
+cargo build -p llm-coding-tools-rig --quiet
+cargo build -p llm-coding-tools-serdesai --quiet
+
+Write-Host "Testing..."
+cargo test -p llm-coding-tools-core
+cargo test -p llm-coding-tools-rig --quiet
+cargo test -p llm-coding-tools-serdesai --quiet
+
+Write-Host "Clippy..."
+cargo clippy -p llm-coding-tools-core -- -D warnings
+cargo clippy -p llm-coding-tools-rig --quiet -- -D warnings
+cargo clippy -p llm-coding-tools-serdesai --quiet -- -D warnings
+
+Write-Host "Testing blocking feature..."
+cargo test -p llm-coding-tools-core --no-default-features --features blocking --quiet
+
+Write-Host "Docs..."
+cargo doc --workspace --no-deps --quiet
+
+Write-Host "Formatting..."
+cargo fmt --all
+
+Write-Host "Publish dry-run..."
+cargo publish --dry-run -p llm-coding-tools-core --quiet
+cargo publish --dry-run -p llm-coding-tools-rig --quiet
+cargo publish --dry-run -p llm-coding-tools-serdesai --quiet
+
+Write-Host "All checks passed!"

src/.cargo/verify.sh

@@ -0,0 +1,40 @@
+#!/usr/bin/env bash
+# Post-change verification script
+# All steps must pass without warnings
+# Keep in sync with verify.ps1
+#
+# Note: llm-coding-tools-rig and llm-coding-tools-serdesai are async-only (implement async Tool traits).
+# The blocking feature only applies to llm-coding-tools-core.
+
+set -e
+
+echo "Building..."
+cargo build -p llm-coding-tools-core
+cargo build -p llm-coding-tools-rig --quiet
+cargo build -p llm-coding-tools-serdesai --quiet
+
+echo "Testing..."
+cargo test -p llm-coding-tools-core
+cargo test -p llm-coding-tools-rig --quiet
+cargo test -p llm-coding-tools-serdesai --quiet
+
+echo "Clippy..."
+cargo clippy -p llm-coding-tools-core -- -D warnings
+cargo clippy -p llm-coding-tools-rig --quiet -- -D warnings
+cargo clippy -p llm-coding-tools-serdesai --quiet -- -D warnings
+
+echo "Testing blocking feature..."
+cargo test -p llm-coding-tools-core --no-default-features --features blocking --quiet
+
+echo "Docs..."
+cargo doc --workspace --no-deps --quiet
+
+echo "Formatting..."
+cargo fmt --all
+
+echo "Publish dry-run..."
+cargo publish --dry-run -p llm-coding-tools-core --quiet
+cargo publish --dry-run -p llm-coding-tools-rig --quiet
+cargo publish --dry-run -p llm-coding-tools-serdesai --quiet
+
+echo "All checks passed!"

src/AGENTS.md

@@ -72,16 +72,4 @@ This is a high-performance library. Optimize aggressively.
 
 # Post-Change Verification
 
-All must pass without warnings:
-
-```bash
-cargo build -p llm-coding-tools-core && cargo build -p llm-coding-tools-rig --quiet && cargo build -p llm-coding-tools-serdesai --quiet && cargo test -p llm-coding-tools-core && cargo test -p llm-coding-tools-rig --quiet && cargo test -p llm-coding-tools-serdesai --quiet && cargo clippy -p llm-coding-tools-core -- -D warnings && cargo clippy -p llm-coding-tools-rig --quiet -- -D warnings && cargo clippy -p llm-coding-tools-serdesai --quiet -- -D warnings && cargo test -p llm-coding-tools-core --no-default-features --features blocking --quiet && cargo doc --workspace --no-deps --quiet && cargo fmt --all
-```
-
-Note: `llm-coding-tools-rig` and `llm-coding-tools-serdesai` are async-only (implement async `Tool` traits).
-The `blocking` feature only applies to `llm-coding-tools-core`.
-
-For individual crates:
-```bash
-cargo publish --dry-run -p llm-coding-tools-core --quiet && cargo publish --dry-run -p llm-coding-tools-rig --quiet && cargo publish --dry-run -p llm-coding-tools-serdesai --quiet
-```
+All must pass without warnings. Run: `.cargo/verify.sh` (or `.cargo/verify.ps1` on Windows)

src/llm-coding-tools-core/examples/preamble_preview.rs

@@ -0,0 +1,130 @@
+//! Preamble preview - demonstrates full preamble generation.
+//!
+//! Shows how PreambleBuilder combines:
+//! - Custom system prompts
+//! - Environment section (working directory, allowed paths)
+//! - Tool usage guidelines (from tracked tools)
+//! - Supplemental context (git workflow, GitHub CLI)
+//!
+//! Run: cargo run --example preamble_preview -p llm-coding-tools-core
+
+use llm_coding_tools_core::context::ToolContext;
+use llm_coding_tools_core::{context, AllowedPathResolver, PreambleBuilder};
+
+fn main() {
+    // Use from_canonical to avoid filesystem requirements for the example.
+    // In real usage, AllowedPathResolver::new() canonicalizes and validates paths.
+    let resolver = AllowedPathResolver::from_canonical(["/home/user/project", "/tmp"]);
+
+    // Build preamble with all features demonstrated
+    let mut pb = PreambleBuilder::new()
+        .system_prompt(
+            "# System Instructions\n\n\
+             You are a helpful coding assistant. Follow best practices and \
+             write clean, maintainable code.",
+        )
+        .working_directory("/home/user/project")
+        .allowed_paths(&resolver)
+        .add_context("Git Workflow", context::GIT_WORKFLOW)
+        .add_context("GitHub CLI", context::GITHUB_CLI);
+
+    // Track tools - in real usage this would be:
+    //   .tool(pb.track(ReadTool::new()))
+    // For the preview, we just register them without using the returned tool.
+    let _ = pb.track(MockReadTool);
+    let _ = pb.track(MockWriteTool);
+    let _ = pb.track(MockEditTool);
+    let _ = pb.track(MockBashTool);
+    let _ = pb.track(MockGlobTool);
+    let _ = pb.track(MockGrepTool);
+    let _ = pb.track(MockWebFetchTool);
+    let _ = pb.track(MockTodoWriteTool);
+    let _ = pb.track(MockTodoReadTool);
+
+    let preamble = pb.build();
+
+    // Output the preamble
+    println!("{preamble}");
+
+    // Show statistics for token estimation
+    println!("\n{}", "=".repeat(60));
+    println!("Statistics:");
+    println!("  Characters: {}", preamble.len());
+    println!("  Lines: {}", preamble.lines().count());
+    println!("  Estimated tokens: ~{} (chars/4)", preamble.len() / 4);
+}
+
+// Mock tools implementing ToolContext for demonstration.
+// In real usage, these would be actual tool structs from llm-coding-tools-rig.
+
+struct MockReadTool;
+impl ToolContext for MockReadTool {
+    const NAME: &'static str = "read";
+    fn context(&self) -> &'static str {
+        context::READ_ALLOWED
+    }
+}
+
+struct MockWriteTool;
+impl ToolContext for MockWriteTool {
+    const NAME: &'static str = "write";
+    fn context(&self) -> &'static str {
+        context::WRITE_ALLOWED
+    }
+}
+
+struct MockEditTool;
+impl ToolContext for MockEditTool {
+    const NAME: &'static str = "edit";
+    fn context(&self) -> &'static str {
+        context::EDIT_ALLOWED
+    }
+}
+
+struct MockBashTool;
+impl ToolContext for MockBashTool {
+    const NAME: &'static str = "bash";
+    fn context(&self) -> &'static str {
+        context::BASH
+    }
+}
+
+struct MockGlobTool;
+impl ToolContext for MockGlobTool {
+    const NAME: &'static str = "glob";
+    fn context(&self) -> &'static str {
+        context::GLOB_ALLOWED
+    }
+}
+
+struct MockGrepTool;
+impl ToolContext for MockGrepTool {
+    const NAME: &'static str = "grep";
+    fn context(&self) -> &'static str {
+        context::GREP_ALLOWED
+    }
+}
+
+struct MockWebFetchTool;
+impl ToolContext for MockWebFetchTool {
+    const NAME: &'static str = "webfetch";
+    fn context(&self) -> &'static str {
+        context::WEBFETCH
+    }
+}
+
+struct MockTodoWriteTool;
+impl ToolContext for MockTodoWriteTool {
+    const NAME: &'static str = "todowrite";
+    fn context(&self) -> &'static str {
+        context::TODO_WRITE
+    }
+}
+
+struct MockTodoReadTool;
+impl ToolContext for MockTodoReadTool {
+    const NAME: &'static str = "todoread";
+    fn context(&self) -> &'static str {
+        context::TODO_READ
+    }
+}

src/llm-coding-tools-core/src/context/bash.txt

@@ -6,115 +6,41 @@ IMPORTANT: This tool is for terminal operations like git, npm, docker, etc. DO N
 
 Before executing the command, please follow these steps:
 
-1. Directory Verification:
-   - If the command will create new directories or files, first use `ls` to verify the parent directory exists and is the correct location
-   - For example, before running "mkdir foo/bar", first use `ls foo` to check that "foo" exists and is the intended parent directory
-
-2. Command Execution:
-   - Always quote file paths that contain spaces with double quotes (e.g., rm "path with spaces/file.txt")
-   - Examples of proper quoting:
-     - mkdir "/Users/name/My Documents" (correct)
-     - mkdir /Users/name/My Documents (incorrect - will fail)
-     - python "/path/with spaces/script.py" (correct)
-     - python /path/with spaces/script.py (incorrect - will fail)
-   - After ensuring proper quoting, execute the command.
-   - Capture the output of the command.
-
-Usage notes:
-  - The `command` argument is required.
-  - You can specify an optional `timeout_ms` in milliseconds (up to 600000ms / 10 minutes). If not specified, commands will timeout after 120000ms (2 minutes).
-  - It is very helpful if you write a clear, concise description of what this command does in 5-10 words.
-  - If the output exceeds 30000 characters, output will be truncated before being returned to you.
-
-  - Avoid using Bash with the `find`, `grep`, `cat`, `head`, `tail`, `sed`, `awk`, or `echo` commands, unless explicitly instructed or when these commands are truly necessary for the task. Instead, always prefer using the dedicated tools for these commands:
-    - File search: Use Glob (NOT find or ls)
-    - Content search: Use Grep (NOT grep)
-    - Read files: Use Read (NOT cat/head/tail)
-    - Edit files: Use Edit (NOT sed/awk)
-    - Write files: Use Write (NOT echo >/cat <<EOF)
-    - Communication: Output text directly (NOT echo/printf)
-  - When issuing multiple commands:
-    - If the commands are independent and can run in parallel, make multiple Bash tool calls in a single message. For example, if you need to run "git status" and "git diff", send a single message with two Bash tool calls in parallel.
-    - If the commands depend on each other and must run sequentially, use a single Bash call with '&&' to chain them together (e.g., `git add . && git commit -m "message" && git push`). For instance, if one operation must complete before another starts (like mkdir before cp, Write before Bash for git operations, or git add before git commit), run these operations sequentially instead.
-    - Use ';' only when you need to run commands sequentially but don't care if earlier commands fail
-    - DO NOT use newlines to separate commands (newlines are ok in quoted strings)
-  - AVOID using `cd <directory> && <command>`. Use the `workdir` parameter to change directories instead.
-    <good-example>
-    Use workdir="/foo/bar" with command: pytest tests
-    </good-example>
-    <bad-example>
-    cd /foo/bar && pytest tests
-    </bad-example>
-
-# Committing changes with git
-
-Only create commits when requested by the user. If unclear, ask first. When the user asks you to create a new git commit, follow these steps carefully:
-
-Git Safety Protocol:
-- NEVER update the git config
-- NEVER run destructive/irreversible git commands (like push --force, hard reset, etc) unless the user explicitly requests them
-- NEVER skip hooks (--no-verify, --no-gpg-sign, etc) unless the user explicitly requests it
-- NEVER run force push to main/master, warn the user if they request it
-- Avoid git commit --amend. ONLY use --amend when ALL conditions are met:
-  (1) User explicitly requested amend, OR commit SUCCEEDED but pre-commit hook auto-modified files that need including
-  (2) HEAD commit was created by you in this conversation (verify: git log -1 --format='%an %ae')
-  (3) Commit has NOT been pushed to remote (verify: git status shows "Your branch is ahead")
-- CRITICAL: If commit FAILED or was REJECTED by hook, NEVER amend - fix the issue and create a NEW commit
-- CRITICAL: If you already pushed to remote, NEVER amend unless user explicitly requests it (requires force push)
-- NEVER commit changes unless the user explicitly asks you to. It is VERY IMPORTANT to only commit when explicitly asked, otherwise the user will feel that you are being too proactive.
-
-1. You can call multiple tools in a single response. When multiple independent pieces of information are requested and all commands are likely to succeed, run multiple tool calls in parallel for optimal performance. run the following bash commands in parallel, each using the Bash tool:
-  - Run a git status command to see all untracked files.
-  - Run a git diff command to see both staged and unstaged changes that will be committed.
-  - Run a git log command to see recent commit messages, so that you can follow this repository's commit message style.
-2. Analyze all staged changes (both previously staged and newly added) and draft a commit message:
-  - Summarize the nature of the changes (eg. new feature, enhancement to an existing feature, bug fix, refactoring, test, docs, etc.). Ensure the message accurately reflects the changes and their purpose (i.e. "add" means a wholly new feature, "update" means an enhancement to an existing feature, "fix" means a bug fix, etc.).
-  - Do not commit files that likely contain secrets (.env, credentials.json, etc.). Warn the user if they specifically request to commit those files
-  - Draft a concise (1-2 sentences) commit message that focuses on the "why" rather than the "what"
-  - Ensure it accurately reflects the changes and their purpose
-3. You can call multiple tools in a single response. When multiple independent pieces of information are requested and all commands are likely to succeed, run multiple tool calls in parallel for optimal performance. run the following commands:
-   - Add relevant untracked files to the staging area.
-   - Create the commit with a message
-   - Run git status after the commit completes to verify success.
-   Note: git status depends on the commit completing, so run it sequentially after the commit.
-4. If the commit fails due to pre-commit hook, fix the issue and create a NEW commit (see amend rules above)
-
-Important notes:
-- NEVER run additional commands to read or explore code, besides git bash commands
-- NEVER use the TodoWrite or Task tools
-- DO NOT push to the remote repository unless the user explicitly asks you to do so
-- IMPORTANT: Never use git commands with the -i flag (like git rebase -i or git add -i) since they require interactive input which is not supported.
-- If there are no changes to commit (i.e., no untracked files and no modifications), do not create an empty commit
-
-# Creating pull requests
-Use the gh command via the Bash tool for ALL GitHub-related tasks including working with issues, pull requests, checks, and releases. If given a Github URL use the gh command to get the information needed.
-
-IMPORTANT: When the user asks you to create a pull request, follow these steps carefully:
-
-1. You can call multiple tools in a single response. When multiple independent pieces of information are requested and all commands are likely to succeed, run multiple tool calls in parallel for optimal performance. run the following bash commands in parallel using the Bash tool, in order to understand the current state of the branch since it diverged from the main branch:
-   - Run a git status command to see all untracked files
-   - Run a git diff command to see both staged and unstaged changes that will be committed
-   - Check if the current branch tracks a remote branch and is up to date with the remote, so you know if you need to push to the remote
-   - Run a git log command and `git diff [base-branch]...HEAD` to understand the full commit history for the current branch (from the time it diverged from the base branch)
-2. Analyze all changes that will be included in the pull request, making sure to look at all relevant commits (NOT just the latest commit, but ALL commits that will be included in the pull request!!!), and draft a pull request summary
-3. You can call multiple tools in a single response. When multiple independent pieces of information are requested and all commands are likely to succeed, run multiple tool calls in parallel for optimal performance. run the following commands in parallel:
-   - Create new branch if needed
-   - Push to remote with -u flag if needed
-   - Create PR using gh pr create with the format below. Use a HEREDOC to pass the body to ensure correct formatting.
-<example>
-gh pr create --title "the pr title" --body "$(cat <<'EOF'
-## Summary
-<1-3 bullet points>
-
-## Test plan
-[Bulleted markdown checklist of TODOs for testing the pull request...]
-EOF
-)"
-</example>
-
-Important:
-- DO NOT use the TodoWrite or Task tools
-- Return the PR URL when you're done, so the user can see it
-
-# Other common operations
-- View comments on a Github PR: gh api repos/foo/bar/pulls/123/comments
+#### Directory Verification
+- If the command will create new directories or files, first use `ls` to verify the parent directory exists and is the correct location
+- For example, before running "mkdir foo/bar", first use `ls foo` to check that "foo" exists and is the intended parent directory
+
+#### Command Execution
+- Always quote file paths that contain spaces with double quotes (e.g., rm "path with spaces/file.txt")
+- Examples of proper quoting:
+  - mkdir "/Users/name/My Documents" (correct)
+  - mkdir /Users/name/My Documents (incorrect - will fail)
+  - python "/path/with spaces/script.py" (correct)
+  - python /path/with spaces/script.py (incorrect - will fail)
+- After ensuring proper quoting, execute the command.
+- Capture the output of the command.
+
+##### Usage notes
+- The `command` argument is required.
+- You can specify an optional `timeout_ms` in milliseconds (up to 600000ms / 10 minutes). If not specified, commands will timeout after 120000ms (2 minutes).
+- It is very helpful if you write a clear, concise description of what this command does in 5-10 words.
+- If the output exceeds 30000 characters, output will be truncated before being returned to you.
+- Avoid using Bash with the `find`, `grep`, `cat`, `head`, `tail`, `sed`, `awk`, or `echo` commands, unless explicitly instructed or when these commands are truly necessary for the task. Instead, always prefer using the dedicated tools for these commands:
+  - File search: Use Glob (NOT find or ls)
+  - Content search: Use Grep (NOT grep)
+  - Read files: Use Read (NOT cat/head/tail)
+  - Edit files: Use Edit (NOT sed/awk)
+  - Write files: Use Write (NOT echo >/cat <<EOF)
+  - Communication: Output text directly (NOT echo/printf)
+- When issuing multiple commands:
+  - If the commands are independent and can run in parallel, make multiple Bash tool calls in a single message. For example, if you need to run "git status" and "git diff", send a single message with two Bash tool calls in parallel.
+  - If the commands depend on each other and must run sequentially, use a single Bash call with '&&' to chain them together (e.g., `git add . && git commit -m "message" && git push`). For instance, if one operation must complete before another starts (like mkdir before cp, Write before Bash for git operations, or git add before git commit), run these operations sequentially instead.
+  - Use ';' only when you need to run commands sequentially but don't care if earlier commands fail
+  - DO NOT use newlines to separate commands (newlines are ok in quoted strings)
+- AVOID using `cd <directory> && <command>`. Use the `workdir` parameter to change directories instead.
+  <good-example>
+  Use workdir="/foo/bar" with command: pytest tests
+  </good-example>
+  <bad-example>
+  cd /foo/bar && pytest tests
+  </bad-example>