Showboard

Showboard 是一个 MCP 服务，可让 Claude Code、Codex、Cursor、Gemini CLI 和其他编码 Agent 针对你的 SQL 数据库或一组 Excel 和 CSV 文件回答问题，并生成图表、表格和关键数字：可在浏览器中、自己的应用内或终端旁查看。

Agent 会编写几个只读 SQL 查询和一段简短布局。Showboard 会运行查询，为每个结果选择图表、排布仪表板并显示在屏幕上。每个数字都来自查询，只需点击图表即可查看。

让 Agent 为你设置

在项目中，向你的编码 Agent 提出要求：

在此项目中设置 Showboard：运行 npx showboard guide 并按指引操作。

该指引是为 Agent 编写的。它会让 Agent 选择适合项目的方案（电子表格、数据库或你自己的应用），运行命令，并通过 npx showboard doctor 检查设置。doctor 会按照各个 Agent 实际使用的方式启动 Showboard，并说明如何修复任何失败项。

或者手动设置

你需要 Node.js 22.13 或更高版本。

一组电子表格，或一个数据库：

npx showboard init ./reports                 # .xlsx, .xlsm, .csv, .tsv files or folders of them
npx showboard init --db ./shop.sqlite        # or a Postgres URL (or set SHOWBOARD_DB)
npx showboard doctor                         # checks the setup

在该文件夹中重启 Agent，然后打开 http://localhost:4710，或在 Agent 旁边的终端中运行 npx showboard pane。init 会写入 Claude Code 的设置，以及该文件夹中已有设置的其他 Agent。要指定其他 Agent，请传入 --agent codex,opencode,bharatcode,gemini,cursor,vscode（或 all）。

在你自己的应用中（React 19）：

npm install showboard zod

// server: mount the handler. Next.js, Express, Hono and node:http are in the guide.
import { createShowboard } from "showboard/server";

const showboard = await createShowboard({ db: process.env.DATABASE_URL, boardsDir: ".showboard/boards" });
const handle = showboard.handler({ basePath: "/showboard" });   // (req: Request) => Promise<Response>

// page: where boards appear
import { Board, ShowboardProvider } from "showboard/react";
import "showboard/styles.css";

<ShowboardProvider url="/showboard">
  <Board />
</ShowboardProvider>;

然后将 Agent 指向该应用：npx showboard init --url http://localhost:3000/showboard。

命令

命令	功能
showboard guide	为编码 Agent 提供设置步骤
showboard init	将 Showboard 添加到此文件夹中各个 Agent 的设置
showboard doctor	按照各个 Agent 实际使用时的方式检查设置，并提供修复方法
showboard mcp	Agent 启动的 MCP 服务
showboard serve	独立运行 Showboard 自带的仪表板页面
showboard pane	在 Agent 旁边的终端中以文本形式显示仪表板

安全设计

• Postgres 查询在 READ ONLY 事务中运行，并设有时间和行数限制。SQLite 文件以只读方式打开，电子表格也仅供读取。
• 仅接受 SELECT。
• 在你的应用中，Agent 只能运行你注册的操作，且每项操作都会根据其输入架构进行校验。
• 处理程序只响应 localhost，并拒绝来自其他网站的请求。

更多信息

• README：基准测试、工作原理和示例。
• SETUP.md：Agent 的设置指南。
• 参考文档：所有选项、工具、命令和路由。

采用 MIT 许可证。由 AI 编码 Agent 协助构建，主要使用 Claude Code。