spreadsheet-mcp 0.10.1

Stateful MCP server for spreadsheet analysis and editing — token-efficient tools for LLM agents to read, profile, edit, and recalculate .xlsx workbooks
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
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
#![cfg(feature = "recalc")]

use spreadsheet_mcp::diff::{
    Change, calculate_changeset,
    merge::{CellDiff, ModificationType},
};
use std::path::PathBuf;
use umya_spreadsheet::Spreadsheet;

#[path = "./support/mod.rs"]
mod support;

use support::builders::{self, CellVal};

struct DiffScenario {
    _temp_dir: tempfile::TempDir,
    base_path: PathBuf,
    fork_path: PathBuf,
}

impl DiffScenario {
    fn new() -> Self {
        let temp_dir = tempfile::tempdir().expect("failed to create temp dir");
        let base_path = temp_dir.path().join("base.xlsx");
        let fork_path = temp_dir.path().join("fork.xlsx");

        Self {
            _temp_dir: temp_dir,
            base_path,
            fork_path,
        }
    }

    fn setup<F1, F2>(&self, setup_base: F1, setup_fork: F2)
    where
        F1: FnOnce(&mut Spreadsheet),
        F2: FnOnce(&mut Spreadsheet),
    {
        let mut base_book = umya_spreadsheet::new_file();
        setup_base(&mut base_book);
        umya_spreadsheet::writer::xlsx::write(&base_book, &self.base_path)
            .expect("failed to write base");

        let mut fork_book = umya_spreadsheet::new_file();
        setup_fork(&mut fork_book);
        umya_spreadsheet::writer::xlsx::write(&fork_book, &self.fork_path)
            .expect("failed to write fork");
    }

    fn run_diff(&self, sheet_filter: Option<&str>) -> Vec<Change> {
        calculate_changeset(&self.base_path, &self.fork_path, sheet_filter).expect("diff failed")
    }
}

#[test]
fn test_no_changes() {
    let scenario = DiffScenario::new();
    scenario.setup(
        |book| {
            let sheet = book.get_sheet_mut(&0).unwrap();
            builders::set_cell(sheet, 1, 1, &CellVal::from(10)); // A1
        },
        |book| {
            let sheet = book.get_sheet_mut(&0).unwrap();
            builders::set_cell(sheet, 1, 1, &CellVal::from(10)); // A1
        },
    );

    let diff = scenario.run_diff(None);
    assert!(diff.is_empty(), "expected no changes, got {:?}", diff);
}

#[test]
fn test_basic_edits() {
    let scenario = DiffScenario::new();

    // A1=10, A2="foo", A3=SUM(A1) (val=10)
    let setup_base = |book: &mut Spreadsheet| {
        let sheet = book.get_sheet_mut(&0).unwrap();
        builders::set_cell(sheet, 1, 1, &CellVal::from(10));
        builders::set_cell(sheet, 1, 2, &CellVal::from("foo"));
        builders::set_cell(sheet, 1, 3, &CellVal::Formula("SUM(A1)".to_string()));
        // sheet.get_cell_mut("A3").set_value_number(10.0);
    };

    // A1=20 (Val Edit), A2="bar" (Val Edit), A3=SUM(A1)+1 (Formula Edit)
    let setup_fork = |book: &mut Spreadsheet| {
        let sheet = book.get_sheet_mut(&0).unwrap();
        builders::set_cell(sheet, 1, 1, &CellVal::from(20));
        builders::set_cell(sheet, 1, 2, &CellVal::from("bar"));
        builders::set_cell(sheet, 1, 3, &CellVal::Formula("SUM(A1)+1".to_string()));
        // sheet.get_cell_mut("A3").set_value("20");
    };

    scenario.setup(setup_base, setup_fork);

    let diffs = scenario.run_diff(None);
    assert_eq!(diffs.len(), 3);

    // Sort by address for stable assertions
    let mut diffs = diffs;
    diffs.sort_by(|a, b| match (a, b) {
        (Change::Cell(ca), Change::Cell(cb)) => match (&ca.diff, &cb.diff) {
            (
                CellDiff::Modified {
                    address: a_addr, ..
                },
                CellDiff::Modified {
                    address: b_addr, ..
                },
            ) => a_addr.cmp(b_addr),
            _ => std::cmp::Ordering::Equal,
        },
        _ => std::cmp::Ordering::Equal,
    });

    // A1: 10 -> 20 (ValueEdit)
    match &diffs[0] {
        Change::Cell(c) => match &c.diff {
            CellDiff::Modified {
                address,
                subtype,
                old_value,
                new_value,
                ..
            } => {
                assert_eq!(address, "A1");
                assert!(matches!(subtype, ModificationType::ValueEdit));
                assert_eq!(old_value.as_deref(), Some("10"));
                assert_eq!(new_value.as_deref(), Some("20"));
            }
            _ => panic!("Unexpected diff at A1"),
        },
        _ => panic!("Expected cell diff"),
    }

    // A2: "foo" -> "bar" (ValueEdit)
    match &diffs[1] {
        Change::Cell(c) => match &c.diff {
            CellDiff::Modified {
                address,
                subtype,
                old_value,
                new_value,
                ..
            } => {
                assert_eq!(address, "A2");
                assert!(matches!(subtype, ModificationType::ValueEdit));
                assert_eq!(old_value.as_deref(), Some("foo"));
                assert_eq!(new_value.as_deref(), Some("bar"));
            }
            _ => panic!("Unexpected diff at A2"),
        },
        _ => panic!("Expected cell diff"),
    }

    // A3: Formula changed (FormulaEdit)
    match &diffs[2] {
        Change::Cell(c) => match &c.diff {
            CellDiff::Modified {
                address,
                subtype,
                old_formula,
                new_formula,
                ..
            } => {
                assert_eq!(address, "A3");
                assert!(matches!(subtype, ModificationType::FormulaEdit));
                assert_eq!(old_formula.as_deref(), Some("SUM(A1)"));
                assert_eq!(new_formula.as_deref(), Some("SUM(A1)+1"));
            }
            _ => panic!("Unexpected diff at A3"),
        },
        _ => panic!("Expected cell diff"),
    }
}

