Analyticbase

io.github.CloudCorpRecords由 GitHub 账号 CloudCorpRecords 发布v0.1.0更新于 Nov 7, 2026

Query ClickHouse over HTTP: list databases and tables, run SELECT.

已验证STDIO仅桌面数据库数据与分析

概览

AI 生成的概览

只读的 ClickHouse MCP 服务器,让助手通过 HTTP 接口列出数据库和数据表,并执行受保护的 SELECT 查询。

可以做什么
  • 列出 ClickHouse 服务器上的数据库
  • 列出某个数据库中的表,含引擎、注释、行数和列数,可按 LIKE 模式过滤
  • 执行单条只读的 SELECT 或 WITH 查询,以按列名为键的 JSON 对象返回结果行
  • 连接失败或数据库报错时以工具错误返回,而不是编造数据行
适用场景
适合需要让助手查看或回答 ClickHouse 中数据问题、但不应具备修改能力的场景,例如了解表结构或做临时只读分析。
运行要求
以 stdio 本地进程运行,可通过 npx 或 Docker 镜像启动。需要可访问的 ClickHouse HTTP 端点,通过 CLICKHOUSE_URL 或 CLICKHOUSE_HOST 与 CLICKHOUSE_PORT 配置,并提供 CLICKHOUSE_USER 和 CLICKHOUSE_PASSWORD。清单未声明认证信息;即使后端不可达,服务器也能启动并列出工具。
安装前请注意
凭据会作为 URL 参数发送给 ClickHouse HTTP 接口,建议使用 TLS 和最小权限账号。只读保护基于关键字匹配,可能拒绝包含 update、drop 等词的正常查询;它只是过滤,不能替代数据库端权限控制。对大表执行查询可能开销较大。

安装

在 SourceWeft 中

  1. 打开 控制台中的 Analyticbase,将其添加到工作区。
  2. 为需要使用其工具的对话启用该服务。

Desktop only,通过 STDIO。 STDIO 服务会启动本地进程,因此需要 SourceWeft 桌面宿主。

其他 MCP 客户端

参照 仓库 中的启动说明。

README

analyticbase

analyticbase lets an agent — or you, at a terminal — look inside a ClickHouse database and ask it questions, without ever being able to change it. It lists the databases on a server, lists the tables in one database along with each table's engine, comment, row count and column count, and runs single read-only SELECT queries. Everything travels over ClickHouse's plain HTTP interface, so there is no client library bundled and no native port to tunnel.

When ClickHouse is not there, analyticbase says so. The MCP server starts and lists its tools with no server behind it at all; only an actual operation makes a request, and a refused connection or a server error comes back as an error carrying the server's own text — never as invented rows.

Install

bash
npx @reneturcios/analyticbase list-databases

Or run the container image:

bash
docker run -i ghcr.io/cloudcorprecords/analyticbase

The container defaults to the MCP server (see below). Pass CLI arguments to use it as a CLI instead.

CLI

bash
# Which databases does this server hold?analyticbase list-databases
# What tables live in one database? (name filters are LIKE patterns)analyticbase list-tables analyticsanalyticbase list-tables analytics --like "events_%" --not-like "%_tmp"
# Run one read-only query; rows print as JSONanalyticbase query "SELECT count() AS n FROM analytics.events"
# Start the MCP serveranalyticbase mcp
analyticbase --version

Exit codes: 0 on success, 1 when the query, the guard, or the connection fails (the error says which), 2 for usage errors.

The endpoint is configured through the environment:

VariableMeaningDefault
CLICKHOUSE_URLWhole base URL of the HTTP interface; overrides host and port—
CLICKHOUSE_HOSTHostname, or a full http(s):// URLlocalhost
CLICKHOUSE_PORTHTTP interface port8123
CLICKHOUSE_USERUsernamedefault
CLICKHOUSE_PASSWORDPassword(empty)

How the queries work

Each operation POSTs its SQL to the HTTP interface as the request body, with the credentials as URL parameters — the interface's own convention. The listing operations append FORMAT JSONEachRow and parse one JSON object per line; list_tables reads system.tables and counts each table's columns with a subquery over system.columns, applying the like / not_like filters as LIKE / NOT LIKE clauses with safely escaped literals. Select queries append FORMAT JSON and return the response's data array.

The read-only guard

run_select_query (and the CLI query command) accepts a query only if all of these hold:

  • After leading whitespace and comments are stripped, its first keyword is SELECT or WITH.
  • It is a single statement: a semicolon followed by anything other than whitespace ends the conversation.
  • None of INSERT, UPDATE, DELETE, DROP, ALTER, CREATE, TRUNCATE, GRANT, REVOKE, OPTIMIZE, RENAME, DETACH, or ATTACH appears as a whole word outside a string literal. Single-quoted literals are blanked out before scanning, so SELECT 'drop table t' is a fine query; a column literally named update is not — the guard would rather refuse an odd name than be talked around.

The listing operations build their SQL internally from validated, escaped pieces, so they need no guard.

MCP server

One bin serves both faces. The mcp subcommand starts a stdio MCP server:

bash
npx -y @reneturcios/analyticbase mcp

MCP client configuration:

json
{  "mcpServers": {    "analyticbase": {      "command": "npx",      "args": ["-y", "@reneturcios/analyticbase", "mcp"],      "env": { "CLICKHOUSE_HOST": "localhost", "CLICKHOUSE_PORT": "8123" }    }  }}

Tools

ToolInputWhat it returns
list_databases(none)One object per database, from system.databases.
list_tablesdatabase (string, required), like / not_like (strings, optional)One object per table in that database: its schema (database), name, engine, comment, row count, and column count.
run_select_queryquery (string, required) — one read-only SQL statementThe result rows as a JSON array of objects keyed by column name. Guard violations, a missing server, and database errors all come back as tool errors — never as made-up rows.

Development

bash
npm installnpm run build   # tsc -> dist/npm test        # node test runner over test/*.test.ts, no network, no live ClickHousenpm run dev     # run the CLI from source via tsx

All HTTP goes through an injectable fetch function, which is what the test suite drives: config resolution, the guard, SQL construction, both response-format parsers, and all three operations are covered against a fake fetch.

License

MIT — see LICENSE.

来源:README.md,提交 4f03e0f

工具

3

list_databases

List available ClickHouse databases

无需输入参数。

list_tables

List available ClickHouse tables in a database, including schema, comment, row count, and column count.

输入参数likedatabase必填not_like

run_select_query

Run a SELECT query in a ClickHouse database

输入参数query必填

版本历史

1
  1. v0.1.0最新Oct 31, 2026

评分

已满足适用检查项的 90%

该评分衡量此收录条目的完整程度,依据注册中心条目、端点与公开来源计算得出。它不是对服务器本身的评价,也不表示服务器安全或当前可用:可连通性是带日期的检查结果,评分也不包含安装量或用户评价。

  • 近 30 天内可连通25 分
  • 已声明认证方式10 分

    请在注册中心条目中声明凭据请求头,或保持端点能够响应探测,以便判定其认证方式。

  • 已列出工具必需15 分
  • 描述必需15 分
  • 图标10 分
  • 文档15 分
  • 许可证10 分