dashboardbase widget エンドポイントのレスポンスとセットアップファイルを、ライブの JSON コントラクトと照合して検証し、正しいレンダリングを保証します。
別名 dashboardbase/mcp, mcp, @dashboardbase/mcp
- スター
- 0
- ツール
- 3
- ダウンロード数(30日間)
- 246
- 最新バージョン
- 1.0.1
- 最終コミット
- 2026年10月14日
- ライセンス
- MIT
dashboardbase MCPとは
dashboardbase widget エンドポイントのレスポンスとセットアップファイルを、ライブの JSON コントラクトと照合して検証し、正しいレンダリングを保証します。 3個のツールを提供しており、validate_setup_file, validate_widget_response, create_setup_linkなどがあります。
プロジェクトのREADMEから生成された概要
dashboardbase MCP server について
データビジュアライゼーションを構築している開発者は、dashboardbase を使用して、JSON 設定とウィジェット エンドポイントがプラットフォームの必須コントラクトに一致しているかを確認できます。この MCP server を Claude Code、Cursor、または Windsurf などの AI クライアントに統合することで、エージェントがデプロイ前にセットアップファイルやエンドポイント レスポンス内のエラーを自動的に検出して修正できます。これにより、壊れたウィジェットをデプロイしてレンダリングエラーを手動でデバッグするという、よくあるサイクルを防ぐことができます。
このサーバーは、3 つの特定のツールを提供します。dashboard プロビジョニング JSON をチェックする validate_setup_file、エンドポイントのボディをテストする validate_widget_response、およびインポートプレビューを生成する create_setup_link です。公開されている dashboardbase tools API に接続するため、標準的な使用においてアカウントや API キーは必要ありません。Node.js 20 を使用して npx でローカル実行するか、コンテナ内のステートレスな HTTP サーバーとしてデプロイできます。
サーバーはローカルにスキーマを保存するのではなくライブ API を呼び出すため、常に最新の検証ルールを使用します。これにより、継続的な手動アップデートを必要とせずに、エラーメッセージとコントラクトの要件が dashboardbase プラットフォームと完全に同期された状態に保たれます。
できること
- 1ダッシュボード設定エラーの修正エージェントにセットアップファイルをチェックさせ、タイポや誤ったパスがないか確認することで、正しくレンダリングされるようにします。
- 2ウィジェット API レスポンスの検証AI クライアントを使用して、新しく作成したエンドポイントがウィジェット コントラクトで要求される正確な JSON 構造を返しているか検証します。
- 3ダッシュボード設定のプレビュー完成したセットアップファイルを dashboardbase アプリケーション内でプレビューするための直接リンクを生成します。
プロジェクトの README から作成されています。すべてのユースケースは、その引用と照らし合わせて確認されています。
dashboardbase MCPのインストール方法
フォーマット検証日 2026年11月10日Cursor に追加Gooseに追加Claude Codeにdashboardbase MCPをインストール
$ claude mcp add mcp -- npx -y @dashboardbase/mcpCursorにdashboardbase MCPをインストール
~/.cursor/mcp.json
{
"mcpServers": {
"mcp": {
"command": "npx",
"args": [
"-y",
"@dashboardbase/mcp"
]
}
}
}VS Codeにdashboardbase MCPをインストール
.vscode/mcp.json
{
"servers": {
"mcp": {
"type": "stdio",
"command": "npx",
"args": [
"-y",
"@dashboardbase/mcp"
]
}
}
}VS Code CLIにdashboardbase MCPをインストール
$ code --add-mcp '{"name":"mcp","type":"stdio","command":"npx","args":["-y","@dashboardbase/mcp"]}'Claude Desktopにdashboardbase MCPをインストール
claude_desktop_config.json
{
"mcpServers": {
"mcp": {
"command": "npx",
"args": [
"-y",
"@dashboardbase/mcp"
]
}
}
}Codexにdashboardbase MCPをインストール
$ codex mcp add mcp -- npx -y @dashboardbase/mcpCodex config.tomlにdashboardbase MCPをインストール
~/.codex/config.toml
[mcp_servers.mcp] command = "npx" args = ["-y", "@dashboardbase/mcp"]
Gemini CLIにdashboardbase MCPをインストール
$ gemini mcp add -s user mcp npx -- -y @dashboardbase/mcpGemini settings.jsonにdashboardbase MCPをインストール
~/.gemini/settings.json
{
"mcpServers": {
"mcp": {
"command": "npx",
"args": [
"-y",
"@dashboardbase/mcp"
]
}
}
}dashboardbase MCPツール 3
READMEから検出validate_setup_filevalidate_widget_responsecreate_setup_link
| validate_setup_file | — | |
| validate_widget_response | — | |
| create_setup_link | — |
設定
DASHBOARDBASE_API_URLBase URL of the dashboardbase API. Defaults to https://api.dashboardbase.com.
| 名前 | 説明 | 種類 |
|---|---|---|
| DASHBOARDBASE_API_URL | Base URL of the dashboardbase API. Defaults to https://api.dashboardbase.com. |
自動チェック
実行日 2026年11月13日完全なレポート →自動チェックに合格しました。これはセキュリティ監査ではありません。コードを読み、サーバーに必要最小限のアクセス権を与えてください。 チェックの仕組み
- ソースリポジトリがリンクされており、アクセス可能合格
- オープンソースライセンス (OSI)合格
- 過去1年以内にコミットまたはリリースあり合格
- パッケージ名が有名なパッケージに酷似していない合格
- リモートエンドポイントがHTTPSを使用未チェック
- 破壊的なツールがラベル付けされている合格
- モデルへの隠れた指示がない合格
- パッケージおよびその依存関係に重大な勧告なし合格
README
GitHubで見るThis is the official MCP server for dashboardbase. Add it to your AI tool and it can check a widget endpoint's response — or a whole dashboard setup file — against the contract dashboardbase actually enforces, before you ever open the app.
The dashboardbase skill teaches your agent the JSON contract. This MCP lets it check its own work. Use both: the skill gets the shape right, the MCP proves it.
What this MCP does
It gives your agent three tools:
| Tool | What it checks |
|---|---|
validate_setup_file |
A dashboardbase setup file — the JSON that provisions a whole dashboard's widgets and datasources. Reports errors and warnings with the field, line and column. |
validate_widget_response |
The JSON body a widget endpoint returns, against the widget contract. Reports the path and message for each problem. |
create_setup_link |
Uploads a finished setup file and returns a link that opens straight into its import preview — only when you ask for one. Refuses a file carrying credentials and lists the offending fields. |
All three call the public dashboardbase tools API. No account, no API key, nothing to configure.
Before / after
Without it — your agent writes an endpoint, you deploy it, you wire it into dashboardbase, the widget shows an error, you go read the docs, you fix it, you deploy again.
With it — your agent writes the endpoint, validates the response, fixes the two things that were wrong, and hands you something that renders the first time.
Invalid setup file — 2 errors, 1 warning
mappings[0].type 14:9 Unknown widget type "guage"
mappings[1].path 22:5 Path must start with "/"
warning mappings[2] No refreshInterval set
Install
Claude Code
claude mcp add dashboardbase -- npx -y @dashboardbase/mcp
One click
Claude Desktop
Download dashboardbase-mcp.mcpb from the latest release and drag it into Claude Desktop's extensions settings. The bundle is self-contained — you don't even need Node.
Cursor, Windsurf, and most other clients
These use the mcpServers shape. Add it to ~/.cursor/mcp.json (Cursor), ~/.codeium/windsurf/mcp_config.json (Windsurf), or your client's equivalent:
{
"mcpServers": {
"dashboardbase": {
"command": "npx",
"args": ["-y", "@dashboardbase/mcp"]
}
}
}
VS Code
VS Code is the exception — it uses servers rather than mcpServers, and requires an explicit type. In .vscode/mcp.json (workspace) or your user profile:
{
"servers": {
"dashboardbase": {
"type": "stdio",
"command": "npx",
"args": ["-y", "@dashboardbase/mcp"]
}
}
}
Codex CLI
Codex uses TOML. Easiest is the CLI:
codex mcp add dashboardbase -- npx -y @dashboardbase/mcp
Or by hand in ~/.codex/config.toml:
[mcp_servers.dashboardbase]
command = "npx"
args = ["-y", "@dashboardbase/mcp"]
Requires Node.js 20 or newer — that's the only prerequisite, and only for the npx routes. Nothing else to configure: the validation API is public, so there's no account, key or environment variable to set.
Staying up to date
Two different things arrive by two different routes, which is worth knowing:
Better error messages arrive on their own. The server holds no schemas — it calls the live API — so as validation messages improve, you see them immediately. Nothing to update.
New tools need a package update. If a release adds a tool, you get it once the package updates and your client restarts the server. A running server's tool list is fixed for the session.
| How you installed | How you update |
|---|---|
npx (Claude Code, Cursor, VS Code, Windsurf, Codex) |
Automatic — restart your client and the next server start picks up the newest version. |
Claude Desktop .mcpb |
Pinned at install. Download the new bundle from releases and drag it in again. |
| Docker | docker pull / rebuild the image. |
Check what you're running:
npx -y @dashboardbase/mcp --version
If that reports an older version than the latest release, npm is serving cached registry metadata — a just-published version can take a few minutes to show up. Force it:
npx -y @dashboardbase/mcp@latest --version
Releases follow semver: new tools are a minor bump and never break existing calls, so updating is safe by default.
Using it
First, check it's connected
claude mcp list
You should see dashboardbase listed as connected. Inside a Claude Code session, /mcp shows the server and its three tools. In other clients, look for dashboardbase in the MCP or tools panel.
If it isn't there, the server never started — check that node --version is 20 or newer, and that your config file has valid JSON.
Then just ask
You don't call these tools yourself. Describe what you want and the agent decides to call them, the same way it decides to read a file. There's no special syntax and nothing to remember.
Validating something you already have:
- "Validate my dashboardbase setup file"
- "Is
.dashboardbase/revenue.jsonvalid?" - "Check this against the dashboardbase contract" — then paste the JSON
Validating as part of building:
- "Build a KPI endpoint for MRR, then validate the response it returns"
- "Add a gauge widget to my setup file and make sure it still validates"
Debugging something broken:
- "My gauge widget shows an error in dashboardbase — check what my endpoint returns against the contract"
- "Why is dashboardbase rejecting my setup file?"
What it looks like
You: My revenue widget isn't rendering. Check
.dashboardbase/revenue.json.Agent: calls
validate_setup_fileInvalid setup file — 2 errors mappings[0].type 14:9 Unknown widget type "guage" mappings[1].path 22:5 Path must start with "/"Agent: Two problems —
guageis a typo forgauge, and the second mapping's path is missing its leading slash. Fixing both now.edits the file, calls
validate_setup_fileagainValid setup file — no errors.
That loop — validate, fix, re-validate — is the whole point. The agent closes it without you opening dashboardbase.
Or invoke it directly
In Claude Code, the server adds a slash command — type / and it's in the menu:
/mcp__dashboardbase__validate .dashboardbase/revenue.json
Leave the path off and it validates whatever you're working on, or whatever you paste next. This is the deterministic route: it doesn't depend on the agent deciding the tool is relevant.
The middle segment comes from the name you installed under. If you ran
claude mcp add dashboardbase …it's/mcp__dashboardbase__validate; install it as something else and that segment changes to match.
In clients that don't support MCP prompts, just name the tool in plain language:
- "Use validate_setup_file on .dashboardbase/revenue.json"
- "Use validate_widget_response to check this"
Agents sometimes need the nudge the first time; after that they usually pick it up on their own.
The three tools
| Tool | Arguments | Notes |
|---|---|---|
validate_setup_file |
content — the file textpath — read from disk instead |
Give one or the other. |
validate_widget_response |
response — the endpoint's JSON bodypath — read from disk insteadwidgetType — optional, e.g. kpi |
Inferred from the response when widgetType is omitted. |
create_setup_link |
content — the file textpath — read from disk instead |
The link expires after 48 hours and anyone holding it can read the file, so share it directly. |
Two things worth knowing:
pathonly exists over stdio. A hosted HTTP deployment has no access to your disk, so the parameter isn't offered there — passcontent/responseinstead.validate_widget_responsewants the full response body — thetitle/actions/data/alertenvelope your endpoint actually returns, not just the innerdatapayload.
Configuration
Everything is optional.
| Variable | Default | Purpose |
|---|---|---|
DASHBOARDBASE_API_URL |
https://api.dashboardbase.com |
Point at a different environment. |
DASHBOARDBASE_API_KEY |
unset | Sent as x-api-key. Not needed for the public API. |
DASHBOARDBASE_TIMEOUT_MS |
15000 |
Request timeout in milliseconds. |
Running it as an HTTP server
For containers or a shared internal deployment:
npx @dashboardbase/mcp --http --port 3000
# or
docker build -t dashboardbase-mcp . && docker run -p 3000:3000 dashboardbase-mcp
Serves Streamable HTTP at /mcp and a health check at /health. It's fully stateless, so it scales horizontally with no session affinity. Browser origins are refused unless you allowlist them with --allowed-origin https://example.com. The file-reading path parameter is not exposed in this mode.
What's in the repo
mcp/
├── src/
│ ├── index.ts # CLI entry — stdio by default, --http optional
│ ├── server.ts # Registers the three tools
│ ├── api.ts # Client for the dashboardbase Tools API
│ ├── format.ts # Renders results as readable text
│ ├── http.ts # Stateless Streamable HTTP handler
│ └── tools/ # One file per tool
├── test/ # Unit tests, no network required
├── tools.json # OpenAPI spec for the validation API
├── server.json # MCP Registry manifest
├── manifest.json # Claude Desktop bundle manifest
└── Dockerfile
How validation works
The server doesn't carry a copy of the schemas — it calls the live dashboardbase validation API. So it can't drift from what the platform accepts, and error messages get better as the API does, with nothing to upgrade on your side.
That applies to the validation rules and messages, not to the server itself — a release that adds a tool still needs a package update. See Staying up to date.
Related
- dashboardbase — the product. Build, host, and share dashboards from your APIs.
- dashboardbase skill — free to install; teaches your agent the JSON contract so it writes correct endpoints in the first place. Pairs directly with this MCP.
- Documentation — widget reference, JSON contract, webhook setup.
Contributing
Found a gap or a confusing error? Open an issue. Note that the validation rules themselves live in the dashboardbase backend — if a message is unclear that's still worth reporting here, and we'll fix it upstream.
License
MIT — see LICENSE. Fork it, adapt it, ship it.
The MIT license covers the code in this repo — not the dashboardbase name or logo, which belong to Kompile ApS. You're free to use and adapt the server; please don't use the name or branding in a way that implies official affiliation.
The dashboardbase skill is licensed differently: free to install and use, but not open source.
dashboardbase MCPのよくある質問
dashboardbase MCPをClaude Codeに追加するには
ターミナルでclaude mcp add mcp -- npx -y @dashboardbase/mcpを実行します。すべてのプロジェクトで利用するには--scope userを追加します。
dashboardbase MCPをCursorに追加するには
~/.cursor/mcp.jsonを開き、上記のインストールセクションに示すCursor設定を使ってmcpServersの下にサーバーを追加します。
dashboardbase MCPが提供するツールは
3個のツールを提供しており、validate_setup_file, validate_widget_response, create_setup_linkなどがあります。
使用するためにアカウントや API キーは必要ですか?
いいえ、検証 API は公開されており、アカウント、API キー、または設定は不要です。
サーバーはスキーマの更新にどのように対応しますか?
サーバーはローカルにスキーマを保持するのではなく、ライブ API を呼び出すため、アップデートを行うことなく、常に最新の検証メッセージとルールを自動的に取得できます。
npx を介してサーバーを実行するための要件は何ですか?
Node.js バージョン 20 以降がインストールされている必要があります。