forked from taylorwilsdon/google_workspace_mcp
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathsheets_tools.py
More file actions
1009 lines (870 loc) · 36.2 KB
/
sheets_tools.py
File metadata and controls
1009 lines (870 loc) · 36.2 KB
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
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
"""
Google Sheets MCP Tools
This module provides MCP tools for interacting with Google Sheets API.
"""
import logging
import asyncio
import json
import copy
from typing import List, Optional, Union
from auth.service_decorator import require_google_service
from core.server import server
from core.utils import handle_http_errors, UserInputError
from core.comments import create_comment_tools
from gsheets.sheets_helpers import (
CONDITION_TYPES,
_a1_range_for_values,
_build_boolean_rule,
_build_gradient_rule,
_fetch_detailed_sheet_errors,
_fetch_sheets_with_rules,
_format_conditional_rules_section,
_format_sheet_error_section,
_parse_a1_range,
_parse_condition_values,
_parse_gradient_points,
_parse_hex_color,
_select_sheet,
_values_contain_sheets_errors,
)
# Configure module logger
logger = logging.getLogger(__name__)
@server.tool()
@handle_http_errors("list_spreadsheets", is_read_only=True, service_type="sheets")
@require_google_service("drive", "drive_read")
async def list_spreadsheets(
service,
user_google_email: str,
max_results: int = 25,
) -> str:
"""
Lists spreadsheets from Google Drive that the user has access to.
Args:
user_google_email (str): The user's Google email address. Required.
max_results (int): Maximum number of spreadsheets to return. Defaults to 25.
Returns:
str: A formatted list of spreadsheet files (name, ID, modified time).
"""
logger.info(f"[list_spreadsheets] Invoked. Email: '{user_google_email}'")
files_response = await asyncio.to_thread(
service.files()
.list(
q="mimeType='application/vnd.google-apps.spreadsheet'",
pageSize=max_results,
fields="files(id,name,modifiedTime,webViewLink)",
orderBy="modifiedTime desc",
supportsAllDrives=True,
includeItemsFromAllDrives=True,
)
.execute
)
files = files_response.get("files", [])
if not files:
return f"No spreadsheets found for {user_google_email}."
spreadsheets_list = [
f'- "{file["name"]}" (ID: {file["id"]}) | Modified: {file.get("modifiedTime", "Unknown")} | Link: {file.get("webViewLink", "No link")}'
for file in files
]
text_output = (
f"Successfully listed {len(files)} spreadsheets for {user_google_email}:\n"
+ "\n".join(spreadsheets_list)
)
logger.info(
f"Successfully listed {len(files)} spreadsheets for {user_google_email}."
)
return text_output
@server.tool()
@handle_http_errors("get_spreadsheet_info", is_read_only=True, service_type="sheets")
@require_google_service("sheets", "sheets_read")
async def get_spreadsheet_info(
service,
user_google_email: str,
spreadsheet_id: str,
) -> str:
"""
Gets information about a specific spreadsheet including its sheets.
Args:
user_google_email (str): The user's Google email address. Required.
spreadsheet_id (str): The ID of the spreadsheet to get info for. Required.
Returns:
str: Formatted spreadsheet information including title, locale, and sheets list.
"""
logger.info(
f"[get_spreadsheet_info] Invoked. Email: '{user_google_email}', Spreadsheet ID: {spreadsheet_id}"
)
spreadsheet = await asyncio.to_thread(
service.spreadsheets()
.get(
spreadsheetId=spreadsheet_id,
fields="spreadsheetId,properties(title,locale),sheets(properties(title,sheetId,gridProperties(rowCount,columnCount)),conditionalFormats)",
)
.execute
)
properties = spreadsheet.get("properties", {})
title = properties.get("title", "Unknown")
locale = properties.get("locale", "Unknown")
sheets = spreadsheet.get("sheets", [])
sheet_titles = {}
for sheet in sheets:
sheet_props = sheet.get("properties", {})
sid = sheet_props.get("sheetId")
if sid is not None:
sheet_titles[sid] = sheet_props.get("title", f"Sheet {sid}")
sheets_info = []
for sheet in sheets:
sheet_props = sheet.get("properties", {})
sheet_name = sheet_props.get("title", "Unknown")
sheet_id = sheet_props.get("sheetId", "Unknown")
grid_props = sheet_props.get("gridProperties", {})
rows = grid_props.get("rowCount", "Unknown")
cols = grid_props.get("columnCount", "Unknown")
rules = sheet.get("conditionalFormats", []) or []
sheets_info.append(
f' - "{sheet_name}" (ID: {sheet_id}) | Size: {rows}x{cols} | Conditional formats: {len(rules)}'
)
if rules:
sheets_info.append(
_format_conditional_rules_section(
sheet_name, rules, sheet_titles, indent=" "
)
)
sheets_section = "\n".join(sheets_info) if sheets_info else " No sheets found"
text_output = "\n".join(
[
f'Spreadsheet: "{title}" (ID: {spreadsheet_id}) | Locale: {locale}',
f"Sheets ({len(sheets)}):",
sheets_section,
]
)
logger.info(
f"Successfully retrieved info for spreadsheet {spreadsheet_id} for {user_google_email}."
)
return text_output
@server.tool()
@handle_http_errors("read_sheet_values", is_read_only=True, service_type="sheets")
@require_google_service("sheets", "sheets_read")
async def read_sheet_values(
service,
user_google_email: str,
spreadsheet_id: str,
range_name: str = "A1:Z1000",
) -> str:
"""
Reads values from a specific range in a Google Sheet.
Args:
user_google_email (str): The user's Google email address. Required.
spreadsheet_id (str): The ID of the spreadsheet. Required.
range_name (str): The range to read (e.g., "Sheet1!A1:D10", "A1:D10"). Defaults to "A1:Z1000".
Returns:
str: The formatted values from the specified range.
"""
logger.info(
f"[read_sheet_values] Invoked. Email: '{user_google_email}', Spreadsheet: {spreadsheet_id}, Range: {range_name}"
)
result = await asyncio.to_thread(
service.spreadsheets()
.values()
.get(spreadsheetId=spreadsheet_id, range=range_name)
.execute
)
values = result.get("values", [])
if not values:
return f"No data found in range '{range_name}' for {user_google_email}."
detailed_errors_section = ""
if _values_contain_sheets_errors(values):
resolved_range = result.get("range", range_name)
detailed_range = _a1_range_for_values(resolved_range, values) or resolved_range
try:
errors = await _fetch_detailed_sheet_errors(
service, spreadsheet_id, detailed_range
)
detailed_errors_section = _format_sheet_error_section(
errors=errors, range_label=detailed_range
)
except Exception as exc:
logger.warning(
"[read_sheet_values] Failed fetching detailed error messages for range '%s': %s",
detailed_range,
exc,
)
# Format the output as a readable table
formatted_rows = []
for i, row in enumerate(values, 1):
# Pad row with empty strings to show structure
padded_row = row + [""] * max(0, len(values[0]) - len(row)) if values else row
formatted_rows.append(f"Row {i:2d}: {padded_row}")
text_output = (
f"Successfully read {len(values)} rows from range '{range_name}' in spreadsheet {spreadsheet_id} for {user_google_email}:\n"
+ "\n".join(formatted_rows[:50]) # Limit to first 50 rows for readability
+ (f"\n... and {len(values) - 50} more rows" if len(values) > 50 else "")
)
logger.info(f"Successfully read {len(values)} rows for {user_google_email}.")
return text_output + detailed_errors_section
@server.tool()
@handle_http_errors("modify_sheet_values", service_type="sheets")
@require_google_service("sheets", "sheets_write")
async def modify_sheet_values(
service,
user_google_email: str,
spreadsheet_id: str,
range_name: str,
values: Optional[Union[str, List[List[str]]]] = None,
value_input_option: str = "USER_ENTERED",
clear_values: bool = False,
) -> str:
"""
Modifies values in a specific range of a Google Sheet - can write, update, or clear values.
Args:
user_google_email (str): The user's Google email address. Required.
spreadsheet_id (str): The ID of the spreadsheet. Required.
range_name (str): The range to modify (e.g., "Sheet1!A1:D10", "A1:D10"). Required.
values (Optional[Union[str, List[List[str]]]]): 2D array of values to write/update. Can be a JSON string or Python list. Required unless clear_values=True.
value_input_option (str): How to interpret input values ("RAW" or "USER_ENTERED"). Defaults to "USER_ENTERED".
clear_values (bool): If True, clears the range instead of writing values. Defaults to False.
Returns:
str: Confirmation message of the successful modification operation.
"""
operation = "clear" if clear_values else "write"
logger.info(
f"[modify_sheet_values] Invoked. Operation: {operation}, Email: '{user_google_email}', Spreadsheet: {spreadsheet_id}, Range: {range_name}"
)
# Parse values if it's a JSON string (MCP passes parameters as JSON strings)
if values is not None and isinstance(values, str):
try:
parsed_values = json.loads(values)
if not isinstance(parsed_values, list):
raise ValueError(
f"Values must be a list, got {type(parsed_values).__name__}"
)
# Validate it's a list of lists
for i, row in enumerate(parsed_values):
if not isinstance(row, list):
raise ValueError(
f"Row {i} must be a list, got {type(row).__name__}"
)
values = parsed_values
logger.info(
f"[modify_sheet_values] Parsed JSON string to Python list with {len(values)} rows"
)
except json.JSONDecodeError as e:
raise UserInputError(f"Invalid JSON format for values: {e}")
except ValueError as e:
raise UserInputError(f"Invalid values structure: {e}")
if not clear_values and not values:
raise UserInputError(
"Either 'values' must be provided or 'clear_values' must be True."
)
if clear_values:
result = await asyncio.to_thread(
service.spreadsheets()
.values()
.clear(spreadsheetId=spreadsheet_id, range=range_name)
.execute
)
cleared_range = result.get("clearedRange", range_name)
text_output = f"Successfully cleared range '{cleared_range}' in spreadsheet {spreadsheet_id} for {user_google_email}."
logger.info(
f"Successfully cleared range '{cleared_range}' for {user_google_email}."
)
else:
body = {"values": values}
result = await asyncio.to_thread(
service.spreadsheets()
.values()
.update(
spreadsheetId=spreadsheet_id,
range=range_name,
valueInputOption=value_input_option,
# NOTE: This increases response payload/shape by including `updatedData`, but lets
# us detect Sheets error tokens (e.g. "#VALUE!", "#REF!") without an extra read.
includeValuesInResponse=True,
responseValueRenderOption="FORMATTED_VALUE",
body=body,
)
.execute
)
updated_cells = result.get("updatedCells", 0)
updated_rows = result.get("updatedRows", 0)
updated_columns = result.get("updatedColumns", 0)
detailed_errors_section = ""
updated_data = result.get("updatedData") or {}
updated_values = updated_data.get("values", []) or []
if updated_values and _values_contain_sheets_errors(updated_values):
updated_range = result.get("updatedRange", range_name)
detailed_range = (
_a1_range_for_values(updated_range, updated_values) or updated_range
)
try:
errors = await _fetch_detailed_sheet_errors(
service, spreadsheet_id, detailed_range
)
detailed_errors_section = _format_sheet_error_section(
errors=errors, range_label=detailed_range
)
except Exception as exc:
logger.warning(
"[modify_sheet_values] Failed fetching detailed error messages for range '%s': %s",
detailed_range,
exc,
)
text_output = (
f"Successfully updated range '{range_name}' in spreadsheet {spreadsheet_id} for {user_google_email}. "
f"Updated: {updated_cells} cells, {updated_rows} rows, {updated_columns} columns."
)
text_output += detailed_errors_section
logger.info(
f"Successfully updated {updated_cells} cells for {user_google_email}."
)
return text_output
@server.tool()
@handle_http_errors("format_sheet_range", service_type="sheets")
@require_google_service("sheets", "sheets_write")
async def format_sheet_range(
service,
user_google_email: str,
spreadsheet_id: str,
range_name: str,
background_color: Optional[str] = None,
text_color: Optional[str] = None,
number_format_type: Optional[str] = None,
number_format_pattern: Optional[str] = None,
) -> str:
"""
Applies formatting to a range: background/text color and number/date formats.
Colors accept hex strings (#RRGGBB). Number formats follow Sheets types
(e.g., NUMBER, NUMBER_WITH_GROUPING, CURRENCY, DATE, TIME, DATE_TIME,
PERCENT, TEXT, SCIENTIFIC). If no sheet name is provided, the first sheet
is used.
Args:
user_google_email (str): The user's Google email address. Required.
spreadsheet_id (str): The ID of the spreadsheet. Required.
range_name (str): A1-style range (optionally with sheet name). Required.
background_color (Optional[str]): Hex background color (e.g., "#FFEECC").
text_color (Optional[str]): Hex text color (e.g., "#000000").
number_format_type (Optional[str]): Sheets number format type (e.g., "DATE").
number_format_pattern (Optional[str]): Optional custom pattern for the number format.
Returns:
str: Confirmation of the applied formatting.
"""
logger.info(
"[format_sheet_range] Invoked. Email: '%s', Spreadsheet: %s, Range: %s",
user_google_email,
spreadsheet_id,
range_name,
)
if not any([background_color, text_color, number_format_type]):
raise UserInputError(
"Provide at least one of background_color, text_color, or number_format_type."
)
bg_color_parsed = _parse_hex_color(background_color)
text_color_parsed = _parse_hex_color(text_color)
number_format = None
if number_format_type:
allowed_number_formats = {
"NUMBER",
"NUMBER_WITH_GROUPING",
"CURRENCY",
"PERCENT",
"SCIENTIFIC",
"DATE",
"TIME",
"DATE_TIME",
"TEXT",
}
normalized_type = number_format_type.upper()
if normalized_type not in allowed_number_formats:
raise UserInputError(
f"number_format_type must be one of {sorted(allowed_number_formats)}."
)
number_format = {"type": normalized_type}
if number_format_pattern:
number_format["pattern"] = number_format_pattern
metadata = await asyncio.to_thread(
service.spreadsheets()
.get(
spreadsheetId=spreadsheet_id,
fields="sheets(properties(sheetId,title))",
)
.execute
)
sheets = metadata.get("sheets", [])
grid_range = _parse_a1_range(range_name, sheets)
user_entered_format = {}
fields = []
if bg_color_parsed:
user_entered_format["backgroundColor"] = bg_color_parsed
fields.append("userEnteredFormat.backgroundColor")
if text_color_parsed:
user_entered_format["textFormat"] = {"foregroundColor": text_color_parsed}
fields.append("userEnteredFormat.textFormat.foregroundColor")
if number_format:
user_entered_format["numberFormat"] = number_format
fields.append("userEnteredFormat.numberFormat")
if not user_entered_format:
raise UserInputError(
"No formatting applied. Verify provided colors or number format."
)
request_body = {
"requests": [
{
"repeatCell": {
"range": grid_range,
"cell": {"userEnteredFormat": user_entered_format},
"fields": ",".join(fields),
}
}
]
}
await asyncio.to_thread(
service.spreadsheets()
.batchUpdate(spreadsheetId=spreadsheet_id, body=request_body)
.execute
)
applied_parts = []
if bg_color_parsed:
applied_parts.append(f"background {background_color}")
if text_color_parsed:
applied_parts.append(f"text {text_color}")
if number_format:
nf_desc = number_format["type"]
if number_format_pattern:
nf_desc += f" (pattern: {number_format_pattern})"
applied_parts.append(f"format {nf_desc}")
summary = ", ".join(applied_parts)
return (
f"Applied formatting to range '{range_name}' in spreadsheet {spreadsheet_id} "
f"for {user_google_email}: {summary}."
)
@server.tool()
@handle_http_errors("add_conditional_formatting", service_type="sheets")
@require_google_service("sheets", "sheets_write")
async def add_conditional_formatting(
service,
user_google_email: str,
spreadsheet_id: str,
range_name: str,
condition_type: str,
condition_values: Optional[Union[str, List[Union[str, int, float]]]] = None,
background_color: Optional[str] = None,
text_color: Optional[str] = None,
rule_index: Optional[int] = None,
gradient_points: Optional[Union[str, List[dict]]] = None,
) -> str:
"""
Adds a conditional formatting rule to a range.
Args:
user_google_email (str): The user's Google email address. Required.
spreadsheet_id (str): The ID of the spreadsheet. Required.
range_name (str): A1-style range (optionally with sheet name). Required.
condition_type (str): Sheets condition type (e.g., NUMBER_GREATER, TEXT_CONTAINS, DATE_BEFORE, CUSTOM_FORMULA).
condition_values (Optional[Union[str, List[Union[str, int, float]]]]): Values for the condition; accepts a list or a JSON string representing a list. Depends on condition_type.
background_color (Optional[str]): Hex background color to apply when condition matches.
text_color (Optional[str]): Hex text color to apply when condition matches.
rule_index (Optional[int]): Optional position to insert the rule (0-based) within the sheet's rules.
gradient_points (Optional[Union[str, List[dict]]]): List (or JSON list) of gradient points for a color scale. If provided, a gradient rule is created and boolean parameters are ignored.
Returns:
str: Confirmation of the added rule.
"""
logger.info(
"[add_conditional_formatting] Invoked. Email: '%s', Spreadsheet: %s, Range: %s, Type: %s, Values: %s",
user_google_email,
spreadsheet_id,
range_name,
condition_type,
condition_values,
)
if rule_index is not None and (not isinstance(rule_index, int) or rule_index < 0):
raise UserInputError("rule_index must be a non-negative integer when provided.")
condition_values_list = _parse_condition_values(condition_values)
gradient_points_list = _parse_gradient_points(gradient_points)
sheets, sheet_titles = await _fetch_sheets_with_rules(service, spreadsheet_id)
grid_range = _parse_a1_range(range_name, sheets)
target_sheet = None
for sheet in sheets:
if sheet.get("properties", {}).get("sheetId") == grid_range.get("sheetId"):
target_sheet = sheet
break
if target_sheet is None:
raise UserInputError(
"Target sheet not found while adding conditional formatting."
)
current_rules = target_sheet.get("conditionalFormats", []) or []
insert_at = rule_index if rule_index is not None else len(current_rules)
if insert_at > len(current_rules):
raise UserInputError(
f"rule_index {insert_at} is out of range for sheet '{target_sheet.get('properties', {}).get('title', 'Unknown')}' "
f"(current count: {len(current_rules)})."
)
if gradient_points_list:
new_rule = _build_gradient_rule([grid_range], gradient_points_list)
rule_desc = "gradient"
values_desc = ""
applied_parts = [f"gradient points {len(gradient_points_list)}"]
else:
rule, cond_type_normalized = _build_boolean_rule(
[grid_range],
condition_type,
condition_values_list,
background_color,
text_color,
)
new_rule = rule
rule_desc = cond_type_normalized
values_desc = ""
if condition_values_list:
values_desc = f" with values {condition_values_list}"
applied_parts = []
if background_color:
applied_parts.append(f"background {background_color}")
if text_color:
applied_parts.append(f"text {text_color}")
new_rules_state = copy.deepcopy(current_rules)
new_rules_state.insert(insert_at, new_rule)
add_rule_request = {"rule": new_rule}
if rule_index is not None:
add_rule_request["index"] = rule_index
request_body = {"requests": [{"addConditionalFormatRule": add_rule_request}]}
await asyncio.to_thread(
service.spreadsheets()
.batchUpdate(spreadsheetId=spreadsheet_id, body=request_body)
.execute
)
format_desc = ", ".join(applied_parts) if applied_parts else "format applied"
sheet_title = target_sheet.get("properties", {}).get("title", "Unknown")
state_text = _format_conditional_rules_section(
sheet_title, new_rules_state, sheet_titles, indent=""
)
return "\n".join(
[
f"Added conditional format on '{range_name}' in spreadsheet {spreadsheet_id} "
f"for {user_google_email}: {rule_desc}{values_desc}; format: {format_desc}.",
state_text,
]
)
@server.tool()
@handle_http_errors("update_conditional_formatting", service_type="sheets")
@require_google_service("sheets", "sheets_write")
async def update_conditional_formatting(
service,
user_google_email: str,
spreadsheet_id: str,
rule_index: int,
range_name: Optional[str] = None,
condition_type: Optional[str] = None,
condition_values: Optional[Union[str, List[Union[str, int, float]]]] = None,
background_color: Optional[str] = None,
text_color: Optional[str] = None,
sheet_name: Optional[str] = None,
gradient_points: Optional[Union[str, List[dict]]] = None,
) -> str:
"""
Updates an existing conditional formatting rule by index on a sheet.
Args:
user_google_email (str): The user's Google email address. Required.
spreadsheet_id (str): The ID of the spreadsheet. Required.
range_name (Optional[str]): A1-style range to apply the updated rule (optionally with sheet name). If omitted, existing ranges are preserved.
rule_index (int): Index of the rule to update (0-based).
condition_type (Optional[str]): Sheets condition type. If omitted, the existing rule's type is preserved.
condition_values (Optional[Union[str, List[Union[str, int, float]]]]): Values for the condition.
background_color (Optional[str]): Hex background color when condition matches.
text_color (Optional[str]): Hex text color when condition matches.
sheet_name (Optional[str]): Sheet name to locate the rule when range_name is omitted. Defaults to first sheet.
gradient_points (Optional[Union[str, List[dict]]]): If provided, updates the rule to a gradient color scale using these points.
Returns:
str: Confirmation of the updated rule and the current rule state.
"""
logger.info(
"[update_conditional_formatting] Invoked. Email: '%s', Spreadsheet: %s, Range: %s, Rule Index: %s",
user_google_email,
spreadsheet_id,
range_name,
rule_index,
)
if not isinstance(rule_index, int) or rule_index < 0:
raise UserInputError("rule_index must be a non-negative integer.")
condition_values_list = _parse_condition_values(condition_values)
gradient_points_list = _parse_gradient_points(gradient_points)
sheets, sheet_titles = await _fetch_sheets_with_rules(service, spreadsheet_id)
target_sheet = None
grid_range = None
if range_name:
grid_range = _parse_a1_range(range_name, sheets)
for sheet in sheets:
if sheet.get("properties", {}).get("sheetId") == grid_range.get("sheetId"):
target_sheet = sheet
break
else:
target_sheet = _select_sheet(sheets, sheet_name)
if target_sheet is None:
raise UserInputError(
"Target sheet not found while updating conditional formatting."
)
sheet_props = target_sheet.get("properties", {})
sheet_id = sheet_props.get("sheetId")
sheet_title = sheet_props.get("title", f"Sheet {sheet_id}")
rules = target_sheet.get("conditionalFormats", []) or []
if rule_index >= len(rules):
raise UserInputError(
f"rule_index {rule_index} is out of range for sheet '{sheet_title}' (current count: {len(rules)})."
)
existing_rule = rules[rule_index]
ranges_to_use = existing_rule.get("ranges", [])
if range_name:
ranges_to_use = [grid_range]
if not ranges_to_use:
ranges_to_use = [{"sheetId": sheet_id}]
new_rule = None
rule_desc = ""
values_desc = ""
format_desc = ""
if gradient_points_list is not None:
new_rule = _build_gradient_rule(ranges_to_use, gradient_points_list)
rule_desc = "gradient"
format_desc = f"gradient points {len(gradient_points_list)}"
elif "gradientRule" in existing_rule:
if any([background_color, text_color, condition_type, condition_values_list]):
raise UserInputError(
"Existing rule is a gradient rule. Provide gradient_points to update it, or omit formatting/condition parameters to keep it unchanged."
)
new_rule = {
"ranges": ranges_to_use,
"gradientRule": existing_rule.get("gradientRule", {}),
}
rule_desc = "gradient"
format_desc = "gradient (unchanged)"
else:
existing_boolean = existing_rule.get("booleanRule", {})
existing_condition = existing_boolean.get("condition", {})
existing_format = copy.deepcopy(existing_boolean.get("format", {}))
cond_type = (condition_type or existing_condition.get("type", "")).upper()
if not cond_type:
raise UserInputError("condition_type is required for boolean rules.")
if cond_type not in CONDITION_TYPES:
raise UserInputError(
f"condition_type must be one of {sorted(CONDITION_TYPES)}."
)
if condition_values_list is not None:
cond_values = [
{"userEnteredValue": str(val)} for val in condition_values_list
]
else:
cond_values = existing_condition.get("values")
new_format = copy.deepcopy(existing_format) if existing_format else {}
if background_color is not None:
bg_color_parsed = _parse_hex_color(background_color)
if bg_color_parsed:
new_format["backgroundColor"] = bg_color_parsed
elif "backgroundColor" in new_format:
del new_format["backgroundColor"]
if text_color is not None:
text_color_parsed = _parse_hex_color(text_color)
text_format = copy.deepcopy(new_format.get("textFormat", {}))
if text_color_parsed:
text_format["foregroundColor"] = text_color_parsed
elif "foregroundColor" in text_format:
del text_format["foregroundColor"]
if text_format:
new_format["textFormat"] = text_format
elif "textFormat" in new_format:
del new_format["textFormat"]
if not new_format:
raise UserInputError("At least one format option must remain on the rule.")
new_rule = {
"ranges": ranges_to_use,
"booleanRule": {
"condition": {"type": cond_type},
"format": new_format,
},
}
if cond_values:
new_rule["booleanRule"]["condition"]["values"] = cond_values
rule_desc = cond_type
if condition_values_list:
values_desc = f" with values {condition_values_list}"
format_parts = []
if "backgroundColor" in new_format:
format_parts.append("background updated")
if "textFormat" in new_format and new_format["textFormat"].get(
"foregroundColor"
):
format_parts.append("text color updated")
format_desc = ", ".join(format_parts) if format_parts else "format preserved"
new_rules_state = copy.deepcopy(rules)
new_rules_state[rule_index] = new_rule
request_body = {
"requests": [
{
"updateConditionalFormatRule": {
"index": rule_index,
"sheetId": sheet_id,
"rule": new_rule,
}
}
]
}
await asyncio.to_thread(
service.spreadsheets()
.batchUpdate(spreadsheetId=spreadsheet_id, body=request_body)
.execute
)
state_text = _format_conditional_rules_section(
sheet_title, new_rules_state, sheet_titles, indent=""
)
return "\n".join(
[
f"Updated conditional format at index {rule_index} on sheet '{sheet_title}' in spreadsheet {spreadsheet_id} "
f"for {user_google_email}: {rule_desc}{values_desc}; format: {format_desc}.",
state_text,
]
)
@server.tool()
@handle_http_errors("delete_conditional_formatting", service_type="sheets")
@require_google_service("sheets", "sheets_write")
async def delete_conditional_formatting(
service,
user_google_email: str,
spreadsheet_id: str,
rule_index: int,
sheet_name: Optional[str] = None,
) -> str:
"""
Deletes an existing conditional formatting rule by index on a sheet.
Args:
user_google_email (str): The user's Google email address. Required.
spreadsheet_id (str): The ID of the spreadsheet. Required.
rule_index (int): Index of the rule to delete (0-based).
sheet_name (Optional[str]): Name of the sheet that contains the rule. Defaults to the first sheet if not provided.
Returns:
str: Confirmation of the deletion and the current rule state.
"""
logger.info(
"[delete_conditional_formatting] Invoked. Email: '%s', Spreadsheet: %s, Sheet: %s, Rule Index: %s",
user_google_email,
spreadsheet_id,
sheet_name,
rule_index,
)
if not isinstance(rule_index, int) or rule_index < 0:
raise UserInputError("rule_index must be a non-negative integer.")
sheets, sheet_titles = await _fetch_sheets_with_rules(service, spreadsheet_id)
target_sheet = _select_sheet(sheets, sheet_name)
sheet_props = target_sheet.get("properties", {})
sheet_id = sheet_props.get("sheetId")
target_sheet_name = sheet_props.get("title", f"Sheet {sheet_id}")
rules = target_sheet.get("conditionalFormats", []) or []
if rule_index >= len(rules):
raise UserInputError(
f"rule_index {rule_index} is out of range for sheet '{target_sheet_name}' (current count: {len(rules)})."
)
new_rules_state = copy.deepcopy(rules)
del new_rules_state[rule_index]
request_body = {
"requests": [
{
"deleteConditionalFormatRule": {
"index": rule_index,
"sheetId": sheet_id,
}
}
]
}
await asyncio.to_thread(
service.spreadsheets()
.batchUpdate(spreadsheetId=spreadsheet_id, body=request_body)
.execute
)
state_text = _format_conditional_rules_section(
target_sheet_name, new_rules_state, sheet_titles, indent=""
)
return "\n".join(
[
f"Deleted conditional format at index {rule_index} on sheet '{target_sheet_name}' in spreadsheet {spreadsheet_id} for {user_google_email}.",
state_text,
]
)
@server.tool()
@handle_http_errors("create_spreadsheet", service_type="sheets")
@require_google_service("sheets", "sheets_write")
async def create_spreadsheet(
service,
user_google_email: str,
title: str,
sheet_names: Optional[List[str]] = None,
) -> str:
"""
Creates a new Google Spreadsheet.
Args:
user_google_email (str): The user's Google email address. Required.
title (str): The title of the new spreadsheet. Required.
sheet_names (Optional[List[str]]): List of sheet names to create. If not provided, creates one sheet with default name.
Returns:
str: Information about the newly created spreadsheet including ID, URL, and locale.
"""
logger.info(
f"[create_spreadsheet] Invoked. Email: '{user_google_email}', Title: {title}"
)
spreadsheet_body = {"properties": {"title": title}}
if sheet_names:
spreadsheet_body["sheets"] = [
{"properties": {"title": sheet_name}} for sheet_name in sheet_names
]
spreadsheet = await asyncio.to_thread(
service.spreadsheets()
.create(
body=spreadsheet_body,
fields="spreadsheetId,spreadsheetUrl,properties(title,locale)",
)
.execute
)
properties = spreadsheet.get("properties", {})
spreadsheet_id = spreadsheet.get("spreadsheetId")
spreadsheet_url = spreadsheet.get("spreadsheetUrl")
locale = properties.get("locale", "Unknown")
text_output = (
f"Successfully created spreadsheet '{title}' for {user_google_email}. "
f"ID: {spreadsheet_id} | URL: {spreadsheet_url} | Locale: {locale}"
)
logger.info(
f"Successfully created spreadsheet for {user_google_email}. ID: {spreadsheet_id}"
)
return text_output
@server.tool()
@handle_http_errors("create_sheet", service_type="sheets")
@require_google_service("sheets", "sheets_write")
async def create_sheet(
service,
user_google_email: str,
spreadsheet_id: str,
sheet_name: str,
) -> str:
"""
Creates a new sheet within an existing spreadsheet.
Args:
user_google_email (str): The user's Google email address. Required.
spreadsheet_id (str): The ID of the spreadsheet. Required.
sheet_name (str): The name of the new sheet. Required.
Returns:
str: Confirmation message of the successful sheet creation.
"""
logger.info(
f"[create_sheet] Invoked. Email: '{user_google_email}', Spreadsheet: {spreadsheet_id}, Sheet: {sheet_name}"
)
request_body = {"requests": [{"addSheet": {"properties": {"title": sheet_name}}}]}
response = await asyncio.to_thread(
service.spreadsheets()
.batchUpdate(spreadsheetId=spreadsheet_id, body=request_body)
.execute
)
sheet_id = response["replies"][0]["addSheet"]["properties"]["sheetId"]
text_output = f"Successfully created sheet '{sheet_name}' (ID: {sheet_id}) in spreadsheet {spreadsheet_id} for {user_google_email}."
logger.info(
f"Successfully created sheet for {user_google_email}. Sheet ID: {sheet_id}"
)
return text_output