get_table_metadata_tool
Extract detailed metadata about tables in Google Sheets, including structure, columns, data types, formatting, and statistics. Specify sheets, tables, and metadata options for precise insights.
Instructions
Get comprehensive metadata for tables in Google Sheets.
This tool provides detailed information about table structure, columns, data types,
formatting, statistics, and other properties. If no table name is provided, returns
metadata for all tables.
Args:
spreadsheet_name: Name of the spreadsheet
sheet_name: Name of the sheet containing the table
table_name: Name of the table to get metadata for (optional)
include_sample_data: Whether to include sample data rows
include_formulas: Whether to include formula information
include_formatting: Whether to include cell formatting details
include_statistics: Whether to include data statistics
max_sample_rows: Maximum number of sample rows to return
specific_columns: List of column names to get metadata for (optional)
exclude_metadata_types: List of metadata types to exclude
Returns:
JSON string containing table metadata or list of all tables
Input Schema
Name | Required | Description | Default |
---|---|---|---|
exclude_metadata_types | No | List of metadata types to exclude (e.g., ['sample_data', 'formatting', 'statistics', 'merges', 'conditional_formatting', 'filters']) | |
include_formatting | No | Whether to include cell formatting details | |
include_formulas | No | Whether to include formula information | |
include_sample_data | No | Whether to include sample data rows | |
include_statistics | No | Whether to include data statistics | |
max_sample_rows | No | Maximum number of sample rows to return | |
sheet_name | Yes | The name of the sheet containing the table | |
specific_columns | No | List of column names to get metadata for (optional) | |
spreadsheet_name | Yes | The name of the Google Spreadsheet | |
table_name | No | Name of the table to get metadata for. If not provided, returns metadata for all tables in the sheet. |
Input Schema (JSON Schema)
{
"properties": {
"exclude_metadata_types": {
"default": null,
"description": "List of metadata types to exclude (e.g., ['sample_data', 'formatting', 'statistics', 'merges', 'conditional_formatting', 'filters'])",
"items": {
"type": "string"
},
"title": "Exclude Metadata Types",
"type": "array"
},
"include_formatting": {
"default": false,
"description": "Whether to include cell formatting details",
"title": "Include Formatting",
"type": "boolean"
},
"include_formulas": {
"default": false,
"description": "Whether to include formula information",
"title": "Include Formulas",
"type": "boolean"
},
"include_sample_data": {
"default": false,
"description": "Whether to include sample data rows",
"title": "Include Sample Data",
"type": "boolean"
},
"include_statistics": {
"default": false,
"description": "Whether to include data statistics",
"title": "Include Statistics",
"type": "boolean"
},
"max_sample_rows": {
"default": 5,
"description": "Maximum number of sample rows to return",
"title": "Max Sample Rows",
"type": "integer"
},
"sheet_name": {
"description": "The name of the sheet containing the table",
"title": "Sheet Name",
"type": "string"
},
"specific_columns": {
"default": null,
"description": "List of column names to get metadata for (optional)",
"items": {
"type": "string"
},
"title": "Specific Columns",
"type": "array"
},
"spreadsheet_name": {
"description": "The name of the Google Spreadsheet",
"title": "Spreadsheet Name",
"type": "string"
},
"table_name": {
"default": null,
"description": "Name of the table to get metadata for. If not provided, returns metadata for all tables in the sheet.",
"title": "Table Name",
"type": "string"
}
},
"required": [
"spreadsheet_name",
"sheet_name"
],
"title": "get_table_metadata_toolArguments",
"type": "object"
}