csvql

io.github.melihbirim由 GitHub 帳號 melihbirim 發布v3.0.2更新於 Nov 4, 2026

Read-only SQL on CSV files for AI agents. No writes, no network; --root confines file access.

已驗證STDIO僅桌面檔案與儲存資料與分析

概覽

AI 產生的概覽

對本機 CSV、TSV 與 XLSX 檔案執行唯讀 SQL,讓助理就地查詢資料,不必匯入或上傳檔案。

可以做什麼
  • 對 CSV、TSV 與 XLSX(第一個工作表)檔案執行唯讀 SQL,支援合併、彙總、篩選與日期函式
  • 查詢前檢視檔案的欄位名稱與少量範例資料列
  • 列出某個目錄中可用的 CSV 檔案
  • 以 JSON 回傳結果,每次呼叫約限制在 100 列 / 12 KB,避免大表佔滿上下文
適用情境
當助理需要回答關於本機或伺服器上 CSV、試算表檔案的問題時適用,希望就地查詢,而不是上傳檔案或開放一般資料庫連線。
執行需求
需要在本機安裝執行檔(Homebrew、預先編譯版本或 Claude Desktop 的一鍵 MCP 套件);不需要帳號、API 金鑰或網路。啟動時必須指定資料夾,可透過安裝指令或 --root 參數設定,因為它拒絕在檔案系統根目錄啟動。
安裝前請注意
設計上為唯讀:沒有寫入語句、沒有網路程式碼,檔案存取被限制在允許的根目錄內。輸出依每次呼叫限流,但助理仍可用 OFFSET 分頁讀取整張表,敏感欄位應以 --deny-columns 排除。選用的 --audit 會把每次查詢記錄到檔案。SQL 支援不完整(無 UNION、視窗函式與右/全/交叉合併),部分函式在 WHERE 中會出錯。

安裝

在 SourceWeft 中

  1. 開啟 儀表板中的 csvql,將其新增到工作區。
  2. 為需要使用其工具的對話啟用該服務。

Desktop only,透過 STDIO。 STDIO 服務會啟動本機處理程序,因此需要 SourceWeft 桌面主機。

其他 MCP 客戶端

參照 儲存庫 中的啟動說明。

README

[csvql]

[CI] [License: MIT] [Release]

Give an AI agent SQL over your CSV files, not your computer. Out of the box it can't write, can't reach the network, can't leave its folder, and can't pour a whole table into the context.

A database is something you load your data into. csvql is a query you run on the data where it already lives.

csvql runs SELECT on CSV files where they sit: no import, no ingest, no server. It ships as an MCP server, so an agent can ask a question of a gigabyte file and get back a few hundred tokens instead of the file. Safe by construction, not by configuration: the SQL has no write statements and the binary has no network code. It is about as fast as DuckDB and polars on raw CSV and uses 3 to 11x less memory.

bash
$ csvql "SELECT cab_type, COUNT(*) FROM 'trips.csv' GROUP BY cab_type"cab_type,COUNT(*)green,32447yellow,967553

Website · Quick Start · For agents · Install · Performance · SQL · Docs


Why this exists

Agents are getting access to company data. The usual paths are a database connection or uploading files to the model. Both move the data. csvql is the third option: run it next to the data, on your own box, and let the agent query it there. Everything below is checkable in the source.

  • Read-only by construction. The parser has no INSERT, UPDATE, DELETE or DROP. Nothing writes to an input file.
  • No network. No std.net, std.http or socket call in the codebase. No telemetry, no update check. strace -f -e trace=network shows an empty trace.
  • Sandboxed by default for agents. csvql --mcp only opens files under its working directory and refuses to start in the filesystem root; --root /data picks the folders instead, and --root / allows everything. /etc/passwd and ../ traversal fail with PathOutsideAllowedRoot.
  • Private columns stay private. --deny-columns email,ssn refuses any query that reads those columns, in SELECT, WHERE, ORDER BY or a subquery, and SELECT * leaves them out. The agent can still run AVG(salary) GROUP BY dept.
  • Bounded output. MCP results are capped at about 100 rows / 12 KB per call. A careless SELECT * cannot flood the context. The cap is per call, so an agent that pages with OFFSET can still read a whole table; keep data it must never see out with --deny-columns.
  • Flat memory. An aggregate holds a running accumulator, not a dataset: 74 MB on a 0.7 GB file and 74 MB on an 8 GB one. It fits on the small VM beside the data.
  • Auditable. --audit <file> appends one JSONL record per query. Over SSH you inherit your existing keys, bastion and logs.

Full posture, including two known gaps on macOS and Windows: SECURITY.md.

