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

#![cfg(feature = "recalc")]

use anyhow::Result;
use spreadsheet_mcp::model::WorkbookId;
use spreadsheet_mcp::tools::fork::{
    ApplyFormulaPatternParams, ApplyStagedChangeParams, CreateForkParams, apply_formula_pattern,
    apply_staged_change, create_fork,
};
use spreadsheet_mcp::tools::param_enums::{BatchMode, FillDirection};
use spreadsheet_mcp::tools::{ListWorkbooksParams, list_workbooks};

mod support;

fn recalc_state(
    workspace: &support::TestWorkspace,
) -> std::sync::Arc<spreadsheet_mcp::state::AppState> {
    let config = workspace.config_with(|cfg| {
        cfg.recalc_enabled = true;
    });
    support::app_state_with_config(config)
}

#[tokio::test(flavor = "current_thread")]
async fn apply_formula_pattern_preview_stages_and_apply() -> Result<()> {
    let workspace = support::TestWorkspace::new();
    workspace.create_workbook("pattern.xlsx", |book| {
        let sheet = book.get_sheet_by_name_mut("Sheet1").unwrap();
        sheet.get_cell_mut("A1").set_value_number(1);
        sheet.get_cell_mut("B1").set_value_number(2);
    });

    let state = recalc_state(&workspace);
    let list = list_workbooks(
        state.clone(),
        ListWorkbooksParams {
            slug_prefix: None,
            folder: None,
            path_glob: None,
            limit: None,
            offset: None,
            include_paths: None,
        },
    )
    .await?;
    let workbook_id = list.workbooks[0].workbook_id.clone();
    let fork = create_fork(
        state.clone(),
        CreateForkParams {
            workbook_or_fork_id: workbook_id,
        },
    )
    .await?;

    let preview = apply_formula_pattern(
        state.clone(),
        ApplyFormulaPatternParams {
            fork_id: fork.fork_id.clone(),
            sheet_name: "Sheet1".to_string(),
            target_range: "C1:C3".to_string(),
            anchor_cell: "C1".to_string(),
            base_formula: "A1+B1".to_string(),
            fill_direction: Some(FillDirection::Down),
            relative_mode: None,
            mode: Some(BatchMode::Preview),
            label: Some("fill sums".to_string()),
        },
    )
    .await?;
    let change_id = preview.change_id.clone().expect("change_id");

    // Preview should not mutate the fork.
    let fork_wb = state
        .open_workbook(&WorkbookId(fork.fork_id.clone()))
        .await?;
    let formula_c2 = fork_wb.with_sheet("Sheet1", |sheet| {
        sheet.get_cell("C2").map(|c| c.get_formula().to_string())
    })?;
    assert!(formula_c2.is_none());

    apply_staged_change(
        state.clone(),
        ApplyStagedChangeParams {
            fork_id: fork.fork_id.clone(),
            change_id,
        },
    )
    .await?;

    let fork_wb = state
        .open_workbook(&WorkbookId(fork.fork_id.clone()))
        .await?;
    let formulas = fork_wb.with_sheet("Sheet1", |sheet| {
        vec![
            sheet.get_cell("C1").unwrap().get_formula().to_string(),
            sheet.get_cell("C2").unwrap().get_formula().to_string(),
            sheet.get_cell("C3").unwrap().get_formula().to_string(),
        ]
    })?;

    assert_eq!(formulas[0], "A1 + B1");
    assert_eq!(formulas[1], "A2 + B2");
    assert_eq!(formulas[2], "A3 + B3");

    Ok(())
}

#[tokio::test(flavor = "current_thread")]
async fn apply_formula_pattern_validates_anchor_and_direction() -> Result<()> {
    let workspace = support::TestWorkspace::new();
    workspace.create_workbook("invalid.xlsx", |_| {});

    let state = recalc_state(&workspace);
    let list = list_workbooks(
        state.clone(),
        ListWorkbooksParams {
            slug_prefix: None,
            folder: None,
            path_glob: None,
            limit: None,
            offset: None,
            include_paths: None,
        },
    )
    .await?;
    let workbook_id = list.workbooks[0].workbook_id.clone();
    let fork = create_fork(
        state.clone(),
        CreateForkParams {
            workbook_or_fork_id: workbook_id,
        },
    )
    .await?;

    let err = apply_formula_pattern(
        state.clone(),
        ApplyFormulaPatternParams {
            fork_id: fork.fork_id.clone(),
            sheet_name: "Sheet1".to_string(),
            target_range: "C1:C3".to_string(),
            anchor_cell: "C2".to_string(),
            base_formula: "A1+B1".to_string(),
            fill_direction: Some(FillDirection::Down),
            relative_mode: None,
            mode: Some(BatchMode::Apply),
            label: None,
        },
    )
    .await
    .unwrap_err();

    assert!(
        err.to_string()
            .contains("target_range must start at anchor_cell")
    );

    Ok(())
}