#[test]
fn test_structural_changes() {
    let scenario = DiffScenario::new();

    // Base: A1=10
    // Fork: B1=20 (Added), A1 deleted
    scenario.setup(
        |book| {
            builders::set_cell(book.get_sheet_mut(&0).unwrap(), 1, 1, &CellVal::from(10));
        },
        |book| {
            builders::set_cell(book.get_sheet_mut(&0).unwrap(), 2, 1, &CellVal::from(20));
        },
    );

    let diffs = scenario.run_diff(None);
    assert_eq!(diffs.len(), 2);

    // Check for Added B1
    let _added = diffs
        .iter()
        .find(|d| match d {
            Change::Cell(c) => {
                matches!(c.diff, CellDiff::Added { ref address, .. } if address == "B1")
            }
            _ => false,
        })
        .expect("Missing B1 add");

    // Check for Deleted A1
    let _deleted = diffs
        .iter()
        .find(|d| match d {
            Change::Cell(c) => {
                matches!(c.diff, CellDiff::Deleted { ref address, .. } if address == "A1")
            }
            _ => false,
        })
        .expect("Missing A1 delete");
}

#[test]
fn test_sheet_filtering() {
    let scenario = DiffScenario::new();

    // Base: Sheet1!A1=1, Sheet2!A1=1
    // Fork: Sheet1!A1=2, Sheet2!A1=2
    let setup = |book: &mut Spreadsheet, val: i32| {
        let s1 = book.get_sheet_mut(&0).unwrap();
        s1.set_name("Sheet1");
        builders::set_cell(s1, 1, 1, &CellVal::from(val));

        let s2 = book.new_sheet("Sheet2").unwrap();
        builders::set_cell(s2, 1, 1, &CellVal::from(val));
    };

    scenario.setup(|b| setup(b, 1), |b| setup(b, 2));

    // Filter for Sheet1
    let diffs = scenario.run_diff(Some("Sheet1"));
    assert_eq!(diffs.len(), 1);
    match &diffs[0] {
        Change::Cell(c) => assert_eq!(c.sheet, "Sheet1"),
        _ => panic!("Expected cell diff"),
    }
}

