Skip to main content
Glama
KitchenSink4AI

io.github.nometalalchemist/kitchensink4xl

export_range

Export a range, table, or sheet to CSV, TSV, or JSON with cached or formula values. Handles file output with overwrite protection and returns inline text when no file is specified.

Instructions

Export a range, table, or sheet to CSV, TSV, or JSON. location defaults to the true used range; {table} exports a table. values is cached | formula | both; the result states the mode used. out_file writes a file; otherwise text returns inline. The target is guarded: never the source workbook, a workbook extension, a reserved device name, or .ks4xl-backups; an existing file needs overwrite, which keeps a .bak first. Filter-hidden rows export like any other row. Multi-sheet is export_file, io pack. Read-only.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
fmtNocsv
pathYes
sheetNo
headerNo
valuesNocached
recordsNo
locationNo
out_fileNo
overwriteNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.2.0
    • changedOutput schema / (root)
      Previous value: -{
      -  "additionalProperties": true,
      -  "type": "object"
      -}New value: +null
  2. Changed2 schema fields changedv1.1.0
    • addedInput schema / properties / location / anyOf
      Added value: +[
      +  {
      +    "type": "string"
      +  },
      +  {
      +    "type": "object"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • removedInput schema / properties / location / title
      Removed value: -"Location"
  3. First observedv1.0.0

TDQS

B3.2/5.0
Behavior1/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations set readOnlyHint to false, but the description ends with 'Read-only.' This is a direct contradiction. Additionally, the description itself notes 'out_file writes a file,' so even internally the read-only claim is misleading. The guard and backup details are useful, but the contradiction forces a score of 1.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is dense but well-organized: purpose first, then defaults, mode options, output behavior, file-safety guards, hidden-row handling, and the multi-sheet caveat. Every sentence carries information, though the packed style reduces skimmability.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The description covers defaults, mode reporting, file overwrite/backup behavior, target guard restrictions, and hidden-row behavior, which is strong for a tool with no output schema. However, the unclear meaning of the required 'path' parameter and the unaddressed header/records semantics leave it below complete.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the description must explain parameters. It covers location, values, out_file, overwrite, and fmt implicitly, but leaves path, sheet, header, and records unexplained. Path is required, making this a significant gap.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The opening clause states a specific verb ('Export'), resource ('a range, table, or sheet'), and target formats ('CSV, TSV, or JSON'), making the tool's function immediately distinct from read, copy, or import siblings.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description gives some context by noting that multi-sheet exports are handled elsewhere ('Multi-sheet is export_file, io pack') and that out_file vs inline text changes the result, but it never explicitly states when to prefer export_range over read_range or get_cells, nor lists alternatives.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.