symforge 10.8.0

SymForge — in-memory code intelligence MCP server for Claude Code, Codex, and Gemini CLI
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
//! Compress-Cache-Retrieve (CCR-lite) for bulk discovery tool output.
//!
//! ponytail: v1 in-memory per session only; disk spill under `.symforge/session-blobs/`
//! is the upgrade path when serve long-lived sessions need restart survival.

use std::collections::HashMap;
use std::hash::{Hash, Hasher};
use std::time::Instant;

use crate::live_index::search::{TextLineMatch, TextSearchResult};

const SEARCH_LINES_PER_FILE: usize = 10;
const SEARCH_MAX_FILES: usize = 20;

/// Per-tool output shaping rules (011).
#[derive(Clone, Copy, Debug)]
pub struct ToolOutputProfile {
    pub tool_name: &'static str,
    pub ccr_eligible: bool,
    pub default_max_tokens: u64,
}

pub const TOOL_OUTPUT_PROFILES: &[ToolOutputProfile] = &[
    ToolOutputProfile {
        tool_name: "search_text",
        ccr_eligible: true,
        default_max_tokens: 8_000,
    },
    ToolOutputProfile {
        tool_name: "search_knowledge",
        ccr_eligible: true,
        default_max_tokens: 8_000,
    },
    ToolOutputProfile {
        tool_name: "review_knowledge",
        ccr_eligible: true,
        default_max_tokens: 8_000,
    },
    ToolOutputProfile {
        tool_name: "search_symbols",
        ccr_eligible: true,
        default_max_tokens: 8_000,
    },
    ToolOutputProfile {
        tool_name: "find_references",
        ccr_eligible: true,
        default_max_tokens: 8_000,
    },
    ToolOutputProfile {
        tool_name: "explore",
        ccr_eligible: true,
        default_max_tokens: 12_000,
    },
    ToolOutputProfile {
        tool_name: "get_repo_map",
        ccr_eligible: true,
        default_max_tokens: 16_000,
    },
];

pub fn profile_for_tool(tool_name: &str) -> Option<&'static ToolOutputProfile> {
    TOOL_OUTPUT_PROFILES
        .iter()
        .find(|p| p.tool_name == tool_name)
}

/// Resolve `max_tokens` from agent override or tool profile default.
pub fn resolve_tool_max_tokens(tool_name: &str, agent_max: Option<u64>) -> Option<u64> {
    agent_max.or_else(|| profile_for_tool(tool_name).map(|p| p.default_max_tokens))
}

/// Stored formatted output for reversible compression.
#[derive(Clone, Debug)]
pub struct CcrBlob {
    pub handle: String,
    pub tool_name: String,
    pub formatted_bytes: String,
    pub created_at: Instant,
    pub secret_policy_version: Option<u32>,
}

#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum CcrRetrieveError {
    SecretPolicyMismatch,
}

/// Per-session CCR economics counters (011 US5, heuristic).
#[derive(Clone, Copy, Debug, Default, Eq, PartialEq, serde::Serialize)]
pub struct CcrEconomics {
    pub offloads: u32,
    pub bytes_stored: u64,
    pub retrieves: u32,
    pub bytes_retrieved: u64,
}

/// Combined session compression counters for economics surfaces (011 US5).
#[derive(Clone, Copy, Debug, Default, Eq, PartialEq, serde::Serialize)]
pub struct SessionCompressionHeuristic {
    pub cache_hits: u32,
    pub ccr_offloads: u32,
    pub ccr_bytes_stored: u64,
    pub ccr_bytes_retrieved: u64,
}

impl SessionCompressionHeuristic {
    pub fn from_parts(cache_hits: u32, ccr: CcrEconomics) -> Self {
        Self {
            cache_hits,
            ccr_offloads: ccr.offloads,
            ccr_bytes_stored: ccr.bytes_stored,
            ccr_bytes_retrieved: ccr.bytes_retrieved,
        }
    }
}