#[test]
fn test_sst_resolution() {
    let scenario = DiffScenario::new();

    // Base: A1="Apple", B1="Apple" (Shared)
    // Fork: A1="Banana", B1="Apple"
    scenario.setup(
        |book| {
            let s = book.get_sheet_mut(&0).unwrap();
            builders::set_cell(s, 1, 1, &CellVal::from("Apple"));
            builders::set_cell(s, 2, 1, &CellVal::from("Apple"));
        },
        |book| {
            let s = book.get_sheet_mut(&0).unwrap();
            builders::set_cell(s, 1, 1, &CellVal::from("Banana")); // Change A1
            builders::set_cell(s, 2, 1, &CellVal::from("Apple")); // Keep B1
        },
    );

    let diffs = scenario.run_diff(None);

    // Only A1 should change
    assert_eq!(diffs.len(), 1);
    match &diffs[0] {
        Change::Cell(c) => match &c.diff {
            CellDiff::Modified {
                address,
                old_value,
                new_value,
                ..
            } => {
                assert_eq!(address, "A1");
                assert_eq!(old_value.as_deref(), Some("Apple"));
                assert_eq!(new_value.as_deref(), Some("Banana"));
            }
            _ => panic!("Wrong diff type"),
        },
        _ => panic!("Expected cell diff"),
    }
}

#[test]
fn test_large_dataset() {
    let scenario = DiffScenario::new();
    let rows = 5000;

    // Setup 5k rows
    let setup = |book: &mut Spreadsheet, modify: bool| {
        let s = book.get_sheet_mut(&0).unwrap();
        for r in 1..=rows {
            let val = if modify && r == rows { 9999 } else { r as i32 };
            builders::set_cell(s, 1, r, &CellVal::from(val)); // A{r}
        }
    };

    let start = std::time::Instant::now();
    scenario.setup(|b| setup(b, false), |b| setup(b, true));
    let setup_time = start.elapsed();
    println!("Setup time: {:?}", setup_time);

    let start = std::time::Instant::now();
    let diffs = scenario.run_diff(None);
    let diff_time = start.elapsed();
    println!("Diff time: {:?}", diff_time);

    assert_eq!(diffs.len(), 1);
    match &diffs[0] {
        Change::Cell(c) => match &c.diff {
            CellDiff::Modified {
                address,
                old_value,
                new_value,
                ..
            } => {
                assert_eq!(address, &format!("A{}", rows));
                assert_eq!(old_value.as_deref(), Some("5000"));
                assert_eq!(new_value.as_deref(), Some("9999"));
            }
            _ => panic!("Wrong diff"),
        },
        _ => panic!("Expected cell diff"),
    }
}

#[test]
fn test_recalc_result_classification() {
    let scenario = DiffScenario::new();

    // Base: A1=10, B1=SUM(A1) with cached value 10
    // Fork: A1=10, B1=SUM(A1) with cached value 20 (simulated recalc)
    scenario.setup(
        |book| {
            let sheet = book.get_sheet_mut(&0).unwrap();
            sheet.get_cell_mut("A1").set_value_number(10);
            let cell = sheet.get_cell_mut("B1");
            cell.set_formula("SUM(A1)");
            cell.set_formula_result_default("10");
        },
        |book| {
            let sheet = book.get_sheet_mut(&0).unwrap();
            sheet.get_cell_mut("A1").set_value_number(10);
            let cell = sheet.get_cell_mut("B1");
            cell.set_formula("SUM(A1)");
            cell.set_formula_result_default("20");
        },
    );

    let diffs = scenario.run_diff(None);
    assert_eq!(diffs.len(), 1);

    match &diffs[0] {
        Change::Cell(c) => match &c.diff {
            CellDiff::Modified {
                address,
                subtype,
                old_value,
                new_value,
                old_formula,
                new_formula,
                ..
            } => {
                assert_eq!(address, "B1");
                assert!(
                    matches!(subtype, ModificationType::RecalcResult),
                    "expected RecalcResult, got {:?}",
                    subtype
                );
                assert_eq!(old_value.as_deref(), Some("10"));
                assert_eq!(new_value.as_deref(), Some("20"));
                assert_eq!(old_formula.as_deref(), Some("SUM(A1)"));
                assert_eq!(new_formula.as_deref(), Some("SUM(A1)"));
            }
            _ => panic!("Expected Modified diff, got {:?}", c.diff),
        },
        _ => panic!("Expected cell diff"),
    }
}

#[test]
fn test_float_epsilon_comparison() {
    let scenario = DiffScenario::new();

    // 0.1 + 0.2 = 0.30000000000000004 in IEEE 754
    scenario.setup(
        |book| {
            let sheet = book.get_sheet_mut(&0).unwrap();
            sheet.get_cell_mut("A1").set_value_number(0.3);
        },
        |book| {
            let sheet = book.get_sheet_mut(&0).unwrap();
            sheet.get_cell_mut("A1").set_value_number(0.1 + 0.2);
        },
    );

    let diffs = scenario.run_diff(None);
    assert!(
        diffs.is_empty(),
        "float epsilon comparison should treat 0.3 == 0.1+0.2, got {:?}",
        diffs
    );
}

