sheets_clear_values

Clear specified ranges of data in Google Sheets by defining the spreadsheet ID and A1 notation range. Simplify data management and maintain clean spreadsheets.

Instructions

Clear values in a specified range of a Google Sheets spreadsheet

Input Schema

TableJSON Schema

Name	Required	Description	Default
`range`	Yes	The A1 notation range to clear (e.g., "Sheet1!A1:B10")
`spreadsheetId`	Yes	The ID of the spreadsheet (found in the URL after /d/)

Implementation Reference

src/tools/clear-values.ts:26-40 (handler)

The main handler function for the 'sheets_clear_values' tool. It validates the input, authenticates with Google Sheets API, clears the specified range, and returns a formatted response or handles errors.

export async function handleClearValues(input: any) {
  try {
    const validatedInput = validateClearValuesInput(input);
    const sheets = await getAuthenticatedClient();

    const response = await sheets.spreadsheets.values.clear({
      spreadsheetId: validatedInput.spreadsheetId,
      range: validatedInput.range,
    });

    return formatClearResponse(response.data.clearedRange || validatedInput.range);
  } catch (error) {
    return handleError(error);
  }
}

src/tools/clear-values.ts:7-24 (schema)

Tool definition including the input schema for 'sheets_clear_values', specifying required spreadsheetId and range parameters.

export const clearValuesTool: Tool = {
  name: 'sheets_clear_values',
  description: 'Clear values in a specified range of a Google Sheets spreadsheet',
  inputSchema: {
    type: 'object',
    properties: {
      spreadsheetId: {
        type: 'string',
        description: 'The ID of the spreadsheet (found in the URL after /d/)',
      },
      range: {
        type: 'string',
        description: 'The A1 notation range to clear (e.g., "Sheet1!A1:B10")',
      },
    },
    required: ['spreadsheetId', 'range'],
  },
};

src/index.ts:32-64 (registration)

Registration of the tool handler in the central toolHandlers Map used by the MCP server to dispatch tool calls.

const toolHandlers = new Map<string, (input: any) => Promise<any>>([
  ['sheets_check_access', tools.handleCheckAccess],
  ['sheets_get_values', tools.handleGetValues],
  ['sheets_batch_get_values', tools.handleBatchGetValues],
  ['sheets_get_metadata', tools.handleGetMetadata],
  ['sheets_update_values', tools.handleUpdateValues],
  ['sheets_batch_update_values', tools.handleBatchUpdateValues],
  ['sheets_append_values', tools.handleAppendValues],
  ['sheets_clear_values', tools.handleClearValues],
  ['sheets_create_spreadsheet', tools.handleCreateSpreadsheet],
  ['sheets_insert_sheet', tools.handleInsertSheet],
  ['sheets_delete_sheet', tools.handleDeleteSheet],
  ['sheets_duplicate_sheet', tools.handleDuplicateSheet],
  ['sheets_copy_to', tools.handleCopyTo],
  ['sheets_update_sheet_properties', tools.handleUpdateSheetProperties],
  ['sheets_format_cells', tools.formatCellsHandler],
  ['sheets_update_borders', tools.updateBordersHandler],
  ['sheets_merge_cells', tools.mergeCellsHandler],
  ['sheets_unmerge_cells', tools.unmergeCellsHandler],
  ['sheets_add_conditional_formatting', tools.addConditionalFormattingHandler],
  // Batch operations
  ['sheets_batch_delete_sheets', tools.handleBatchDeleteSheets],
  ['sheets_batch_format_cells', tools.handleBatchFormatCells],
  // Chart operations
  ['sheets_create_chart', tools.handleCreateChart],
  ['sheets_update_chart', tools.handleUpdateChart],
  ['sheets_delete_chart', tools.handleDeleteChart],
  // Link and date operations
  ['sheets_insert_link', tools.handleInsertLink],
  ['sheets_insert_date', tools.handleInsertDate],
  // Row operations
  ['sheets_insert_rows', tools.handleInsertRows],
]);

src/index.ts:67-98 (registration)

Registration of the tool definition in the allTools array used for listing available tools.

const allTools = [
  tools.checkAccessTool,
  tools.getValuesTool,
  tools.batchGetValuesTool,
  tools.getMetadataTool,
  tools.updateValuesTool,
  tools.batchUpdateValuesTool,
  tools.appendValuesTool,
  tools.clearValuesTool,
  tools.createSpreadsheetTool,
  tools.insertSheetTool,
  tools.deleteSheetTool,
  tools.duplicateSheetTool,
  tools.copyToTool,
  tools.updateSheetPropertiesTool,
  tools.formatCellsTool,
  tools.updateBordersTool,
  tools.mergeCellsTool,
  tools.unmergeCellsTool,
  tools.addConditionalFormattingTool,
  // Batch operations
  tools.batchDeleteSheetsTool,
  tools.batchFormatCellsTool,
  // Chart operations
  tools.createChartTool,
  tools.updateChartTool,
  tools.deleteChartTool,
  // Link and date operations
  tools.insertLinkTool,
  tools.insertDateTool,
  // Row operations
  tools.insertRowsTool,

mcp-gsheets