/// Per-session CCR blob store.
#[derive(Debug, Default)]
pub struct CcrStore {
    blobs: HashMap<String, CcrBlob>,
    total_bytes: usize,
    max_bytes: usize,
    max_entries: usize,
    economics: CcrEconomics,
}

impl CcrStore {
    pub fn new() -> Self {
        Self {
            blobs: HashMap::new(),
            total_bytes: 0,
            max_bytes: 32 * 1024 * 1024,
            max_entries: 256,
            economics: CcrEconomics::default(),
        }
    }

    pub fn insert(&mut self, tool_name: &str, formatted: String) -> String {
        let handle = mint_handle(tool_name, &formatted);
        let byte_len = formatted.len();
        // Content-addressed handle: re-inserting identical output refreshes the
        // stored blob's age and must not re-count bytes or offloads (recovered
        // finding #8 — the old unconditional add double-counted `total_bytes`
        // and the economics counters on every duplicate).
        if let Some(existing) = self.blobs.get_mut(&handle) {
            existing.created_at = Instant::now();
            return handle;
        }
        while self.total_bytes.saturating_add(byte_len) > self.max_bytes
            || self.blobs.len() >= self.max_entries
        {
            if !self.evict_oldest() {
                break;
            }
        }
        self.total_bytes = self.total_bytes.saturating_add(byte_len);
        self.blobs.insert(
            handle.clone(),
            CcrBlob {
                handle: handle.clone(),
                tool_name: tool_name.to_string(),
                formatted_bytes: formatted,
                created_at: Instant::now(),
                secret_policy_version: matches!(tool_name, "search_knowledge" | "review_knowledge")
                    .then_some(crate::knowledge::SECRET_POLICY_VERSION),
            },
        );
        self.economics.offloads = self.economics.offloads.saturating_add(1);
        self.economics.bytes_stored = self.economics.bytes_stored.saturating_add(byte_len as u64);
        handle
    }

    pub fn economics(&self) -> CcrEconomics {
        self.economics
    }

    /// Fetch blob and record retrieve bytes (US5).
    pub fn retrieve(&mut self, handle: &str) -> Option<String> {
        let blob = self.blobs.get(handle)?;
        let bytes = blob.formatted_bytes.len() as u64;
        self.economics.retrieves = self.economics.retrieves.saturating_add(1);
        self.economics.bytes_retrieved = self.economics.bytes_retrieved.saturating_add(bytes);
        Some(blob.formatted_bytes.clone())
    }

    /// Retrieve already-safe formatted output only under the detector policy
    /// that admitted it. Generic CCR records carry no policy tag and keep their
    /// existing behavior; knowledge records fail closed on a version mismatch.
    pub fn retrieve_checked(
        &mut self,
        handle: &str,
        current_secret_policy_version: u32,
    ) -> Result<Option<String>, CcrRetrieveError> {
        let Some(blob) = self.blobs.get(handle) else {
            return Ok(None);
        };
        if blob
            .secret_policy_version
            .is_some_and(|stored| stored != current_secret_policy_version)
        {
            return Err(CcrRetrieveError::SecretPolicyMismatch);
        }
        Ok(self.retrieve(handle))
    }

    pub fn get(&self, handle: &str) -> Option<&CcrBlob> {
        self.blobs.get(handle)
    }

    fn evict_oldest(&mut self) -> bool {
        let oldest = self
            .blobs
            .iter()
            .min_by_key(|(_, b)| b.created_at)
            .map(|(h, b)| (h.clone(), b.formatted_bytes.len()));
        let Some((handle, len)) = oldest else {
            return false;
        };
        self.blobs.remove(&handle);
        self.total_bytes = self.total_bytes.saturating_sub(len);
        true
    }

    pub(crate) fn remove_blob(&mut self, handle: &str) -> bool {
        let Some(blob) = self.blobs.remove(handle) else {
            return false;
        };
        self.total_bytes = self.total_bytes.saturating_sub(blob.formatted_bytes.len());
        true
    }
}