#[test]
fn test_float_beyond_epsilon() {
    let scenario = DiffScenario::new();

    // Values differ by more than 1e-9
    scenario.setup(
        |book| {
            let sheet = book.get_sheet_mut(&0).unwrap();
            sheet.get_cell_mut("A1").set_value_number(1.0);
        },
        |book| {
            let sheet = book.get_sheet_mut(&0).unwrap();
            sheet.get_cell_mut("A1").set_value_number(1.000000002);
        },
    );

    let diffs = scenario.run_diff(None);
    assert_eq!(
        diffs.len(),
        1,
        "values differing by >1e-9 should be detected"
    );
}

#[test]
fn test_pure_numeric_sheet_no_sst() {
    let scenario = DiffScenario::new();

    // Sheet with only numbers - no shared strings at all
    scenario.setup(
        |book| {
            let sheet = book.get_sheet_mut(&0).unwrap();
            for i in 1..=10 {
                sheet.get_cell_mut((1, i)).set_value_number(i as f64);
            }
        },
        |book| {
            let sheet = book.get_sheet_mut(&0).unwrap();
            for i in 1..=10 {
                let val = if i == 5 { 999.0 } else { i as f64 };
                sheet.get_cell_mut((1, i)).set_value_number(val);
            }
        },
    );

    let diffs = scenario.run_diff(None);
    assert_eq!(diffs.len(), 1);

    match &diffs[0] {
        Change::Cell(c) => match &c.diff {
            CellDiff::Modified {
                address,
                old_value,
                new_value,
                ..
            } => {
                assert_eq!(address, "A5");
                assert_eq!(old_value.as_deref(), Some("5"));
                assert_eq!(new_value.as_deref(), Some("999"));
            }
            _ => panic!("Wrong diff type"),
        },
        _ => panic!("Expected cell diff"),
    }
}

#[test]
fn test_empty_sheet() {
    let scenario = DiffScenario::new();
    scenario.setup(|_book| {}, |_book| {});
    let diffs = scenario.run_diff(None);
    assert!(diffs.is_empty());
}

#[test]
fn test_empty_to_populated() {
    let scenario = DiffScenario::new();

    // Base empty, fork has data
    scenario.setup(
        |_book| {},
        |book| {
            let sheet = book.get_sheet_mut(&0).unwrap();
            sheet.get_cell_mut("A1").set_value_number(42);
        },
    );

    let diffs = scenario.run_diff(None);
    assert_eq!(diffs.len(), 1);

    match &diffs[0] {
        Change::Cell(c) => match &c.diff {
            CellDiff::Added { address, value, .. } => {
                assert_eq!(address, "A1");
                assert_eq!(value.as_deref(), Some("42"));
            }
            _ => panic!("Expected Added diff"),
        },
        _ => panic!("Expected cell diff"),
    }
}

#[test]
fn test_rich_text_in_sst() {
    use umya_spreadsheet::structs::{RichText, TextElement};

    let scenario = DiffScenario::new();

    // Create rich text with multiple runs: "Hello" + "World"
    scenario.setup(
        |book| {
            let sheet = book.get_sheet_mut(&0).unwrap();

            let mut rt = RichText::default();
            let mut elem1 = TextElement::default();
            elem1.set_text("Hello");
            let mut elem2 = TextElement::default();
            elem2.set_text("World");
            rt.add_rich_text_elements(elem1);
            rt.add_rich_text_elements(elem2);

            sheet.get_cell_mut("A1").set_rich_text(rt);
        },
        |book| {
            let sheet = book.get_sheet_mut(&0).unwrap();

            let mut rt = RichText::default();
            let mut elem1 = TextElement::default();
            elem1.set_text("Hello");
            let mut elem2 = TextElement::default();
            elem2.set_text("World");
            rt.add_rich_text_elements(elem1);
            rt.add_rich_text_elements(elem2);

            sheet.get_cell_mut("A1").set_rich_text(rt);
        },
    );

    // Should detect no changes - same concatenated text
    let diffs = scenario.run_diff(None);
    assert!(
        diffs.is_empty(),
        "identical rich text should produce no diff, got {:?}",
        diffs
    );
}