What it does not do

  • It is not a database. No UNION, no window functions, no RIGHT/FULL/CROSS JOIN (inner and left hash joins only). The only subquery shape is col IN (SELECT ...). These error rather than return wrong data. If you need full SQL, use DuckDB.
  • Scalar functions in WHERE are limited to DATEDIFF, DATEADD and EXTRACT. Others (UPPER, ROUND, ...) are SELECT-only and currently fail in WHERE with a misleading ColumnNotFound.
  • Excel files are read, not streamed. FROM 'sales.xlsx' queries the first sheet (dates come out as YYYY-MM-DD, formulas as their saved value), but the sheet is unpacked in memory first: a 9 MB, 300k row workbook takes about 230 MB and 0.6 s. Other sheets, .xls and .xlsb are not supported.
  • Quoted CSV is about 3x slower than unquoted. Quotes disable the 16-byte skip the scanner relies on.
  • MEDIAN buffers every value in a group, so on 20M rows it is 5x slower than DuckDB (#205). High-cardinality GROUP BY (millions of groups) is also slower.
  • CSV only. JSON and JSONL are output formats, not input formats.

Full list with tracking issues: SQL_REFERENCE.md#known-limitations.

Quick Start

bash
# SQL modecsvql "SELECT name, salary FROM 'data.csv' WHERE age > 30 ORDER BY salary DESC LIMIT 10"
# Simple mode: same query, positionalcsvql data.csv "name,salary" "age>30" 10 "salary:desc"
# Pipescat data.csv | csvql "SELECT name, age FROM '-' WHERE age > 25"csvql "SELECT * FROM 'data.csv' WHERE status = 'active'" > output.csv
# Other formatscsvql "SELECT name, age FROM 'data.tsv'" -d $'\t'csvql "SELECT name, age FROM 'data.csv' LIMIT 3" --json      # or --jsonl, --markdown
# What is in this file?csvql --schema data.csv

Flags: -d/--delimiter, --json, --jsonl, --markdown, --no-header, --no-input-header (headerless files get c1..cN), -o/--output, --threads, --strict, --schema, --root, --deny-columns, --audit, --mcp. Details in csvql --help. Simple mode: SIMPLE_QUERY_LANGUAGE.md.

For agents (MCP)

Setup

bash
cd ~/data && csvql install    # registers csvql in Claude Code and Claude Desktop; --print to dry-run

It runs claude mcp add if the Claude Code CLI is present and merges an mcpServers.csvql entry into the Claude Desktop config, preserving your other servers. Claude Desktop starts MCP servers in /, so the Desktop entry gets --root set to the folder you ran install from (or --root <folder>). Without a --root, csvql --mcp refuses to start in the filesystem root. Restart Claude afterward.

Without MCP, a Claude Code skill teaches the agent to use the csvql CLI whenever a CSV comes up: claude plugin marketplace add melihbirim/csvql then claude plugin install csvql@csvql.

Alternatives: a one-click csvql-<platform>.mcpb bundle for Claude Desktop on the Releases page (Settings → Extensions), which asks for the data folder on install, or a manual entry:

json
{ "mcpServers": { "csvql": { "command": "/usr/local/bin/csvql", "args": ["--mcp", "--root", "/data"] } } }

VS Code (Copilot) takes the same command/args under servers in .vscode/mcp.json with "type": "stdio".

Tools

ToolReturns
csv_query(sql)Results as JSON, capped at about 100 rows / 12 KB
csv_schema(file)Column names and a few sample rows
csv_list(directory?)CSV files in a directory

The agent writes ordinary SQL against single-quoted paths:

sql
SELECT customer, SUM(revenue) AS total FROM 'sales.csv' GROUP BY customer ORDER BY total DESC LIMIT 10SELECT STRFTIME('%Y-%m', order_date) AS month, COUNT(*) FROM 'orders.csv' GROUP BY month ORDER BY 1SELECT o.id, c.name FROM 'orders.csv' o JOIN 'customers.csv' c ON o.customer_id = c.id WHERE c.region = 'West'

Remote and on-prem

Run csvql on the server next to the data and connect over SSH. Only the SQL and the small result cross the wire. No open port, no reverse proxy, no new credentials:

jsonc
// client MCP config; csvql runs on the remote server{ "command": "ssh", "args": ["analyst@dataserver", "csvql", "--mcp", "--root", "/data"] }

Without --root, --mcp is confined to the directory it was started in. Set --root explicitly when an agent or another user can reach csvql, since that directory depends on how the client launches the server. Pair it with an unprivileged OS user and a read-only mount. Checklist: SECURITY.md#hardening-for-on-prem-and-remote-access.

What an agent can do, out of the box

Default settings, no hardening flags. DuckDB is the CLI an agent with a shell would call; it can be locked down with SET enable_external_access = false and read-only mode, but only if someone remembers to.

An agent asks the tool to...csvql --mcpDuckDB 1.5 CLI
write a file (COPY ... TO 'x.csv')no, there is no write statementyes
read /etc/hosts or ../ outside its folderno, PathOutsideAllowedRootyes
fetch a URL or install an extensionno, no network codeyes (enable_external_access and autoinstall_known_extensions default to true)
return a whole large table in one callno, about 100 rows / 12 KB capyes
read a column you marked privateno, with --deny-columns emailyes, unless you build views and only expose those
peak memory, GROUP BY on a 0.72 GB file54 MB221 MB (polars 2.0: 1137 MB)

Check the DuckDB column yourself: duckdb -c "COPY (SELECT 1) TO 'x.csv'" and duckdb -c "SELECT current_setting('enable_external_access')".

Token cost

Five questions about a taxi dataset cost about 640 tokens over MCP, tool schema included, and the cost does not change with file size. Pasting the 417 MB file would cost about 230 million tokens, which is a feasibility argument, not a savings figure. An agent that already has a shell and runs duckdb -csv uses slightly fewer tokens than csvql over MCP, because MCP returns JSON. The case for csvql with agents is --root, read-only execution, the output cap and memory, not token count. Measure it: bench/bench_tokens.py.

Installation

Homebrew (macOS / Linux):

bash
brew install melihbirim/csvql/csvql

Prebuilt binaries from GitHub Releases:

bash
# macOS (Apple Silicon)curl -L https://github.com/melihbirim/csvql/releases/latest/download/csvql-macos-aarch64.tar.gz | tar xzsudo mv csvql-macos-aarch64 /usr/local/bin/csvql
# macOS (Intel)curl -L https://github.com/melihbirim/csvql/releases/latest/download/csvql-macos-x86_64.tar.gz | tar xzsudo mv csvql-macos-x86_64 /usr/local/bin/csvql
# Linux (x86_64)curl -L https://github.com/melihbirim/csvql/releases/latest/download/csvql-linux-x86_64.tar.gz | tar xzsudo mv csvql-linux-x86_64 /usr/local/bin/csvql

Windows (x86_64): download csvql-windows-x86_64.zip from the same page and put csvql-windows-x86_64.exe on your PATH.

Libraries, same engine, no subprocess:

bash
pip install csvql-query      # Python: csvql.query(), .query_df(), .query_csv()   → docs/PYTHON.mdnpm install csvql-query      # Node.js: require('csvql-query'), plus a `csvql-query` CLI → docs/NODE.md

From source, Zig 0.15.2:

bash
git clone https://github.com/melihbirim/csvql.git && cd csvqlzig build -Doptimize=ReleaseFastsudo cp zig-out/bin/csvql /usr/local/bin/

Shell completions for bash and zsh live in completions/. They complete the flags in csvql --help, the install subcommand and file paths.

bash
# bash: add to ~/.bashrc (on macOS, Terminal opens login shells, so use ~/.bash_profile)source /path/to/csvql/completions/csvql.bash
# zsh: put _csvql in a directory on your fpathmkdir -p ~/.zsh/completionscp completions/_csvql ~/.zsh/completions/_csvql# then in ~/.zshrc, before compinit runs:#   fpath=(~/.zsh/completions $fpath)#   autoload -Uz compinit && compinit

Performance

Same GROUP BY department on raw CSV, one process per engine, Apple M2 Pro with 16 GB. Peak memory and wall time:

FilecsvqlDuckDBpolars 2.0
0.69 GB74 MB / 0.2s254 MB / 0.8s1151 MB / 0.6s
1.89 GB74 MB / 0.4s253 MB / 1.2s2107 MB / 1.1s
3.80 GB75 MB / 0.7s275 MB / 2.1s2666 MB / 9.8s
8.14 GB74 MB / 2.4s367 MB / 5.5s1754 MB / 26.7s

Memory is flat because an aggregate holds an accumulator, not a dataset. That holds for aggregates, not for ORDER BY, which has to keep rows. Speed is in the same band as the other two: csvql is 2 to 5x ahead on scans, filters and small files, far ahead on joins against raw CSV, level with polars on COUNT(*) and top-N, and behind DuckDB on MEDIAN and on GROUP BY with millions of groups. None of that matters on an agent's timescale. The memory does, because it decides what box csvql can run on.

Every number has a reproduce script. Full tables, including quoted CSV, wide files, joins, subqueries and the losses: BENCHMARKS.md.

SQL

Files: .csv, .tsv (with -d '\t') and .xlsx (first sheet). SELECT / FROM / WHERE / GROUP BY / HAVING / ORDER BY / LIMIT / OFFSET, JOIN and LEFT JOIN (chained), col IN (SELECT ...), LIKE / ILIKE / BETWEEN / IS NULL / AND / OR / NOT, DISTINCT, CASE WHEN, arithmetic (+ - * / in SELECT, WHERE, inside aggregates and over their results: SUM(price * qty), WHERE price * qty > 100, SUM(a) / COUNT(*)), column names with spaces as "First Name", `First Name` or [First Name]. Aggregates: COUNT, SUM, AVG, MIN, MAX, VARIANCE, STDDEV, MEDIAN, QUANTILE, MODE, GROUP_CONCAT, COUNT(DISTINCT). Scalars in SELECT: string (UPPER, LOWER, TRIM, LENGTH, REVERSE, CONCAT, LTRIM, RTRIM, LEFT, RIGHT, REPEAT, POSITION, INSTR, SUBSTR, REPLACE, SPLIT_PART, LPAD, RPAD), math (ABS, SIGN, CEIL, FLOOR, MOD, ROUND, TRUNC, SQRT, POWER, LN, LOG, EXP, GREATEST, LEAST), CAST, COALESCE, NULLIF, IFNULL, dates (STRFTIME, DATE_PART, EXTRACT, DATEDIFF, DATEADD, CURRENT_DATE, NOW(), CURRENT_TIMESTAMP).

bash
csvql "SELECT department, COUNT(*), AVG(salary) FROM 'data.csv' WHERE salary > 50000 GROUP BY department HAVING COUNT(*) > 10 ORDER BY department"csvql "SELECT e.name, d.dept_name FROM 'employees.csv' e JOIN 'departments.csv' d ON e.dept_id = d.id WHERE d.dept_name = 'Engineering'"csvql "SELECT id FROM 'orders.csv' WHERE customer_id IN (SELECT id FROM 'customers.csv' WHERE region = 'EU')"

Full syntax and limitations: SQL_REFERENCE.md. What is differentially tested against DuckDB: CORRECTNESS.md.

Documentation

DocumentDescription
SQL_REFERENCE.mdFull SQL syntax, runnable examples, DuckDB differences, limitations
SECURITY.mdSecurity posture, network and disk-write guarantees, hardening
CORRECTNESS.mdWhat is tested against DuckDB, how, known gaps, error behaviour
BENCHMARKS.mdFull performance analysis vs DuckDB, polars, pandas, DataFusion
ARCHITECTURE.mdEngine design, optimization techniques
SIMPLE_QUERY_LANGUAGE.mdSimple mode syntax reference
docs/PYTHON.md · docs/NODE.md · docs/LIBRARY.mdPython, Node.js and Zig library APIs
CONTRIBUTING.mdContribution guidelines

Planned

  • HTTP/SSE MCP transport, so one csvql can serve a team as a shared service (#60).
  • MEDIAN in O(groups) memory (#205).

Shipped features are in the release notes. Good first issues are scoped with file pointers and done-when criteria.

License

MIT, see LICENSE.md.

來源:README.md,提交 7363889

工具

0
SourceWeft 曾在隔離沙箱中以無憑證方式啟動該軟體包一次,以列出其工具,但未能完成:該軟體包類型無法在沙箱中執行。

版本歷史

5
  1. v3.0.2最新Nov 4, 2026
  2. v3.0.1Nov 3, 2026
  3. v2.10.0Oct 30, 2026
  4. v2.9.0Oct 7, 2026
  5. v2.7.0Sep 16, 2026

評分

已滿足適用檢查項的 50%

該評分衡量此收錄條目的完整程度,依據註冊中心條目、端點與公開來源計算得出。它不是對伺服器本身的評價,也不表示伺服器安全或目前可用:可連通性是帶日期的檢查結果,評分也不包含安裝量或使用者評價。

  • 近 30 天內可連通25 分

    請保持端點能夠回應 MCP 握手;SourceWeft 每 30 天探測一次。

  • 已宣告認證方式10 分

    請在註冊中心條目中宣告憑證請求標頭,或保持端點能夠回應探測,以便判定其認證方式。

  • 已列出工具15 分

    請讓伺服器在無憑證時回應 tools/list,或發布可在沙箱中無憑證啟動的軟體包。

  • 描述必需15 分
  • 圖示10 分
  • 文件15 分
  • 授權條款10 分