fn mint_handle(tool_name: &str, formatted: &str) -> String {
    let mut hasher = std::collections::hash_map::DefaultHasher::new();
    tool_name.hash(&mut hasher);
    formatted.hash(&mut hasher);
    format!("{:012x}", hasher.finish() & 0xFFFF_FFFF_FFFF)
}

/// If `summary` exceeds budget, store `full` and return summary + CCR footer.
pub fn apply_ccr_overflow(
    store: &mut CcrStore,
    tool_name: &str,
    summary: String,
    full: String,
    max_tokens: u64,
) -> String {
    let max_bytes = (max_tokens as usize).saturating_mul(4);
    if full.len() <= max_bytes {
        return full;
    }
    // ponytail: `summary` carries enforce_token_budget's own budget footer, so on
    // a real truncation it always sits a hair over max_bytes — the old
    // `summary.len() > max_bytes` guard therefore fired every time and suppressed
    // the retrieve handle. Only skip CCR when the summary saved nothing.
    if summary.len() >= full.len() {
        return summary;
    }
    let handle = store.insert(tool_name, full);
    let omitted_note = "full ranked output stored";
    format!(
        "{summary}\n---\nCCR: {omitted_note} · retrieve: symforge_retrieve with hash=\"{handle}\"\n"
    )
}

/// Rewrite an advertised CCR handle for the compact three-tool surface.
/// The stored blob and hash are unchanged; only the caller-visible redemption
/// instruction names the `symforge` facade that the client can actually call.
pub fn rewrite_footer_for_symforge_facade(result: String) -> String {
    result.replace(
        "retrieve: symforge_retrieve with hash=\"",
        "retrieve: symforge with query=\"retrieve CCR hash ",
    )
}

/// Enforce a token budget with CCR overflow — the single decision point for
/// "big response → truncate and offer retrieval".
///
/// Within budget the payload is returned unchanged (no footer, FR-008). Over
/// budget the complete payload is stored and the truncated summary gains a
/// `symforge_retrieve` footer whose hash fetches the full pre-truncation output
/// (SC-005). The CCR decision runs on the COMPLETE payload before the hard cut,
/// so the retrieve hash always resolves to the full result, never a
/// pre-truncated one.
pub fn enforce_token_budget_with_ccr(
    store: &mut CcrStore,
    tool_name: &str,
    result: String,
    max_tokens: Option<u64>,
) -> String {
    let Some(tokens) = max_tokens.filter(|t| *t > 0) else {
        return result;
    };
    if result.len() <= (tokens as usize).saturating_mul(4) {
        return result;
    }
    let summary = super::format::enforce_token_budget(result.clone(), Some(tokens));
    apply_ccr_overflow(store, tool_name, summary, result, tokens)
}

fn line_is_error_severity(line: &str) -> bool {
    let lower = line.to_ascii_lowercase();
    ["error", "fatal", "panic", "exception", "failed"]
        .iter()
        .any(|term| lower.contains(term))
}

fn score_line_match(line_match: &TextLineMatch, query: &str) -> i32 {
    let query_lower = query.to_ascii_lowercase();
    let mut score = 0;
    if line_is_error_severity(&line_match.line) {
        score += 5;
    }
    if !query_lower.is_empty() && line_match.line.to_ascii_lowercase().contains(&query_lower) {
        score += 3;
    }
    if let Some(sym) = &line_match.enclosing_symbol
        && sym.name.to_ascii_lowercase().contains(&query_lower)
    {
        score += 2;
    }
    score
}