#[test]
fn test_rich_text_changed() {
    use umya_spreadsheet::structs::{RichText, TextElement};

    let scenario = DiffScenario::new();

    scenario.setup(
        |book| {
            let sheet = book.get_sheet_mut(&0).unwrap();

            let mut rt = RichText::default();
            let mut elem = TextElement::default();
            elem.set_text("Hello");
            rt.add_rich_text_elements(elem);
            sheet.get_cell_mut("A1").set_rich_text(rt);

            sheet.get_cell_mut("B1").set_value_number(1);
        },
        |book| {
            let sheet = book.get_sheet_mut(&0).unwrap();

            let mut rt = RichText::default();
            let mut elem = TextElement::default();
            elem.set_text("Goodbye");
            rt.add_rich_text_elements(elem);
            sheet.get_cell_mut("A1").set_rich_text(rt);

            sheet.get_cell_mut("B1").set_value_number(2);
        },
    );

    let diffs = scenario.run_diff(None);
    assert_eq!(
        diffs.len(),
        2,
        "expected 2 diffs (A1 + B1), got {:?}",
        diffs
    );

    let a1_diff = diffs
        .iter()
        .find(|d| match d {
            Change::Cell(c) => match &c.diff {
                CellDiff::Modified { address, .. } => address == "A1",
                _ => false,
            },
            _ => false,
        })
        .expect("A1 diff not found");

    match a1_diff {
        Change::Cell(c) => match &c.diff {
            CellDiff::Modified {
                old_value,
                new_value,
                ..
            } => {
                assert_eq!(old_value.as_deref(), Some("Hello"));
                assert_eq!(new_value.as_deref(), Some("Goodbye"));
            }
            _ => unreachable!(),
        },
        _ => unreachable!(),
    }
}

#[test]
fn test_style_only_edit_emits_style_diff() {
    let scenario = DiffScenario::new();
    scenario.setup(
        |book| {
            let sheet = book.get_sheet_mut(&0).unwrap();
            builders::set_cell(sheet, 1, 1, &CellVal::from("x")); // A1
        },
        |book| {
            let sheet = book.get_sheet_mut(&0).unwrap();
            builders::set_cell(sheet, 1, 1, &CellVal::from("x")); // A1
            sheet.get_style_mut("A1").get_font_mut().set_bold(true);
        },
    );

    let diffs = scenario.run_diff(None);
    assert_eq!(diffs.len(), 1);
    match &diffs[0] {
        Change::Cell(c) => match &c.diff {
            CellDiff::Modified { subtype, .. } => {
                assert!(matches!(subtype, ModificationType::StyleEdit));
            }
            other => panic!("unexpected diff: {:?}", other),
        },
        other => panic!("unexpected change: {:?}", other),
    }
}

#[test]
fn test_style_and_value_edit_keeps_value_subtype_with_style_ids() {
    let scenario = DiffScenario::new();
    scenario.setup(
        |book| {
            let sheet = book.get_sheet_mut(&0).unwrap();
            builders::set_cell(sheet, 1, 1, &CellVal::from("x")); // A1
            sheet.get_style_mut("A1").get_font_mut().set_italic(true);
        },
        |book| {
            let sheet = book.get_sheet_mut(&0).unwrap();
            builders::set_cell(sheet, 1, 1, &CellVal::from("y")); // A1
            sheet.get_style_mut("A1").get_font_mut().set_bold(true);
        },
    );

    let diffs = scenario.run_diff(None);
    assert_eq!(diffs.len(), 1);
    match &diffs[0] {
        Change::Cell(c) => match &c.diff {
            CellDiff::Modified {
                subtype,
                old_style_id,
                new_style_id,
                ..
            } => {
                assert!(matches!(subtype, ModificationType::ValueEdit));
                // Style ids may be omitted by the writer when defaults are used.
                let _ = (old_style_id, new_style_id);
            }
            other => panic!("unexpected diff: {:?}", other),
        },
        other => panic!("unexpected change: {:?}", other),
    }
}

// NOTE: Inline strings (<is> elements in cell XML, type="inlineStr") are not currently
// supported by the diff engine. The parser in cells.rs skips <is> elements.
// This is a known limitation. Testing would require manually crafting xlsx files
// since umya-spreadsheet always writes strings via SST, not inline.
// Most Excel/LibreOffice files use SST for strings, so this is a rare edge case.