
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.
概览
对本地 CSV、TSV 和 XLSX 文件执行只读 SQL,让助手就地查询数据,无需导入或上传文件。
- 可以做什么
- 对 CSV、TSV 和 XLSX(首个工作表)文件执行只读 SQL,支持连接、聚合、筛选和日期函数
- 查询前查看文件的列名和少量样例行
- 列出某个目录中可用的 CSV 文件
- 以 JSON 返回结果,每次调用约限制在 100 行 / 12 KB,避免大表占满上下文
- 适用场景
- 当助手需要回答关于本机或服务器上 CSV、表格文件中的问题时适用,希望就地查询而不是上传文件或开放通用数据库连接。
- 运行要求
- 需要本地安装可执行文件(Homebrew、预编译版本或 Claude Desktop 的一键 MCP 包);无需账号、API 密钥或网络。启动时必须指定数据目录,可通过安装命令或 --root 参数设置,因为它拒绝在文件系统根目录启动。
安装
在 SourceWeft 中
- 打开 控制台中的 csvql,将其添加到工作区。
- 为需要使用其工具的对话启用该服务。
Desktop only,通过 STDIO。 STDIO 服务会启动本地进程,因此需要 SourceWeft 桌面宿主。
其他 MCP 客户端
参照 仓库 中的启动说明。
README
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.
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,DELETEorDROP. Nothing writes to an input file. - No network. No
std.net,std.httpor socket call in the codebase. No telemetry, no update check.strace -f -e trace=networkshows an empty trace. - Sandboxed by default for agents.
csvql --mcponly opens files under its working directory and refuses to start in the filesystem root;--root /datapicks the folders instead, and--root /allows everything./etc/passwdand../traversal fail withPathOutsideAllowedRoot. - Private columns stay private.
--deny-columns email,ssnrefuses any query that reads those columns, in SELECT, WHERE, ORDER BY or a subquery, andSELECT *leaves them out. The agent can still runAVG(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 withOFFSETcan 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, noRIGHT/FULL/CROSS JOIN(inner and left hash joins only). The only subquery shape iscol IN (SELECT ...). These error rather than return wrong data. If you need full SQL, use DuckDB. - Scalar functions in
WHEREare limited toDATEDIFF,DATEADDandEXTRACT. Others (UPPER,ROUND, ...) areSELECT-only and currently fail inWHEREwith a misleadingColumnNotFound. - Excel files are read, not streamed.
FROM 'sales.xlsx'queries the first sheet (dates come out asYYYY-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,.xlsand.xlsbare not supported. - Quoted CSV is about 3x slower than unquoted. Quotes disable the 16-byte skip the scanner relies on.
MEDIANbuffers every value in a group, so on 20M rows it is 5x slower than DuckDB (#205). High-cardinalityGROUP 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
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
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:
VS Code (Copilot) takes the same command/args under servers in .vscode/mcp.json with "type": "stdio".
Tools
The agent writes ordinary SQL against single-quoted paths:
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:
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.
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):
Prebuilt binaries from GitHub Releases:
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:
From source, Zig 0.15.2:
Shell completions for bash and zsh live in completions/. They complete the flags in csvql --help, the install subcommand and file paths.
Performance
Same GROUP BY department on raw CSV, one process per engine, Apple M2 Pro with 16 GB. Peak memory and wall time:
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).
Full syntax and limitations: SQL_REFERENCE.md. What is differentially tested against DuckDB: CORRECTNESS.md.
Documentation
Planned
- HTTP/SSE MCP transport, so one csvql can serve a team as a shared service (#60).
MEDIANin 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版本历史
5- v3.0.2最新Nov 4, 2026
- v3.0.1Nov 3, 2026
- v2.10.0Oct 30, 2026
- v2.9.0Oct 7, 2026
- v2.7.0Sep 16, 2026
评分
已满足适用检查项的 50%
该评分衡量此收录条目的完整程度,依据注册中心条目、端点与公开来源计算得出。它不是对服务器本身的评价,也不表示服务器安全或当前可用:可连通性是带日期的检查结果,评分也不包含安装量或用户评价。
- 近 30 天内可连通25 分
请保持端点能够响应 MCP 握手;SourceWeft 每 30 天探测一次。
- 已声明认证方式10 分
请在注册中心条目中声明凭据请求头,或保持端点能够响应探测,以便判定其认证方式。
- 已列出工具15 分
请让服务器在无凭据时响应 tools/list,或发布可在沙箱中无凭据启动的软件包。
- 描述必需15 分
- 图标10 分
- 文档15 分
- 许可证10 分
