Skip to content

Commit a84c5e7

Browse files
committed
Clean up public Markdown docs
1 parent 26ee40b commit a84c5e7

4 files changed

Lines changed: 74 additions & 95 deletions

File tree

AGENT.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -101,8 +101,8 @@ Interpretation rules:
101101

102102
## `feedback_lean`
103103

104-
`feedback_lean` is intended to be placed directly into an agent's next prompt.
105-
It is not a patch that should normally be saved back to the Lean source.
104+
`feedback_lean` is intended as model-readable context for the next attempt. It
105+
is not a patch that should normally be saved back to the Lean source.
106106

107107
LeanProbe inserts Lean block comments before relevant lines:
108108

@@ -124,8 +124,8 @@ Feedback blocks can contain:
124124
- indentation that matches the surrounding Lean line.
125125

126126
The annotation is intentionally compact. Long diagnostics and large proof
127-
states are truncated so they remain useful in agent context. If the agent needs
128-
the raw structured data, read `messages` and `tactics` directly.
127+
states are truncated before insertion. For the raw structured data, read
128+
`messages` and `tactics` directly.
129129

130130
## `lean_probe_prepare`
131131

@@ -240,7 +240,7 @@ Typical Lean failure:
240240
```
241241

242242
On failure, `lean_probe_check` may rerun internally with tactic collection so
243-
the response can include useful `tactics` and `feedback_lean`.
243+
the response can include `tactics` and `feedback_lean`.
244244

245245
## `lean_probe_feedback`
246246

@@ -256,7 +256,7 @@ Use this when:
256256

257257
- `lean_probe_check` returns `ok=false` and the diagnostic summary is not enough;
258258
- the next candidate should be guided by local proof states;
259-
- the agent needs annotated Lean text for prompt context.
259+
- the next attempt needs annotated Lean context.
260260

261261
Typical result fields:
262262

@@ -282,7 +282,7 @@ Typical result fields:
282282

283283
`feedback` is usually more expensive than `check` because it asks LeanInteract
284284
for tactic metadata. Prefer `check` for ordinary candidate loops and call
285-
`feedback` when the agent needs richer context.
285+
`feedback` when richer context is needed.
286286

287287
## `lean_probe_state`
288288

@@ -415,7 +415,7 @@ Typical result:
415415
}
416416
```
417417

418-
Use this when the agent no longer needs to apply tactics to a proof state.
418+
Use this when tactic exploration for that proof state is finished.
419419

420420
## Recommended Workflows
421421

@@ -425,9 +425,9 @@ Use this when the agent no longer needs to apply tactics to a proof state.
425425
2. For each candidate, call `lean_probe_check` with a complete replacement
426426
declaration.
427427
3. If `ok=false`, inspect `output` and `messages`.
428-
4. If the next edit is not obvious, call `lean_probe_feedback` and pass
429-
`feedback_lean` plus structured `messages`/`tactics` into the next model
430-
prompt.
428+
4. If the next edit is not clear from the diagnostics, call
429+
`lean_probe_feedback` and pass `feedback_lean` plus structured
430+
`messages`/`tactics` into the next attempt.
431431
5. After accepting and writing a candidate to disk, run a whole-file or
432432
whole-project command when that larger scope matters.
433433

@@ -455,9 +455,9 @@ tries to restart it and report the error if restart fails.
455455
with `lean_probe_check`.
456456
5. Call `lean_probe_close_state` when the tactic session is no longer needed.
457457

458-
## Agent Prompt Snippet
458+
## Operational Rules Snippet
459459

460-
When using LeanProbe, give the agent these operational rules:
460+
For tool-using systems, these are the core operating rules:
461461

462462
```text
463463
Use lean_probe_prepare before repeated checks in a Lean file. Use

BENCHMARKS.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# LeanProbe Benchmark Details
22

3-
This file holds the detailed per-target benchmark rows for the May 13, 2026
4-
README results. The README keeps the grouped summary tables and methodology.
3+
Detailed per-target rows for the May 13, 2026 benchmark results. The README
4+
contains grouped summary tables, methodology, and reproduction commands.
55

66
Run policy for these repeated-target rows: 1 measured run per target, 0
77
benchmark warmups, warm Lake caches from prior example validation, feedback
@@ -52,8 +52,8 @@ Column guide:
5252
| `nat_square_eq_mul` | `number_theory_nat.lean` | 3.790s | 3.492s | 0.021s | 0.009s | 3.718s | 1 | 3.20x | 10.24x |
5353
| `nat_dvd_trans` | `number_theory_nat.lean` | 3.651s | 3.502s | 0.007s | 0.005s | 3.847s | 1 | 3.11x | 10.22x |
5454

55-
The first analysis row includes the coldest LeanInteract server setup observed
56-
in this run. Its prepare time is therefore much higher, and it needs four check
55+
The first analysis row includes the coldest LeanInteract server setup in this
56+
dataset. Its prepare time is therefore much higher, and it needs four check
5757
attempts to break even.
5858

5959
## TCS Challenge Examples: macOS Per-Target Detail

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,4 +30,4 @@ LEAN_PROBE_RUN_INTEGRATION=1 python -m pytest tests/test_integration.py -q
3030
- Keep LeanProbe independent of downstream projects.
3131
- Preserve the MCP tool names in `src/lean_probe/mcp_server.py`.
3232
- Update `AGENT.md` when tool semantics or payload fields change.
33-
- Keep benchmark raw outputs out of git; `benchmark_results/` is ignored.
33+
- Keep generated benchmark result files out of commits.

0 commit comments

Comments
 (0)