/// Rank and cap search_text matches: preserve error-severity lines (US3).
pub fn compact_text_search_result(result: &mut TextSearchResult, query: &str) {
    let mut omitted = 0usize;
    let mut file_scores: Vec<(usize, i32)> = result
        .files
        .iter()
        .enumerate()
        .map(|(index, file)| {
            let best = file
                .matches
                .iter()
                .map(|m| score_line_match(m, query))
                .max()
                .unwrap_or(0);
            (index, best)
        })
        .collect();
    file_scores.sort_by(|a, b| b.1.cmp(&a.1).then_with(|| a.0.cmp(&b.0)));

    let keep_file_indices: std::collections::HashSet<usize> = file_scores
        .iter()
        .take(SEARCH_MAX_FILES)
        .map(|(index, _)| *index)
        .collect();

    let mut kept_files = Vec::new();
    for (index, mut file) in result.files.drain(..).enumerate() {
        if !keep_file_indices.contains(&index) {
            omitted = omitted.saturating_add(file.matches.len());
            continue;
        }
        omitted = omitted.saturating_add(cap_file_matches(&mut file.matches, query));
        if !file.matches.is_empty() {
            kept_files.push(file);
        } else {
            omitted = omitted.saturating_add(1);
        }
    }
    result.files = kept_files;
    result.overflow_count = result.overflow_count.saturating_add(omitted);
}

fn cap_file_matches(matches: &mut Vec<TextLineMatch>, query: &str) -> usize {
    if matches.is_empty() {
        return 0;
    }
    let before = matches.len();
    let mut ranked: Vec<(usize, i32, bool)> = matches
        .iter()
        .enumerate()
        .map(|(index, m)| {
            (
                index,
                score_line_match(m, query),
                line_is_error_severity(&m.line),
            )
        })
        .collect();
    ranked.sort_by(|a, b| b.1.cmp(&a.1).then_with(|| a.0.cmp(&b.0)));

    let mut keep = vec![false; matches.len()];
    for (index, _, is_error) in &ranked {
        if *is_error {
            keep[*index] = true;
        }
    }
    let mut non_error_kept = 0usize;
    for (index, _, is_error) in ranked {
        if is_error {
            continue;
        }
        if non_error_kept >= SEARCH_LINES_PER_FILE {
            break;
        }
        if !keep[index] {
            keep[index] = true;
            non_error_kept += 1;
        }
    }

    let capped: Vec<_> = matches
        .drain(..)
        .enumerate()
        .filter_map(|(index, m)| keep[index].then_some(m))
        .collect();
    let after = capped.len();
    *matches = capped;
    before.saturating_sub(after)
}

#[cfg(test)]
mod tests {
    use super::*;

    /// Recovered finding #8: a duplicate insert of identical content (same
    /// content-addressed handle) must not double-count `total_bytes` or the
    /// economics counters — it replaces/refreshes the same stored blob.
    #[test]
    fn ccr_insert_duplicate_does_not_double_count() {
        let mut store = CcrStore::new();
        let h1 = store.insert("search_text", "payload".to_string());
        let before = store.economics();
        let total_before = store.total_bytes;
        let h2 = store.insert("search_text", "payload".to_string());
        assert_eq!(h1, h2, "identical content mints the same handle");
        let after = store.economics();
        assert_eq!(
            after.bytes_stored, before.bytes_stored,
            "duplicate insert must not re-count stored bytes"
        );
        assert_eq!(
            after.offloads, before.offloads,
            "duplicate insert must not re-count offloads"
        );
        assert_eq!(
            store.total_bytes, total_before,
            "duplicate insert must not inflate total_bytes"
        );
    }

    #[test]
    fn ccr_round_trip() {
        let mut store = CcrStore::new();
        let full = "line\n".repeat(5000);
        let summary = "top hits".to_string();
        let out = apply_ccr_overflow(&mut store, "search_text", summary, full.clone(), 100);
        assert!(out.contains("symforge_retrieve"));
        let handle = out
            .split("hash=\"")
            .nth(1)
            .and_then(|s| s.split('"').next())
            .expect("handle");
        let blob = store.get(handle).expect("blob");
        assert_eq!(blob.formatted_bytes, full);
        let econ = store.economics();
        assert_eq!(econ.offloads, 1);
        assert!(econ.bytes_stored > 0);
        let retrieved = store.retrieve(handle).expect("retrieve");
        assert_eq!(retrieved, full);
        assert_eq!(store.economics().retrieves, 1);
        assert_eq!(store.economics().bytes_retrieved, econ.bytes_stored);
    }

