ephemeral-buffer-mcp 0.1.1__tar.gz

ephemeral_buffer_mcp-0.1.1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or exemplary damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Karl Rister
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

ephemeral_buffer_mcp-0.1.1/PKG-INFO

@@ -0,0 +1,216 @@
+Metadata-Version: 2.4
+Name: ephemeral-buffer-mcp
+Version: 0.1.1
+Summary: Ephemeral in-memory command output capture and hybrid search MCP server for coding agents
+Author-email: Karl Rister <krister@redhat.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/k-rister/ephemeral-buffer-mcp
+Project-URL: Repository, https://github.com/k-rister/ephemeral-buffer-mcp
+Project-URL: Issues, https://github.com/k-rister/ephemeral-buffer-mcp/issues
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: mcp<2
+Requires-Dist: fastembed>=0.7.0
+Requires-Dist: numpy>=1.24.0
+Dynamic: license-file
+
+# Ephemeral Buffer MCP Server (`ephemeral-buffer`)
+
+[![CI](https://github.com/k-rister/ephemeral-buffer-mcp/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/k-rister/ephemeral-buffer-mcp/actions/workflows/ci.yml)
+
+An ephemeral in-memory command output capture and hybrid search engine (BM25 + Semantic Embeddings) for AI coding assistants (Claude Code, Antigravity, Cursor, etc.).
+
+---
+
+## 🎯 The Problem This Solves
+
+When coding agents run commands that generate large outputs (thousands of lines of build logs, test runs, stack traces, JSON dumps), agents face two failure modes:
+1. **Context Pollution:** Ingesting megabytes of raw text blows out token limits and degrades model reasoning.
+2. **Blind Bash Filtering:** Agents waste multiple turns running `head`, `tail`, `grep`, and `awk` trying to guess error patterns.
+
+## 💡 The Solution
+
+`ephemeral-buffer` provides a transient in-memory ring buffer with **Dual Hybrid Indexing** and **Content-Aware Structure Parsing**:
+- **BM25 Lexical Search (SQLite FTS5):** For exact matches on error codes (`NullPointerException`, `ECONNREFUSED`, `exit 137`, HTTP `502`).
+- **Dense Semantic Vector Search (FastEmbed ONNX):** For fuzzy conceptual queries (*"Where did the DB connection pool fail?"* or *"Why did authentication fail?"*).
+- **Unified Diff Structural Mapping:** Automatically detects git diffs and PR diffs (`gh pr diff`, `git show`, `git diff`), parses modified files, additions/deletions, and generates a line-indexed file map in the summary.
+- **Smart Signal Filtering:** Scans command/build/test logs for diagnostic keywords, suppresses false positives in diffs and source code, and accurately captures test runner failures, unhandled exceptions, and merge conflicts. Use `content_type='log'` when a plain-text capture should be signal-scanned.
+- Successful test-run summaries such as `OK` or `25 passed` suppress fixture-only error and failure keywords while retaining the original output for search.
+- **Reciprocal Rank Fusion (RRF):** Blends lexical and semantic ranking for high precision retrieval.
+- **LRU Capture Eviction:** Holds up to 25 captures and 50 MiB of captured content by default, evicting the least recently used captures when either limit is reached.
+- **Thread-Safe Shared Engine:** Serializes ingestion, search, LRU updates, eviction, and cleanup across MCP requests and CLI socket clients.
+
+---
+
+## 🏗 Architecture & Flow
+
+```mermaid
+flowchart TD
+    subgraph Ingestion["1. Ingestion Paths"]
+        A["CLI Pipe: command 2>&1 | ephbuf"] --> D["Unix Socket (platform temp dir)"]
+        B["Agent Tool: execute_and_capture(cmd)"] --> E["Ephemeral Ring Buffer Engine"]
+        C["Agent Tool: capture_text / capture_file"] --> E
+        D --> E
+    end
+
+    subgraph Indexing["2. Dual Hybrid Indexing & Classification"]
+        E --> F["SQLite FTS5 (BM25 Lexical)"]
+        E --> G["FastEmbed ONNX (Dense Vectors)"]
+        E --> K["Diff & Signal Parser (File Maps & Conflict Detection)"]
+    end
+
+    subgraph Querying["3. Agent Query & Retrieval"]
+        F & G --> H["Reciprocal Rank Fusion (RRF)"]
+        H --> I["search_capture(query, mode='hybrid')"]
+        K --> L["Diff File Map & get_capture_slice"]
+        I --> J["Precise Context Chunk + Line Numbers"]
+    end
+```
+
+---
+
+## 🚀 How to Use It
+
+### 1. From the Terminal (CLI Pipe via `ephbuf`)
+You can pipe command output directly into the running MCP server:
+
+```bash
+# Pipe any command output into the buffer
+pytest -v 2>&1 | ephbuf --label "pytest run"
+
+# Pipe git diffs directly
+git diff HEAD~3 | ephbuf --label "feature diff" --type diff
+
+# Or wrap command execution
+ephbuf --label "backend build" -- cargo build --verbose
+```
+
+The optional `--type`/`-t` hint accepts `auto` (the default), `diff`, `log`, or
+`text`. Use `diff` for unified patches when automatic detection is ambiguous;
+otherwise `auto` classifies diffs, build/test logs, and plain text from the
+content and label.
+
+`ephbuf` also bounds wrapped-command and piped-stdin capture with
+`--max-output-bytes`; it defaults to `EPHEMERAL_MAX_BUFFER_BYTES` or 50 MiB and
+retains the beginning and end of oversized output.
+Use `--timeout-seconds` to stop a wrapped command after a bounded runtime; timed
+out commands retain the output collected so far and exit with status 124.
+Requested `max_output_bytes` and `capture_file` `max_bytes` values may not
+exceed the configured buffer byte limit; the tools return a validation error
+instead of silently clamping them.
+
+### 2. From the AI Agent via MCP Tools
+
+The agent has access to the following tools:
+
+| Tool | Purpose |
+| :--- | :--- |
+| `execute_and_capture(command, cwd, label, content_type='auto', max_output_bytes=None, timeout_seconds=None)` | Executes a shell command with bounded head/tail capture, optional timeout, and a compact diagnostic summary (exit code, diff file map, error signals, and truncation status) to the agent context. |
+| `capture_text(content, label, content_type='auto')` | Ingests text directly into the buffer. |
+| `capture_file(file_path, label, content_type='auto', max_bytes=None)` | Ingests a bounded log/output file from disk; defaults to the configured buffer byte limit. |
+| `search_capture(query, mode, top_k, context_lines)` | Hybrid/BM25/Semantic search over the captured output. Returns matching chunks with surrounding context lines and exact line numbers. |
+| `get_capture_slice(start_line, end_line)` | Retrieves exact line ranges to inspect full stack traces, logs, or specific diff files. |
+| `get_capture_summary(capture_id)` | Diagnostic overview (line counts, diff file maps, error signals, preview). |
+| `get_buffer_stats()` | Reports aggregate capture count, content bytes, lines, chunks, embedding model readiness, embedding bytes, accounted bytes, and process RSS. |
+| `list_captures()` | Lists active captures in the ring buffer. |
+| `clear_captures(capture_id)` | Clears buffer. |
+
+For diff captures, `get_capture_summary` reports the detected file map,
+addition/deletion statistics, line ranges, and merge-conflict signals. Use
+`get_capture_slice` with those ranges to retrieve the complete file context.
+
+### 3. Capture Hygiene
+
+Keep captures focused so search results remain useful and the agent receives
+only the context it needs:
+
+- Capture one command or related output stream at a time, using a descriptive
+  label.
+- Start with `get_capture_summary`, then use `search_capture` or
+  `get_capture_slice` for targeted retrieval instead of repeatedly recapturing
+  the same output.
+- Use `clear_captures(capture_id)` when a capture is no longer needed; use
+  `clear_captures("all")` between unrelated investigations.
+
+The buffer is intentionally transient and bounded by the LRU capture limit,
+but explicit cleanup prevents recent investigations from obscuring the active
+one before automatic eviction occurs. Its memory metrics separate captured
+content and embedding bytes from process RSS; the unaccounted RSS value includes
+model, index, and Python object overhead and is approximate.
+
+The server defaults can be overridden with `EPHEMERAL_MAX_CAPTURES` and
+`EPHEMERAL_MAX_BUFFER_BYTES`. Session-aware launchers can set
+`EPHEMERAL_SESSION_ID` so each server/CLI pair automatically derives a unique
+socket path; `EPHEMERAL_SOCKET_PATH` remains an explicit override. The byte
+limit accounts for
+captured UTF-8 content; `get_buffer_stats` also reports embedding model
+readiness, embedding/cache settings, and process memory separately.
+`execute_and_capture` retains the beginning and end of oversized command
+output and marks the capture with its original byte count.
+
+See [OPERATIONS.md](OPERATIONS.md) for deployment settings, troubleshooting,
+release verification, and repository maintenance procedures.
+
+---
+
+## 🛠 Testing the Server
+
+Set up a local development environment from a fresh checkout:
+
+```bash
+python3 -m venv .venv
+.venv/bin/python -m pip install -r requirements-dev.txt
+```
+
+Run the test suite:
+```bash
+.venv/bin/python -m unittest test_engine.py test_capture_utils.py test_config.py test_cli.py test_server.py
+.venv/bin/python -m unittest test_e2e_pipe.py
+```
+
+Measure focused-test coverage locally:
+```bash
+.venv/bin/python -m coverage run --source=. --omit='test_*.py,benchmark_concurrency.py' -m unittest test_engine.py test_capture_utils.py test_config.py test_cli.py test_server.py
+.venv/bin/python -m coverage report
+```
+The current focused-test baseline is 82%; CI enforces an 82% minimum and uploads
+the coverage reports for inspection.
+
+GitHub Actions runs the compile check, focused tests, and end-to-end test on
+Python 3.10 and 3.12 for pushes to `main` and pull requests. The FastEmbed
+model is loaded on the first capture or semantic search rather than during
+server import. Set `EPHEMERAL_EMBEDDING_MODEL` to select a compatible model and
+`EPHEMERAL_FASTEMBED_CACHE_DIR` to control its cache directory. The model cache
+is retained between CI runs to reduce startup time.
+It also builds the wheel and verifies the installed `ephbuf` entry point.
+CI audits the declared dependencies with `pip-audit` and fails if known
+vulnerabilities are found.
+CI resolves the runtime dependencies through `constraints.txt`; the direct
+pins are updated only after the full test matrix passes.
+
+Pushing a version tag such as `v0.1.1` runs the release workflow, which builds
+wheel and source distributions, validates their metadata, verifies the
+installed package, and uploads the artifacts for review. The tag must match
+the version in `pyproject.toml`.
+The workflow also uploads `SHA256SUMS`; verify a downloaded artifact with
+`sha256sum --check SHA256SUMS` from the directory containing the files.
+Release distributions also receive a GitHub build-provenance attestation.
+After the repository's `pypi` environment is configured with a PyPI trusted
+publisher, the workflow publishes the distributions to PyPI automatically.
+
+Run the concurrency benchmark:
+```bash
+.venv/bin/python benchmark_concurrency.py --captures 32 --workers 8
+```
+The benchmark accepts `--min-ingest-per-second` and `--min-reads-per-second`
+thresholds for regression checks. GitHub Actions runs it as an optional weekly
+or manually dispatched job and uploads the results; it is not part of the
+required pull-request checks.

ephemeral_buffer_mcp-0.1.1/README.md

@@ -0,0 +1,192 @@
+# Ephemeral Buffer MCP Server (`ephemeral-buffer`)
+
+[![CI](https://github.com/k-rister/ephemeral-buffer-mcp/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/k-rister/ephemeral-buffer-mcp/actions/workflows/ci.yml)
+
+An ephemeral in-memory command output capture and hybrid search engine (BM25 + Semantic Embeddings) for AI coding assistants (Claude Code, Antigravity, Cursor, etc.).
+
+---
+
+## 🎯 The Problem This Solves
+
+When coding agents run commands that generate large outputs (thousands of lines of build logs, test runs, stack traces, JSON dumps), agents face two failure modes:
+1. **Context Pollution:** Ingesting megabytes of raw text blows out token limits and degrades model reasoning.
+2. **Blind Bash Filtering:** Agents waste multiple turns running `head`, `tail`, `grep`, and `awk` trying to guess error patterns.
+
+## 💡 The Solution
+
+`ephemeral-buffer` provides a transient in-memory ring buffer with **Dual Hybrid Indexing** and **Content-Aware Structure Parsing**:
+- **BM25 Lexical Search (SQLite FTS5):** For exact matches on error codes (`NullPointerException`, `ECONNREFUSED`, `exit 137`, HTTP `502`).
+- **Dense Semantic Vector Search (FastEmbed ONNX):** For fuzzy conceptual queries (*"Where did the DB connection pool fail?"* or *"Why did authentication fail?"*).
+- **Unified Diff Structural Mapping:** Automatically detects git diffs and PR diffs (`gh pr diff`, `git show`, `git diff`), parses modified files, additions/deletions, and generates a line-indexed file map in the summary.
+- **Smart Signal Filtering:** Scans command/build/test logs for diagnostic keywords, suppresses false positives in diffs and source code, and accurately captures test runner failures, unhandled exceptions, and merge conflicts. Use `content_type='log'` when a plain-text capture should be signal-scanned.
+- Successful test-run summaries such as `OK` or `25 passed` suppress fixture-only error and failure keywords while retaining the original output for search.
+- **Reciprocal Rank Fusion (RRF):** Blends lexical and semantic ranking for high precision retrieval.
+- **LRU Capture Eviction:** Holds up to 25 captures and 50 MiB of captured content by default, evicting the least recently used captures when either limit is reached.
+- **Thread-Safe Shared Engine:** Serializes ingestion, search, LRU updates, eviction, and cleanup across MCP requests and CLI socket clients.
+
+---
+
+## 🏗 Architecture & Flow
+
+```mermaid
+flowchart TD
+    subgraph Ingestion["1. Ingestion Paths"]
+        A["CLI Pipe: command 2>&1 | ephbuf"] --> D["Unix Socket (platform temp dir)"]
+        B["Agent Tool: execute_and_capture(cmd)"] --> E["Ephemeral Ring Buffer Engine"]
+        C["Agent Tool: capture_text / capture_file"] --> E
+        D --> E
+    end
+
+    subgraph Indexing["2. Dual Hybrid Indexing & Classification"]
+        E --> F["SQLite FTS5 (BM25 Lexical)"]
+        E --> G["FastEmbed ONNX (Dense Vectors)"]
+        E --> K["Diff & Signal Parser (File Maps & Conflict Detection)"]
+    end
+
+    subgraph Querying["3. Agent Query & Retrieval"]
+        F & G --> H["Reciprocal Rank Fusion (RRF)"]
+        H --> I["search_capture(query, mode='hybrid')"]
+        K --> L["Diff File Map & get_capture_slice"]
+        I --> J["Precise Context Chunk + Line Numbers"]
+    end
+```
+
+---
+
+## 🚀 How to Use It
+
+### 1. From the Terminal (CLI Pipe via `ephbuf`)
+You can pipe command output directly into the running MCP server:
+
+```bash
+# Pipe any command output into the buffer
+pytest -v 2>&1 | ephbuf --label "pytest run"
+
+# Pipe git diffs directly
+git diff HEAD~3 | ephbuf --label "feature diff" --type diff
+
+# Or wrap command execution
+ephbuf --label "backend build" -- cargo build --verbose
+```
+
+The optional `--type`/`-t` hint accepts `auto` (the default), `diff`, `log`, or
+`text`. Use `diff` for unified patches when automatic detection is ambiguous;
+otherwise `auto` classifies diffs, build/test logs, and plain text from the
+content and label.
+
+`ephbuf` also bounds wrapped-command and piped-stdin capture with
+`--max-output-bytes`; it defaults to `EPHEMERAL_MAX_BUFFER_BYTES` or 50 MiB and
+retains the beginning and end of oversized output.
+Use `--timeout-seconds` to stop a wrapped command after a bounded runtime; timed
+out commands retain the output collected so far and exit with status 124.
+Requested `max_output_bytes` and `capture_file` `max_bytes` values may not
+exceed the configured buffer byte limit; the tools return a validation error
+instead of silently clamping them.
+
+### 2. From the AI Agent via MCP Tools
+
+The agent has access to the following tools:
+
+| Tool | Purpose |
+| :--- | :--- |
+| `execute_and_capture(command, cwd, label, content_type='auto', max_output_bytes=None, timeout_seconds=None)` | Executes a shell command with bounded head/tail capture, optional timeout, and a compact diagnostic summary (exit code, diff file map, error signals, and truncation status) to the agent context. |
+| `capture_text(content, label, content_type='auto')` | Ingests text directly into the buffer. |
+| `capture_file(file_path, label, content_type='auto', max_bytes=None)` | Ingests a bounded log/output file from disk; defaults to the configured buffer byte limit. |
+| `search_capture(query, mode, top_k, context_lines)` | Hybrid/BM25/Semantic search over the captured output. Returns matching chunks with surrounding context lines and exact line numbers. |
+| `get_capture_slice(start_line, end_line)` | Retrieves exact line ranges to inspect full stack traces, logs, or specific diff files. |
+| `get_capture_summary(capture_id)` | Diagnostic overview (line counts, diff file maps, error signals, preview). |
+| `get_buffer_stats()` | Reports aggregate capture count, content bytes, lines, chunks, embedding model readiness, embedding bytes, accounted bytes, and process RSS. |
+| `list_captures()` | Lists active captures in the ring buffer. |
+| `clear_captures(capture_id)` | Clears buffer. |
+
+For diff captures, `get_capture_summary` reports the detected file map,
+addition/deletion statistics, line ranges, and merge-conflict signals. Use
+`get_capture_slice` with those ranges to retrieve the complete file context.
+
+### 3. Capture Hygiene
+
+Keep captures focused so search results remain useful and the agent receives
+only the context it needs:
+
+- Capture one command or related output stream at a time, using a descriptive
+  label.
+- Start with `get_capture_summary`, then use `search_capture` or
+  `get_capture_slice` for targeted retrieval instead of repeatedly recapturing
+  the same output.
+- Use `clear_captures(capture_id)` when a capture is no longer needed; use
+  `clear_captures("all")` between unrelated investigations.
+
+The buffer is intentionally transient and bounded by the LRU capture limit,
+but explicit cleanup prevents recent investigations from obscuring the active
+one before automatic eviction occurs. Its memory metrics separate captured
+content and embedding bytes from process RSS; the unaccounted RSS value includes
+model, index, and Python object overhead and is approximate.
+
+The server defaults can be overridden with `EPHEMERAL_MAX_CAPTURES` and
+`EPHEMERAL_MAX_BUFFER_BYTES`. Session-aware launchers can set
+`EPHEMERAL_SESSION_ID` so each server/CLI pair automatically derives a unique
+socket path; `EPHEMERAL_SOCKET_PATH` remains an explicit override. The byte
+limit accounts for
+captured UTF-8 content; `get_buffer_stats` also reports embedding model
+readiness, embedding/cache settings, and process memory separately.
+`execute_and_capture` retains the beginning and end of oversized command
+output and marks the capture with its original byte count.
+
+See [OPERATIONS.md](OPERATIONS.md) for deployment settings, troubleshooting,
+release verification, and repository maintenance procedures.
+
+---
+
+## 🛠 Testing the Server
+
+Set up a local development environment from a fresh checkout:
+
+```bash
+python3 -m venv .venv
+.venv/bin/python -m pip install -r requirements-dev.txt
+```
+
+Run the test suite:
+```bash
+.venv/bin/python -m unittest test_engine.py test_capture_utils.py test_config.py test_cli.py test_server.py
+.venv/bin/python -m unittest test_e2e_pipe.py
+```
+
+Measure focused-test coverage locally:
+```bash
+.venv/bin/python -m coverage run --source=. --omit='test_*.py,benchmark_concurrency.py' -m unittest test_engine.py test_capture_utils.py test_config.py test_cli.py test_server.py
+.venv/bin/python -m coverage report
+```
+The current focused-test baseline is 82%; CI enforces an 82% minimum and uploads
+the coverage reports for inspection.
+
+GitHub Actions runs the compile check, focused tests, and end-to-end test on
+Python 3.10 and 3.12 for pushes to `main` and pull requests. The FastEmbed
+model is loaded on the first capture or semantic search rather than during
+server import. Set `EPHEMERAL_EMBEDDING_MODEL` to select a compatible model and
+`EPHEMERAL_FASTEMBED_CACHE_DIR` to control its cache directory. The model cache
+is retained between CI runs to reduce startup time.
+It also builds the wheel and verifies the installed `ephbuf` entry point.
+CI audits the declared dependencies with `pip-audit` and fails if known
+vulnerabilities are found.
+CI resolves the runtime dependencies through `constraints.txt`; the direct
+pins are updated only after the full test matrix passes.
+
+Pushing a version tag such as `v0.1.1` runs the release workflow, which builds
+wheel and source distributions, validates their metadata, verifies the
+installed package, and uploads the artifacts for review. The tag must match
+the version in `pyproject.toml`.
+The workflow also uploads `SHA256SUMS`; verify a downloaded artifact with
+`sha256sum --check SHA256SUMS` from the directory containing the files.
+Release distributions also receive a GitHub build-provenance attestation.
+After the repository's `pypi` environment is configured with a PyPI trusted
+publisher, the workflow publishes the distributions to PyPI automatically.
+
+Run the concurrency benchmark:
+```bash
+.venv/bin/python benchmark_concurrency.py --captures 32 --workers 8
+```
+The benchmark accepts `--min-ingest-per-second` and `--min-reads-per-second`
+thresholds for regression checks. GitHub Actions runs it as an optional weekly
+or manually dispatched job and uploads the results; it is not part of the
+required pull-request checks.