-
Notifications
You must be signed in to change notification settings - Fork 0
Publish TROVE's privacy-first open-source surface #1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| cff-version: 1.2.0 | ||
| message: "If TROVE supports your work, please cite the software using these metadata." | ||
| title: "TROVE" | ||
| type: software | ||
| authors: | ||
| - name: "TROVE contributors" | ||
| repository-code: "https://github.com/JNHFlow21/trove" | ||
| url: "https://github.com/JNHFlow21/trove" | ||
| license: Apache-2.0 | ||
| version: 1.0.0 | ||
| date-released: 2026-08-09 | ||
| keywords: | ||
| - agent memory | ||
| - MCP | ||
| - local-first | ||
| - privacy-preserving | ||
| - evidence retrieval | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,82 +1,206 @@ | ||
| # TROVE | ||
| <p align="center"> | ||
| <strong>English</strong> · <a href="README.zh-CN.md">简体中文</a> | ||
| </p> | ||
|
|
||
| <h1 align="center">TROVE</h1> | ||
|
|
||
| <p align="center"> | ||
| <strong>Local-first, privacy-preserving memory and cited evidence for AI agents.</strong> | ||
| </p> | ||
|
|
||
| <p align="center"> | ||
| A macOS runtime that gives Codex, Claude Code, and other MCP clients bounded access to a local evidence Vault—without turning personal data into a cloud service. | ||
| </p> | ||
|
|
||
| <p align="center"> | ||
| <a href="https://github.com/JNHFlow21/trove/actions/workflows/ci.yml"><img src="https://github.com/JNHFlow21/trove/actions/workflows/ci.yml/badge.svg" alt="CI status"></a> | ||
| <a href="https://github.com/JNHFlow21/trove/actions/workflows/privacy-scan.yml"><img src="https://github.com/JNHFlow21/trove/actions/workflows/privacy-scan.yml/badge.svg" alt="Privacy scan status"></a> | ||
| <a href="https://www.apple.com/macos/"><img src="https://img.shields.io/badge/macOS-only-111111?logo=apple" alt="macOS only"></a> | ||
| <a href="https://www.python.org/"><img src="https://img.shields.io/badge/Python-3.11%2B-3776AB?logo=python&logoColor=white" alt="Python 3.11 or newer"></a> | ||
| <a href="LICENSE"><img src="https://img.shields.io/badge/license-Apache--2.0-111111.svg" alt="Apache License 2.0"></a> | ||
| </p> | ||
|
|
||
| <p align="center"> | ||
| <a href="https://github.com/JNHFlow21/trove/stargazers"><img src="https://img.shields.io/github/stars/JNHFlow21/trove?style=flat-square&label=stars" alt="GitHub stars"></a> | ||
| <a href="https://github.com/JNHFlow21/trove/forks"><img src="https://img.shields.io/github/forks/JNHFlow21/trove?style=flat-square&label=forks" alt="GitHub forks"></a> | ||
| <a href="https://github.com/JNHFlow21/trove/commits/main"><img src="https://img.shields.io/github/commit-activity/t/JNHFlow21/trove?style=flat-square&label=commits" alt="GitHub commit activity"></a> | ||
| <img src="https://visitor-badge.laobi.icu/badge?page_id=JNHFlow21.trove&left_text=README%20visits" alt="README visit counter"> | ||
| </p> | ||
|
|
||
| TROVE is not a general-purpose autonomous agent and it is not a hosted chat | ||
| database. It is a local capability runtime: external agents ask for recall, | ||
| search, context, or a controlled operation; TROVE returns a typed, size-bounded | ||
| result with citations and coverage metadata. | ||
|
|
||
| The product is **TROVE**. WeChat is one optional source Provider, not the | ||
| product identity. | ||
|
|
||
| ## Why TROVE | ||
|
|
||
| | Common approach | TROVE | | ||
| | --- | --- | | ||
| | Copy whole conversations into an agent prompt | Return only bounded evidence needed for the current task | | ||
| | Let every client open the database directly | One owner-only daemon coordinates each canonical Vault | | ||
| | Treat retrieved text as instructions | Treat messages, filenames, OCR, and transcripts as untrusted evidence | | ||
| | Give an agent ambient write or send authority | Separate requests from human approval and delivery policy | | ||
| | Hide partial retrieval behind a confident answer | Return citations, coverage, cursors, and typed errors | | ||
|
|
||
| ## Architecture | ||
|
|
||
| ```mermaid | ||
| flowchart LR | ||
| A["Codex / Claude Code / MCP client"] --> M["trove-mcp"] | ||
| O["Local operator"] --> C["trove CLI"] | ||
| M --> L["Shared client"] | ||
| C --> L | ||
| L -->|"trove/1 over owner-only Unix socket"| D["troved"] | ||
| D --> K["Capability catalog + dispatcher"] | ||
| K --> V["Private local Vault + indexes"] | ||
| K --> P["Verified source Provider"] | ||
| P --> W["Optional WeChat source"] | ||
| D --> R["Optional Reply Runtime — off by default"] | ||
| O -->|"exact local decision"| R | ||
| R --> P | ||
| ``` | ||
|
|
||
| There is no public network listener. One canonical Vault maps to one daemon. | ||
| The CLI and MCP adapter use the same protocol, catalog, validation, and | ||
| dispatcher, so the recovery path and agent path cannot silently diverge. | ||
|
|
||
| ## Core capabilities | ||
|
|
||
| TROVE is a macOS-only, local-private capability runtime. It returns bounded | ||
| cited evidence to external Agents and can optionally run a local Reply Runtime | ||
| that generates, reviews, and delivers replies through verified source | ||
| Providers. Reply delivery is disabled by default. MCP is the primary Agent | ||
| interface and the CLI is the recovery and operator interface. | ||
| - **Bounded recall and search** — result limits, response budgets, opaque | ||
| cursors, coverage metadata, and stable citations. | ||
| - **Local-first storage** — Vault data, indexes, caches, and operation journals | ||
| stay under an owner-controlled path outside this repository. | ||
| - **Agent-native MCP** — cumulative `standard`, `operations`, and `admin` packs; | ||
| use the smallest pack that completes the task. | ||
| - **Typed failure semantics** — retry only when `error.retryable` is true; | ||
| ambiguity and incomplete coverage are explicit. | ||
| - **Provider boundary** — source integrations implement a verified contract; | ||
| WeChat support is independently packaged. | ||
| - **Human-controlled actions** — approval decisions require an interactive | ||
| controlling terminal. MCP and background jobs cannot approve themselves. | ||
| - **Privacy gates** — synthetic fixture rules, current-tree scanning, full Git | ||
| history scanning with Gitleaks, and CI checks on every push and pull request. | ||
|
|
||
| The product is **TROVE**. WeChat support is an optional source Provider rather | ||
| than the product identity. | ||
| ## Quick start from source | ||
|
|
||
| ## Install | ||
| ### Requirements | ||
|
|
||
| From a verified release artifact directory: | ||
| - macOS | ||
| - Python 3.11 or newer | ||
| - Git | ||
|
|
||
| Clone the public source and install the lightweight base runtime: | ||
|
|
||
| ```bash | ||
| python3 -m venv "$HOME/.local/share/trove/runtime" | ||
| "$HOME/.local/share/trove/runtime/bin/pip" install ./trove_runtime-1.0.0-py3-none-any.whl ./trove_provider_*.whl | ||
| export PATH="$HOME/.local/share/trove/runtime/bin:$PATH" | ||
| trove version | ||
| git clone https://github.com/JNHFlow21/trove.git | ||
| cd trove | ||
| TROVE_RUNTIME_INSTALL_EXTRAS="" bash scripts/bootstrap_runtime.sh | ||
| ``` | ||
|
|
||
| Keep the artifact directory and Vault owner-only. Create or select a Vault, | ||
| then run the redacted health check. The explicit path avoids hidden discovery. | ||
| Create an owner-only Vault **outside** the source checkout and run the redacted | ||
| health check: | ||
|
|
||
| ```bash | ||
| export TROVE_VAULT_ROOT="$HOME/Trove/trove-vault" | ||
| mkdir -p "$TROVE_VAULT_ROOT" | ||
| chmod 700 "$TROVE_VAULT_ROOT" | ||
| trove --vault "$TROVE_VAULT_ROOT" doctor | ||
| .venv/bin/trove --vault "$TROVE_VAULT_ROOT" doctor | ||
| ``` | ||
|
|
||
| ## Connect MCP | ||
| The default macOS bootstrap additionally supports | ||
| `local-vision,local-embedding,zvec`. See [testing](docs/testing.md) before | ||
| installing optional local ASR, VLM, key-capture, or cloud-retrieval extras. | ||
|
|
||
| ### Connect an MCP client | ||
|
|
||
| Register `trove-mcp` through Agent Switch with these arguments: | ||
| Register the installed `trove-mcp` through | ||
| [Agent Switch](https://github.com/JNHFlow21/agent-switch) with: | ||
|
|
||
| ```text | ||
| --pack standard --vault $TROVE_VAULT_ROOT | ||
| ``` | ||
|
|
||
| Run `agent-switch doctor` before changing its central configuration and | ||
| `agent-switch reconcile` afterward. Do not hand-edit generated client configs. | ||
| The standard pack is sufficient for ordinary recall and search. | ||
|
|
||
| ## First call | ||
|
|
||
| Ask the Agent to call `trove_recall`, or use the exact CLI fallback: | ||
| Run `agent-switch doctor` before changing central tool configuration and | ||
| `agent-switch reconcile` afterward. Do not copy credentials into native client | ||
| configuration. Ask the agent to call `trove_recall`, or use the recovery CLI: | ||
|
|
||
| ```bash | ||
| trove --vault "$TROVE_VAULT_ROOT" recall --target "Example person" --limit 50 | ||
| .venv/bin/trove --vault "$TROVE_VAULT_ROOT" recall \ | ||
| --target "Example person" --limit 50 | ||
| ``` | ||
|
|
||
| The JSON envelope states `ok`, typed errors, citations, and coverage. Follow an | ||
| opaque cursor only when the requested coverage needs another page. | ||
| Follow a returned cursor only when the task needs more coverage. Stop on | ||
| complete coverage, `no_results`, or a terminal error. | ||
|
|
||
| ## Failure path | ||
| ## Privacy and safety boundary | ||
|
|
||
| Run `trove --vault "$TROVE_VAULT_ROOT" doctor`. Retry only when | ||
| `error.retryable` is true. For `ambiguous_target`, select one returned account. | ||
| For `approval_required`, stop: an Agent can request or inspect approval but only | ||
| a human at the controlling terminal can decide it. | ||
| The public repository contains source code, schemas, public documentation, and | ||
| synthetic tests only. It must never contain real chats, contacts, account IDs, | ||
| media, transcripts, OCR, provider payloads, local Vaults, logs, credentials, | ||
| machine-specific paths, or evidence from real runs. | ||
|
|
||
| See [MCP](docs/mcp.md), [operations](docs/operations.md), and the generated | ||
| [capability reference](docs/capability-map.md). Provider setup is separate; | ||
| see the [installed source Provider](docs/providers/wechat.md). The optional | ||
| Reply Runtime architecture and safety model are documented in | ||
| [Reply Runtime](docs/architecture/reply-runtime.md). | ||
| ```bash | ||
| ./scripts/trove-python scripts/privacy_scan.py . | ||
| ./scripts/trove-python scripts/check.py contract | ||
| gitleaks git --redact | ||
| ``` | ||
|
|
||
| ## Privacy boundary | ||
| The scanners are guardrails, not a substitute for human review. See | ||
| [Open-source privacy](PRIVACY.md) and the [Security Policy](SECURITY.md). | ||
|
|
||
| > [!IMPORTANT] | ||
| > The optional Reply Runtime is disabled by default. An agent may request or | ||
| > inspect approval, but only a human at the controlling terminal can decide an | ||
| > exact action. Live delivery requires a separate, explicit policy grant. | ||
|
|
||
| ## Repository map | ||
|
|
||
| | Path | Responsibility | | ||
| | --- | --- | | ||
| | `packages/trove_protocol` | Versioned `trove/1` schemas and wire contracts | | ||
| | `packages/trove_core` | Capability catalog, application services, search, Vault, safety boundaries | | ||
| | `packages/trove_daemon` | One local daemon per canonical Vault | | ||
| | `packages/trove_client` | Shared client used by every adapter | | ||
| | `packages/trove_mcp` | Primary stdio MCP interface for external agents | | ||
| | `packages/trove_cli` | Operator, recovery, diagnostics, and explicit approval interface | | ||
| | `packages/trove_provider_wechat` | Optional independently packaged WeChat Provider | | ||
| | `skills` | Outcome-oriented agent Skills and generated manifest | | ||
| | `scripts` | Build, test, privacy, release, benchmark, and migration gates | | ||
|
|
||
| ## Project activity | ||
|
|
||
| | Public signal | Live or latest owner-visible value | | ||
| | --- | ---: | | ||
| | Stars / forks / commits | Live badges above | | ||
| | README visits | Public counter above; may include bots and repeat visits | | ||
| | Unique repository visitors | **0** in the rolling 14-day GitHub Traffic window | | ||
| | Unique Git cloners | **15** (**21** total clones) in the rolling 14-day window | | ||
|
|
||
| <sub>Traffic snapshot: 2026-08-10. GitHub exposes clone and unique-visitor analytics only to maintainers, so those values are a dated, transparent snapshot rather than a token-backed public badge.</sub> | ||
|
|
||
| ## Documentation | ||
|
|
||
| - [Architecture](docs/architecture.md) | ||
| - [MCP packs and trust boundary](docs/mcp.md) | ||
| - [Capability reference](docs/capability-map.md) | ||
| - [Protocol](docs/protocol.md) | ||
| - [Provider SDK](docs/provider-sdk.md) | ||
| - [WeChat Provider](docs/providers/wechat.md) | ||
| - [Operations and recovery](docs/operations.md) | ||
| - [Testing](docs/testing.md) | ||
| - [Release model](docs/release.md) | ||
| - [Roadmap](docs/roadmap.md) | ||
|
|
||
| Real chat databases, exports, media, transcripts, provider payloads, secrets, | ||
| logs, and local Vault data do not belong in this repository. Tests and checked-in | ||
| evidence must be synthetic or explicitly source-safe. Run the privacy scanner | ||
| before every commit. | ||
| ## Contributing | ||
|
|
||
| See [open-source privacy](PRIVACY.md) and | ||
| [security policy](SECURITY.md). | ||
| Read [CONTRIBUTING.md](CONTRIBUTING.md) before opening a pull request. Privacy | ||
| regressions and changes that weaken the application or approval boundaries will | ||
| not be accepted. Please report vulnerabilities through GitHub private | ||
| vulnerability reporting rather than a public issue. | ||
|
|
||
| ## Contributing | ||
| ## License | ||
|
|
||
| See [CONTRIBUTING.md](CONTRIBUTING.md). TROVE is licensed under | ||
| [Apache License 2.0](LICENSE). | ||
| [Apache License 2.0](LICENSE) © 2026 TROVE contributors | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When this README is rendered by a client that fetches remote images directly rather than through GitHub's image proxy, every view contacts
visitor-badge.laobi.icu, disclosing the reader's IP address and request metadata to an unrelated tracking service. This undermines the privacy-first publication surface for local Markdown viewers, package indexes, and mirrors; remove the counter or replace it with a non-tracking, repository-controlled asset.Useful? React with 👍 / 👎.