    // T020 (SC-005): a builder response that truncates under a tight budget must
    // emit a `symforge_retrieve` footer whose hash resolves to the full payload.
    // Reproduces the production path: `enforce_token_budget` appends its own
    // budget footer, so the intermediate summary sits a hair over max_bytes —
    // which used to trip apply_ccr_overflow's guard and suppress the handle.
    #[test]
    fn ccr_footer_emitted_when_builder_truncates() {
        let mut store = CcrStore::new();
        let full = "outline symbol line of repo map text\n".repeat(2000);
        let out =
            enforce_token_budget_with_ccr(&mut store, "get_repo_map", full.clone(), Some(300));
        assert!(
            out.contains("symforge_retrieve"),
            "truncated output must offer a retrieve handle; tail: {}",
            &out[out.len().saturating_sub(160)..]
        );
        let handle = out
            .split("hash=\"")
            .nth(1)
            .and_then(|s| s.split('"').next())
            .expect("retrieve hash present");
        assert_eq!(
            store.get(handle).expect("blob stored").formatted_bytes,
            full,
            "retrieve hash must resolve to the full pre-truncation payload"
        );
    }

    // T021 (FR-008): a within-budget response gains no footer and stores nothing.
    #[test]
    fn ccr_no_footer_within_budget() {
        let mut store = CcrStore::new();
        let small = "fits\n".repeat(10);
        let out =
            enforce_token_budget_with_ccr(&mut store, "get_repo_map", small.clone(), Some(1000));
        assert_eq!(
            out, small,
            "within-budget output must be returned unchanged"
        );
        assert!(
            !out.contains("symforge_retrieve"),
            "no retrieve footer within budget"
        );
        assert_eq!(
            store.economics().offloads,
            0,
            "no blob stored for a within-budget response"
        );
    }

    #[test]
    fn knowledge_ccr_is_policy_tagged_and_mismatch_fails_closed() {
        let mut store = CcrStore::new();
        let handle = store.insert("search_knowledge", "safe formatted evidence".to_string());
        assert_eq!(
            store
                .get(&handle)
                .expect("knowledge CCR blob")
                .secret_policy_version,
            Some(crate::knowledge::SECRET_POLICY_VERSION)
        );
        assert!(matches!(
            store.retrieve_checked(
                &handle,
                crate::knowledge::SECRET_POLICY_VERSION.saturating_add(1)
            ),
            Err(CcrRetrieveError::SecretPolicyMismatch)
        ));
        assert_eq!(
            store
                .retrieve_checked(&handle, crate::knowledge::SECRET_POLICY_VERSION)
                .expect("matching policy")
                .expect("knowledge body"),
            "safe formatted evidence"
        );
    }

    #[test]
    fn compact_text_search_preserves_error_lines() {
        use crate::live_index::search::TextFileMatches;

        let mut result = TextSearchResult {
            label: "test".to_string(),
            total_matches: 52,
            files: vec![TextFileMatches {
                path: "src/log.rs".to_string(),
                matches: (0..50)
                    .map(|i| TextLineMatch {
                        line_number: i + 1,
                        line: format!("info line {i}"),
                        enclosing_symbol: None,
                    })
                    .chain([
                        TextLineMatch {
                            line_number: 51,
                            line: "ERROR: disk full".to_string(),
                            enclosing_symbol: None,
                        },
                        TextLineMatch {
                            line_number: 52,
                            line: "ERROR: retry failed".to_string(),
                            enclosing_symbol: None,
                        },
                    ])
                    .collect(),
                rendered_lines: None,
                callers: None,
            }],
            suppressed_by_noise: 0,
            overflow_count: 0,
        };
        compact_text_search_result(&mut result, "disk");
        let lines: Vec<_> = result.files[0]
            .matches
            .iter()
            .map(|m| m.line.as_str())
            .collect();
        assert!(lines.iter().any(|l| l.contains("ERROR: disk")));
        assert!(lines.iter().any(|l| l.contains("ERROR: retry")));
        assert!(result.overflow_count > 0);
    }
}