内容
[](https://doi.org/10.5281/zenodo.21711455) [](https://github.com/Thru-Echoes/TRACE/actions/workflows/ci.yml) [](https://github.com/Thru-Echoes/TRACE/blob/main/LICENSE) [](https://github.com/Thru-Echoes/TRACE/blob/main/pyproject.toml)
# Why TRACE?
In the age of AI, how do we know *who* proposed *what* in a scientific or coding dev workflow? Was the idea for that methodological decision made by *AI* or by a *human*? And when decisions are proposed by AI, are they being accepted, rejected, or iterated on?
What does the solution to this look like?
<p align="center">
<img src="https://raw.githubusercontent.com/Thru-Echoes/TRACE/main/docs/provenance.svg" width="900" alt="Timeline of a real captured TRACE session: two decisions (one proposed by AI and accepted by a human, one still awaiting resolution), a discovery, two contributions attributed direction-human/execution-AI, a to-do, and a correction that retracts one of the contributions.">
</p>
Every row above is a real event from session `trace_20260730_32c108`, captured as
the work happened. Note what a diff could not have told you: one decision is
still **awaiting resolution** because the AI is not permitted to resolve its own
proposal, and the last event **retracts** an earlier contribution that turned out
to be wrong. Regenerate it from any session with
`python3 scripts/make_provenance_animation.py <session.json>`.
**One sentence from you, fully-scoped session from Claude:**
<p align="center">
<img src="https://raw.githubusercontent.com/Thru-Echoes/TRACE/main/docs/trace-use-case-3.png" width="650" alt="Claude Code: a single prompt — 'start a TRACE session and review the current manuscript for submission readiness' — produces auto-recalled learnings and a five-item task plan.">
</p>
1. From inside `TRACE/`, ask Claude to start a session and review the manuscript (which is inside sibling dir, `TRACE-research/`).
2. Past-session memory makes Claude pivot to that sibling repo before logging anything.
3. `trace_start_session` runs there, learnings auto-recall, and a five-item task plan emerges.
## **TRACE: Transparent Recording of AI-assisted Collaboration Experiments**
TRACE is an MCP server that provides a standardized audit trail for AI-assisted research workflows. It records tool calls, decisions, annotations, contributions, and actor attribution — who proposed what, who accepted or revised it, and why.
TRACE runs as a **sidecar** alongside your domain MCP servers. It doesn't proxy or intercept calls — the AI client explicitly logs events to TRACE, creating a complete, human-readable provenance record.
> **New here?** [docs/ONBOARDING.md](https://github.com/Thru-Echoes/TRACE/blob/main/docs/ONBOARDING.md) is the map for a developer or a user — the mental model, the attribution rules, project identity, hooked-vs-bare projects, and the dev workflow. [docs/WHAT-IS-TRACE.md](https://github.com/Thru-Echoes/TRACE/blob/main/docs/WHAT-IS-TRACE.md) explains the same thing without assuming a technical background.
**Version:** 0.5.2.dev0 (unreleased; latest release v0.5.1) | **Spec:** v0.5.1 | **Schema:** `https://trace-protocol.org/v0.3` | **License:** Apache 2.0
> The schema URI is an identifier (per W3C PROV convention) and is not currently a resolvable URL. The machine-readable JSON Schema lives at [`schemas/trace-v0.5.json`](https://github.com/Thru-Echoes/TRACE/blob/main/schemas/trace-v0.5.json) in this repository.
**New in 0.5.1 — decision confidence.** Additive; every earlier session loads unchanged. A decision may now carry the measurement that motivated it as a typed `confidence` object — the estimate, an interval and its nominal coverage, the method, the sample size, and digest-bound evidence references — checked on construction, in the published schema, and by `trace-mcp validate`. It types the *measurement* only: a producer's own decision rule is preserved beside it under a `contract` key and never interpreted, because encoding one producer's rule in a generic protocol would refuse every producer with a different one. The release also adds a Streamable HTTP transport, an importer for Gents run timelines, and `trace-mcp doctor` / `fleet-check`, which check a *deployment* rather than the source tree.
**New in 0.5.0 — canonical project identity.** Additive; every v0.3.x and v0.4.x session loads unchanged. A project is identified by a stable canonical key rather than a free-text label, so case and separator variants of one name stop reading as separate projects, and two genuinely different projects can no longer be merged by a case-insensitive filesystem. A `TRACE_PROJECT` pin binds one server process to one project, and cross-project reads and writes fail closed. No capture record is ever rewritten — a mislabelled project is repaired by adding an alias.
See [CHANGELOG.md](https://github.com/Thru-Echoes/TRACE/blob/main/CHANGELOG.md) for the full entry and for 0.4.x, which added the Proposer Identity Rule, the `discovery` annotation category, URI-form corrections, and `host` / `parent_event_id` on tool calls. Design rationale lives in [the ADRs](https://github.com/Thru-Echoes/TRACE/tree/main/docs/adr); worked examples in [docs/examples.md](https://github.com/Thru-Echoes/TRACE/blob/main/docs/examples.md).
## Why decision provenance?
Existing AI observability stacks (LangSmith, Langfuse, OpenTelemetry GenAI semconv) capture **call-level** traces — what tool an agent called, with what inputs, and what came back. They do not capture **decision-level provenance** — who proposed each step, whether a human reviewed it, what alternatives were rejected. The cost is visible in practice: in a preliminary rubric audit of agentic-AI deployments in environmental science, *analytical* decision provenance scored markedly lower than basic workflow description, and several recently-published papers showed discrepancies such as model details that did not match the cited models, or analyses that could not be reproduced from the reported description.
The need is also moving from norm to regulation. The **EU AI Act** (Articles 12, 19; high-risk obligations deferred by the Digital Omnibus, in force July 2026, to December 2, 2027 for Annex III systems and August 2, 2028 for Annex I products), **California SB 942 (Transparency AI Act)** (applicable August 2, 2026), **Colorado SB 24-205** (effective June 30, 2026), the **FDA PCCP final guidance** (December 2024), the **NIST AI Risk Management Framework**, and **ISO/IEC 42001:2023** all require some form of decision-process documentation. TRACE is designed so that documentation is a workflow byproduct, not an after-the-fact compilation.
## Core concept: the decision chain
Every TRACE decision carries an **actor** (who proposed, who resolved), a **disposition** (proposed → accepted / revised / rejected), a **rationale**, a **suggestion_type** (proactive / requested / collaborative), and an optional `revises_event_id` linking to a prior decision. Decisions form a provenance DAG, not a flat log — a future reader can reconstruct who proposed what, why it landed where it did, and how the approach evolved during the session.
<p align="center">
<img src="https://raw.githubusercontent.com/Thru-Echoes/TRACE/main/docs/trace-example-corp-sus-extractor-2.png" width="560"
alt="Three TRACE events from a corp-sus-report-extractor session: a human-accepted decision, an AI-proposed alternative logged after rejection, and a correction annotation linking back to the rejection.">
</p>
Three events from a real `corp-sus-report-extractor` session: a human-proposed scope decision (`evt_002`, accepted), an AI-proposed alternative kept for provenance after rejection (`evt_003`), and a correction annotation linked to the rejection via `corrects_event_ids` (`evt_004`). Rejected alternatives and corrections are first-class events — they don't get discarded.
## Preliminary deployment results
Between 2026-03-18 and 2026-07-30, TRACE was used across **7 sustained research and development projects**:
| Project | Domain | Sessions | Decisions | Contributions | Corrections |
|---|---|---:|---:|---:|---:|
| trace-mcp (self-host / meta) | Protocol research | 89 | 132 | 206 | 26 |
| corp-sus-report-extractor | Corporate sustainability disclosure | 54 | 91 | 132 | 18 |
| REAP | Environmental discourse analysis | 38 | 65 | 112 | 18 |
| When-Algorithms-Meet-Artists | Computational art / cultural studies | 31 | 56 | 95 | 5 |
| trace-research | Manuscript / literature synthesis | 30 | 48 | 76 | 18 |
| waggle | Applied agentic tooling | 24 | 31 | 76 | 6 |
| green-narrative | Environmental narrative analysis | 23 | 38 | 40 | 8 |
| **Total** | | **289** | **461** | **737** | **99** |
Decisions: **68% AI-proposed / 32% human-proposed**. Of the 344 *resolved* decisions, 89% accepted, 7% revised, 4% rejected; a further 117 remain in the `proposed` state, because an AI may not resolve its own proposal and not every proposal gets answered. The acceptance rate is not rubber-stamping — the 23 revisions, 15 rejections, and 99 separately-logged corrections are the active human steering this protocol exists to surface, and each one is an alternative that a commit history would have discarded.
Contributions: **68% human-directed, 24% collaborative, 8% AI-directed**; 65% are human-directed *and* AI-executed. Pure AI-directed-and-executed work is a small minority. The dominant pattern is human direction with AI execution — which existing authorship and attribution norms cannot describe.
> **What these counts include.** Figures were taken on 2026-07-30 from per-session logs in `~/.trace/sessions/`, which are not committed here (they contain project-internal content), and cover the seven named projects only. The store also holds meeting-transcription namespaces, throwaway test keys, and short exploratory sessions; those are excluded, since a transcript namespace accumulates thousands of machine-written annotation events and no decisions, and counting them would inflate a raw event total by more than an order of magnitude without adding a single act of provenance. Counts here are the deliberately logged event types. Sessions recorded before v0.5 under the display label `TRACE` are counted under `trace-mcp`, which is the same project under its canonical key. Reproducible from those logs via `trace_project_summary`; an aggregated, de-identified export can be provided on request.
## Architecture
```
AI Client (any MCP-aware client: Claude Code, Cursor, ChatGPT, Codex, ...)
|
+-- connects to: Domain MCP Server(s)
| (corpus search, NLP pipeline, data retrieval, etc.)
| --> does the actual work
|
+-- connects to: TRACE MCP Server (this project)
--> records what happened to JSON files
--> persists learnings across sessions (trace-learn)
```
**Storage model:** One self-contained JSON file per session in `~/.trace/sessions/`. Files are human-readable (pretty-printed with `indent=2`), git-diffable, and shareable.
**Core stack:** Python 3.11+, Pydantic v2, async throughout, zero external dependencies beyond `mcp` and `pydantic` (OpenAI optional for LLM-enhanced features).
## Quick Start
> **⚠️ TRACE is not on PyPI.** The PyPI package named `trace-mcp` is an
> unrelated project — `pip install trace-mcp` installs someone else's code.
> Install from a clone of this repository (below), or point `uvx --from` at a
> local checkout or a pinned VCS source:
>
> ```bash
> uvx --from 'git+https://github.com/Thru-Echoes/TRACE.git@v0.5.1' trace-mcp
> ```
### Install
```bash
uv pip install -e ".[dev]"
```
### Configure your MCP client
Add to your project's `.mcp.json`:
```json
{
"mcpServers": {
"trace": {
"command": "uvx",
"args": [
"--from", "/path/to/TRACE",
"--with", "openai", "--with", "numpy", "--with", "model2vec",
"--refresh-package", "trace-mcp", "trace-mcp"
],
"env": { "TRACE_PROJECT": "your-project-key" }
}
}
}
```
Using `uvx` builds the package into an isolated environment, avoiding `.venv` breakage from Python upgrades. `--refresh-package` rebuilds TRACE from the source tree on the next server start, without re-resolving the whole dependency set each time.
Two parts of that config are easy to omit and worth keeping:
- **The three `--with` packages are what make this a 22-tool server.** They are the optional dependencies of the trace-learn extension. Without them the server still starts and still records provenance, but the extension does not load and you get the 17 core tools with no error to tell you why.
- **`TRACE_PROJECT` pins the process to one project.** With it set you omit `project` from `trace_start_session`, and cross-project reads and writes fail closed. Without it, pass `project="..."` explicitly on every session start — an unpinned server rejects the call rather than guessing.
### Serve over Streamable HTTP
The config above spawns TRACE as a stdio subprocess, which is what editor-style
clients do. A client that instead connects to an endpoint it did not spawn (an
agent runtime with an MCP service registry, or any consumer that outlives one
editor session) needs the HTTP transport:
```bash
trace-mcp --transport streamable-http --port 8765 # serves http://127.0.0.1:8765/mcp
```
`--host` (default `127.0.0.1`) and `--port` (default `8765`) apply only to this
transport. Plain `trace-mcp` still serves stdio, and an unknown flag or
transport exits non-zero rather than falling back to stdio while an HTTP
consumer waits on a socket that never opens.
Two things to know before pointing a runtime at it:
- **There is no authentication layer.** Anything that can reach the port can
write to your session store, so keep the bind on loopback unless the host is
isolated by other means. A non-loopback bind logs a warning at startup.
- **Pass `session_id` on every call** when more than one client shares the
endpoint. The process keeps a single current-session pointer (see [Known
limitations](#known-limitations)), so concurrent clients that rely on it
interleave into one session. One server instance per consumer avoids the
question entirely.
[docs/integrations/gents.md](https://github.com/Thru-Echoes/TRACE/blob/main/docs/integrations/gents.md)
works this through end to end for one such runtime, including what to put in the
agent's prompt so it knows what is worth recording.
[docs/integrations/decision-log.md](https://github.com/Thru-Echoes/TRACE/blob/main/docs/integrations/decision-log.md)
covers the other importer, `trace-mcp import decision-log`, which builds a session
from an evaluation gate's decision log — the records that carry a measured
`confidence` block on each decision.
### Install hooks
`trace-mcp-init` installs the host-side enforcement: hook scripts under `.claude/hooks/`, registrations merged into `.claude/settings.json`, and a marker block appended to `CLAUDE.md`.
```bash
trace-mcp-init # auto-detect host (default)
trace-mcp-init --client claude-code # explicit
trace-mcp-init --dry-run # preview, no writes
```
The Claude Code adapter installs four hooks:
| Hook | Event | Purpose |
|------|-------|---------|
| `session-reminder.sh` | `SessionStart` | Reminds you to start a TRACE session if one isn't active for the current project. Project detection: `.claude/trace.project` → `CLAUDE.md` → git repo basename → cwd basename. |
| `prompt-reminder.sh` | `UserPromptSubmit` | Periodic nudge after several prompts without a session. Per-project rate-limited. |
| `pretool-guard.sh` | `PreToolUse` (`Edit\|Write`) | Warns (or blocks) edits when no TRACE session is active. |
| `decision-audit.sh` | `PostToolUse` (`mcp__trace__trace_end_session`) | Echoes the session-end attribution audit into the conversation. The matcher is the FULL namespaced tool name — a host matches tool names exactly, so a bare `trace_end_session` never fires. |
Project detection uses, in order: the `.claude/trace.project` pin file written by `trace-mcp-init`, a `TRACE project name: "..."` line in `CLAUDE.md` (bold form accepted), the git repository basename, then the current working directory basename. Add the explicit marker if your repo name differs from the project name you want logged.
**Codex** support is scaffolded as a placeholder; see [`src/trace_mcp/adapters/codex/README.md`](https://github.com/Thru-Echoes/TRACE/blob/main/src/trace_mcp/adapters/codex/README.md) for the hook primitives a Codex adapter would need.
Worked examples for logging decisions, corrections, contributions, and decision chains live in [`docs/examples.md`](https://github.com/Thru-Echoes/TRACE/blob/main/docs/examples.md).
#### Hook environment variables
| Variable | Default | Effect |
|---|---|---|
| `TRACE_GUARD` | `soft` | `pretool-guard.sh` mode: `off` (no-op), `soft` (warn-only), `strict` (exit 2 to block when no session is active). |
| `TRACE_PROMPT_MIN_TURNS` | `3` | Minimum prompt turns before `prompt-reminder.sh` will nudge. |
| `TRACE_PROMPT_COOLDOWN_SEC` | `300` | Wall-clock cooldown between nudges from `prompt-reminder.sh`. |
| `TRACE_RUNTIME_DIR` | `~/.trace/runtime` | Per-project nudge state (`<project>.state.json`). Safe to delete to reset. |
| `TRACE_SOURCE_PATH` | _unset_ | Override what `trace-mcp-init` writes into `.mcp.json` as `uvx --from <X>`. Set to a local TRACE clone path. **Required when running init from an installed wheel** — with no override, init fails closed rather than writing the PyPI name `trace-mcp`, which belongs to an unrelated package (dependency confusion). |
### Verify the deployment
A green test suite proves the *source tree* is correct. It cannot prove that a *deployed* project is: hook copies drift a release behind, a matcher stops firing, a pin goes missing, a package cache serves a stale build. `trace-mcp doctor` checks one project directory against the artifacts the installed build actually ships.
```bash
trace-mcp doctor # check the current directory
trace-mcp doctor /path/to/proj # check another project
trace-mcp doctor --live # also start the configured server and verify what it serves
trace-mcp doctor --json # machine-readable report (stable check ids)
```
Exit codes: `0` clean, `1` findings, `2` usage error — a bad path is not an unhealthy project, and diagnostics go to stderr so `--json` stdout is always a report or empty. What it checks:
| Group | Checks |
|---|---|
| `config.*` | `.mcp.json` parses and declares a `trace` server; launched with `uvx`; the `--from` source is something uvx can build (and is not the unrelated PyPI distribution name); the args actually name `trace-mcp` as the command to run; the three trace-learn `--with` extras are present; `--refresh-package trace-mcp` is set. |
| `hooks.*` | Every shipped hook script is installed, executable, and carries this build's `[trace-hooks vX.Y]` stamp; no TRACE-stamped leftovers from an older release remain; `settings.json` parses; every hook is registered **under its own host event**; the decision-audit hook uses the namespaced matcher that actually fires. |
| `pin.*` | The pin file, the `.mcp.json` `TRACE_PROJECT` env pin, and the CLAUDE.md pin line all exist and canonicalize to one project key. |
| `live.*` | With `--live` only: the project's own configured command starts, completes an MCP handshake, reports this build's version, and serves all 22 tools. |
`--live` is opt-in because it **runs the command the project's `.mcp.json` declares** — an action, not an inspection. It is the only check that catches a project whose config, hooks, and pins are all correct while the running server is a stale build; a warm `uv` cache can serve an old wheel for minutes even with `--refresh-package`, and the finding names the remedy (`uv cache clean trace-mcp`, then restart the server).
### Sweep every project
`trace-mcp fleet-check` runs the doctor over every project declaring a TRACE server under the roots you give it, and rolls the failures up by check — the view that turns "23 projects are broken" into "one fix, applied 23 times".
```bash
trace-mcp fleet-check ~/code ~/work # sweep these roots
TRACE_FLEET_ROOTS=~/code trace-mcp fleet-check
trace-mcp fleet-check ~/code --json # per-project reports + totals
```
```
fleet-check: 1/24 project(s) clean
FAIL /path/to/project (3 finding(s))
hooks.stamp: installed hook version differs from this build's [trace-hooks v0.5] ...
fleet-check: failing checks, most widespread first
23 project(s) pin.trace_project_file
14 project(s) hooks.decision_audit_matcher
```
No path is compiled in: with no roots and no `TRACE_FLEET_ROOTS`, the command exits `2` rather than guessing a directory to sweep — a checker that assumes one machine's layout would silently survey nothing on another and report a healthy fleet. The walk is depth-capped, skips dependency and VCS directories, does not follow symlinks, and reports a project once however many roots reach it. A root or `.mcp.json` that cannot be read is reported and makes the sweep non-clean, since a partial survey is not a clean bill of health.
`--live` applies the doctor's live probe to every project found — which means **running the server command each of those projects declares**. Because a sweep reaches directories you never named one by one, the first `--live` only lists the commands it would run; adding `--yes` executes them. `--max-depth` raises the walk limit, and the number of branches left un-descended is reported rather than silently omitted.
A finding is `pass`, `fail`, or `skip` — where `skip` means *not evaluated* and always names the upstream check that made evaluation impossible. Exactly one check fails per root cause.
The hook checks describe the Claude Code deployment, which is the only host adapter that installs today. A project set up with `--client none` has no hooks by construction and reports the `hooks.*` checks as failures — deliberately: an MCP server without host-side enforcement is a real gap in the audit trail, not a supported configuration to be waved through.
### Run a first session
Once configured, TRACE tools are available to the AI client:
```
You: "Start a TRACE session for our climate NLP analysis"
Claude: -> trace_start_session(project="climate-nlp", ...)
"Session started: trace_20260205_a1b2c3"
"Relevant learnings from past sessions:
- [correction] Always use ml-dev conda env, not base (relevance: 87%)"
You: "Search for adaptation passages in the IPCC corpus"
Claude: -> [calls corpus-search-mcp/search_passages]
-> trace_log_tool_call(server="corpus-search-mcp", ...)
-> trace_propose_decision(description="Focus on chapters 14-17", ...)
You: "Also include chapter 6"
Claude: -> trace_resolve_decision(disposition="revised", ...)
You: "End the session"
Claude: -> trace_end_session(summary="Analyzed 47 passages...")
(learnings auto-extracted and persisted for future sessions)
```
## Available tools (22 total)
### Core tools (17)
| Tool | Description |
|------|-------------|
| `trace_start_session` | Start a new audit session (auto-recalls relevant past learnings) |
| `trace_end_session` | End a session with summary (auto-extracts learnings) |
| `trace_log_tool_call` | Record a tool invocation on another MCP server |
| `trace_log_annotation` | Record a learning, gotcha, correction, observation, todo, or question |
| `trace_log_contribution` | Record a deliverable with direction (who had the idea) vs execution (who did the work) attribution |
| `trace_log_state_change` | Record an environment or configuration change |
| `trace_propose_decision` | Propose a methodological decision (with `suggestion_type`: proactive/requested/collaborative) |
| `trace_resolve_decision` | Accept, revise, or reject a proposed decision |
| `trace_get_session` | Get session metadata |
| `trace_get_events` | List events (filterable by type) |
| `trace_get_decisions` | List decisions (filterable by disposition and/or `proposed_by_type`) |
| `trace_get_decision_chain` | Walk linked decision revisions via `revises_event_id` |
| `trace_search` | Search events by text content |
| `trace_export` | Export as JSON, Markdown, or PROV JSON-LD |
| `trace_list_sessions` | List all sessions (filterable by project) |
| `trace_project_summary` | Aggregated metrics across all sessions for a project |
| `trace_health_check` | System health and event-level statistics |
### Extension: trace-learn (5) — default for new sessions
| Tool | Description |
|------|-------------|
| `trace_learn_recall` | Find relevant past learnings via text similarity and tag matching |
| `trace_learn_add` | Manually add a learning to the knowledge store |
| `trace_learn_list` | List all learnings (optionally filtered by category) |
| `trace_learn_forget` | Remove a learning by ID |
| `trace_learn_extract` | Extract learnings from session events (annotations, rejected decisions, contributions) |
## Event types
| Type | Description | Key Fields |
|------|-------------|------------|
| **tool_call** | Invocation of an MCP server, host-internal helper, or external tool | server, name, input, output, status, `retries_event_id`, **`host`** (v0.4.1: `mcp`/`internal`/`external`), **`parent_event_id`** (v0.4.1: links dispatched child to controller) |
| **decision** | Methodological decision with attribution | description, rationale, disposition, `suggestion_type`, `revises_event_id` |
| **annotation** | Learning, gotcha, correction, observation, todo, question, **discovery** (v0.4.1) | category, content, `corrects_event_ids` (v0.4.1: MAY use URI-form schemes `external:`, `jsonl:`, `subagent:`, `tool-result:`) |
| **state_change** | Environment or configuration change | description, field, old_value, new_value |
| **contribution** | Work product with direction/execution attribution | description, direction, execution, artifact, `related_decision_ids` |
## Knowledge persistence (trace-learn)
The default `trace-learn` extension surfaces relevant past learnings at session start, on-demand via `trace_learn_recall`, and when decisions are proposed — and auto-extracts new learnings at session end. Matching uses cloud LLM scoring only when explicitly opted in (`TRACE_LLM_ENABLED=true` plus an `OPENAI_API_KEY` in the project's `.env`), with BM25 fallback otherwise — and a fallback caused by a missing or refused key is reported rather than passed off as a result. Storage: `~/.trace/knowledge/{project_key}.json`, named by the canonical project key rather than the display label (env: `TRACE_KNOWLEDGE_DIR`).
See [`docs/extensions/trace-learn.md`](https://github.com/Thru-Echoes/TRACE/blob/main/docs/extensions/trace-learn.md) for matching backends, BM25 stemming, per-backend thresholds, extraction details, and LLM configuration.
## Configuration
### Where configuration is read from
TRACE reads settings from three sources, highest priority first:
1. an environment variable already exported in the process
2. **`./.env` — this project's own file**, read from the directory the host launches the MCP server in
3. `~/.trace/.env` — machine-wide defaults
**The OpenAI API key belongs in the project's own `.env`.** Each project gets its own credential, so one leaked or exhausted key exposes one project rather than every project on the machine — the same isolation TRACE gives sessions and knowledge stores, applied to the credential that reaches a third party. `.env` is gitignored; [`.env.example`](https://github.com/Thru-Echoes/TRACE/blob/main/.env.example) is the committed template. `~/.trace/.env` still works as a fallback for projects that have not been given a key, and TRACE says so at session start rather than letting a project quietly borrow the shared one.
One setting does not follow that order. **`TRACE_LOCAL_ONLY` is a restrict-only ratchet**: any source can turn the no-egress kill switch *on*, and none can turn it *off*. Without that exception, a project `.env` could opt out of a machine-wide privacy policy.
Configuration is read **once, at server start** — restart the MCP server after editing a `.env`.
#### When the key is missing or refused
A cloud call attempted with no key, or with a key the provider rejects, is reported loudly — never quietly downgraded:
- **No key, cloud path requested** → the `trace_start_session` banner and every affected `trace_learn_*` response carry a warning naming the three places searched and the file to fix. Recall still answers, on local keyword matching, and says so.
- **Key rejected (401/403)** → an explicit error, *regardless* of `TRACE_STRICT_LLM`. Strict mode governs whether degradation is acceptable, not whether you are told your credential was refused. The key is scrubbed from the message.
- **Key borrowed from `~/.trace/.env`** → a session-start notice, since a project silently using the machine-wide credential is the thing per-project keys exist to prevent.
- **Configured backend cannot be built** → the extension still registers, with keyword matching and a notice on every recall. It never disappears silently: an extension that fails to register looks identical to one that was never installed.
### Environment variables
| Variable | Default | Description |
|----------|---------|-------------|
| `TRACE_PROJECT` | _unset_ | Pins the server process to one project key. With it set, `project` is optional on `trace_start_session` and cross-project reads and writes fail closed. Unset, the call requires an explicit `project`. |
| `TRACE_REQUIRE_PIN` | `false` | Set `1` to refuse **both** session-creation paths on an unpinned process, including the implicit auto-create a logging call would otherwise perform. |
| `TRACE_ALLOW_CROSS_PROJECT_READS` | `false` | Set `1` to let a pinned server read other projects. Off by default; writes stay refused regardless. |
| `TRACE_DEFAULT_PROJECT` | `auto` | Quarantine key used when a session is auto-created with no project available. |
| `TRACE_REGISTRY_PATH` | `~/.trace/projects.json` | Canonical-key alias registry. |
| `TRACE_LOCK_TIMEOUT` | `15` | Seconds to wait for the knowledge-store lock before failing closed. |
| `TRACE_LOCAL_ONLY` | `false` | No-egress kill switch. **Ratchets**: any source may set it `true`; none may set it `false` over a source that set it `true`. |
| `TRACE_SESSIONS_DIR` | `~/.trace/sessions/` | Directory for session JSON files |
| `TRACE_KNOWLEDGE_DIR` | `~/.trace/knowledge/` | Directory for trace-learn knowledge stores |
| `TRACE_EGRESS_LOG` | `~/.trace/egress.jsonl` | Cloud-egress ledger: one JSONL line per cloud call trace-learn makes (the fact of the call — provider, endpoint, model, purpose, item count — never the content) |
| `TRACE_LOG_LEVEL` | `INFO` | Logging verbosity |
| `OPENAI_API_KEY` | — | OpenAI API key for LLM matching, extraction, and cloud embeddings. **Put it in this project's `.env`** — see above; `~/.trace/.env` is a fallback, not the home for it |
| `TRACE_LLM_MODEL` | `gpt-5.4-mini` | Model for LLM relevance scoring |
| `TRACE_LLM_EXTRACTION_MODEL` | `gpt-5.4-mini` | Model for LLM learning extraction |
| `TRACE_LLM_ENABLED` | `false` | Cloud LLM matching/extraction is opt-in: set `true` (with `OPENAI_API_KEY`) to enable |
| `TRACE_STRICT_LLM` | `true` if key set, else `false` | Fail loudly on LLM errors instead of silent BM25 fallback |
| `TRACE_BM25_K1` | `1.5` | BM25 term frequency saturation parameter |
| `TRACE_BM25_B` | `0.75` | BM25 document length normalization parameter |
| `TRACE_TAG_WEIGHT` | `0.3` | Weight given to tag overlap in scoring (0.0–1.0) |
| `TRACE_DECAY_ENABLED` | `true` | Enable time-based decay for learning scores |
| `TRACE_DECAY_HALF_LIFE_DAYS` | `365.0` | Half-life for exponential decay (days) |
| `TRACE_EVERGREEN_RECALL_THRESHOLD` | `3` | Recalls needed for evergreen floor protection |
| `TRACE_EVERGREEN_FLOOR` | `0.8` | Minimum decay multiplier for evergreen learnings |
| `TRACE_DEDUP_ENABLED` | `true` | Enable content deduplication on add |
| `TRACE_DEDUP_THRESHOLD` | `0.85` | Jaccard similarity threshold for dedup |
## Export formats
- **JSON** — The native session file. Always available, always complete.
- **Markdown** — Human-readable summary with decision log, tool call table, annotations, and statistics.
- **PROV JSON-LD** — W3C PROV-compatible provenance graph for interoperability with other provenance systems.
## Specification
TRACE implements the **Decision Provenance for AI-Assisted Workflows** specification — a technology-agnostic standard defining what to record when humans and AI collaborate on research.
| Artifact | Location | Role |
|----------|----------|------|
| **Specification** | [`docs/specification.md`](https://github.com/Thru-Echoes/TRACE/blob/main/docs/specification.md) | Authoritative definition of the data model, semantics, and conformance rules. Technology-neutral. |
| **JSON Schema** | [`schemas/trace-v0.5.json`](https://github.com/Thru-Echoes/TRACE/blob/main/schemas/trace-v0.5.json) | Machine-readable formalization. Any JSON document validating against this schema is a conforming session document. |
| **Reference implementation** | This repository (`trace-mcp`) | An MCP server that produces conforming documents. One possible implementation — not the only one. |
The specification defines five event types (tool invocations, decisions, annotations, state changes, contributions), a decision lifecycle model (proposed / accepted / revised / rejected), and an actor taxonomy (human / ai / system). Any tool that produces JSON documents conforming to the schema implements the standard — no dependency on MCP, Python, or TRACE itself.
Validate session documents against the schema (the schema ships inside the package; `jsonschema` is provided by the `[validate]` or `[all]` extra):
```bash
trace-mcp validate ~/.trace/sessions/trace_*.json
```
Regenerate the schema from models: `python scripts/generate_schema.py` (writes the top-level spec artifact and the byte-identical packaged copy).
## File structure
```
src/trace_mcp/
server.py # MCP server entry point (FastMCP) + extension loader
project_identity.py # Canonical project keys + alias registry
identity_cli.py # `trace-mcp identity` migration subcommands
identity_report.py # Read-only drift and stray-store reporting
conformance/ # `trace-mcp doctor` / `fleet-check`: deployed-state checks (INV-11)
init_project.py # `trace-mcp-init`: .mcp.json, pin, adapter dispatch
validate.py # `trace-mcp validate` schema conformance CLI
scratchpad.py # Session-end scratchpad generator
extension_hooks.py # Hook registry for extension ↔ core integration
schema/ # Pydantic v2 models (Session, TraceEvent, etc.)
schemas/ # Packaged JSON Schema copy
storage/ # Abstract interface, JSON file backend, locked writes
tools/ # MCP tool implementations
exporters/ # Markdown and PROV JSON-LD exporters
extensions/learn/ # trace-learn (default extension)
adapters/ # Host adapters (claude_code, codex)
claude_code/ # Hook scripts, settings template, CLAUDE_BLOCK
codex/ # Placeholder spec for a Codex adapter
docs/
specification.md # Authoritative protocol spec
examples.md # Worked logging examples
INVARIANTS.md # Correctness invariants, site sets, enforcing tests
adr/ # Architecture Decision Records
extensions/ # Extension documentation
```
The host-adapter layer is a pure installer; core has zero imports from `adapters/`. Adapters run only at `trace-mcp-init` time.
## Known limitations
- **One in-memory session cache per process** — `server.py` holds a single `active_sessions` dict, so a server process is designed for one AI client. Concurrent clients want separate server instances. This is a caching limit, not a durability one: every session write goes through a per-session lock and re-reads authoritative disk state first, so concurrent processes do not lose each other's updates.
- **File-based storage only** — All data is stored as JSON files. There is no database backend. Large-scale deployments would need a database adapter against the `TraceStorage` abstract interface.
- **LLM matching is optional** — Without an OpenAI API key, knowledge recall uses BM25 (keyword-based). Semantic similarity requires LLM configuration.
## Citation
Archived on Zenodo. Cite the **concept DOI** unless you need to pin a specific archive — it always resolves to the most recent version:
[](https://doi.org/10.5281/zenodo.21711455)
```bibtex
@software{muellerklein_trace,
author = {Muellerklein, Oliver},
title = {{TRACE: Transparent Recording of AI-assisted Collaboration Experiments}},
year = {2026},
publisher = {Zenodo},
doi = {10.5281/zenodo.21711455},
url = {https://doi.org/10.5281/zenodo.21711455}
}
```
The v0.5.1 archive specifically is [`10.5281/zenodo.22310719`](https://doi.org/10.5281/zenodo.22310719). [`CITATION.cff`](https://github.com/Thru-Echoes/TRACE/blob/main/CITATION.cff) lists the concept DOI alongside every version DOI, so GitHub's "Cite this repository" button and any CFF-aware tool stay in sync with this section.
## Contributing
See [CONTRIBUTING.md](https://github.com/Thru-Echoes/TRACE/blob/main/CONTRIBUTING.md) for development setup, the test suite layout, code style requirements, schema regeneration, and the development roadmap.
## Changelog
See [CHANGELOG.md](https://github.com/Thru-Echoes/TRACE/blob/main/CHANGELOG.md).
连接信息
猜你喜欢
暂无推荐服务器