dashboardbase
OfficialValidates Dashboardbase setup files and widget endpoint responses against the live contract, with no account or API key required.
validate_setup_file: Check a setup file (viacontentorpath) for errors and warnings, with JSON path, field, and line/column for each issue.validate_widget_response: Check a widget endpoint's full JSON response (including thetitle/actions/data/alertenvelope) against the widget contract, optionally specifyingwidgetType; returns validity, widget type, and error paths/messages.
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@dashboardbase Validate my dashboard setup file and report errors or warnings"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
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 |
| 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. |
| The JSON body a widget endpoint returns, against the widget contract. Reports the path and message for each problem. |
| 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.
Related MCP server: Validator Ai MCP
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 setInstall
Claude Code
claude mcp add dashboardbase -- npx -y @dashboardbase/mcpOne 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/mcpOr 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 |
| Automatic — restart your client and the next server start picks up the newest version. |
Claude Desktop | Pinned at install. Download the new bundle from releases and drag it in again. |
Docker |
|
Check what you're running:
npx -y @dashboardbase/mcp --versionIf 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 --versionReleases 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 listYou 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.jsonLeave 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 |
|
| Give one or the other. |
|
| Inferred from the response when |
|
| 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 |
|
| Point at a different environment. |
| unset | Sent as |
|
| 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-mcpServes 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
└── DockerfileHow 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.
Available Tools
3 toolscreate_setup_linkCreate dashboardbase setup linkA
Upload a dashboardbase setup file and get back a link that opens straight into its import preview in dashboardbase. Only call this when the user has asked for a link: the file leaves their machine, and anyone holding the link can read it for 48 hours. Validate the file with validate_setup_file first. A file carrying credential-shaped fields is refused with the offending fields listed — remove them, never work around the check.
Inputs: path, content. Returns: url, errors, reason, created, +1 more
validate_setup_fileValidate dashboardbase setup fileARead-only
Validate a dashboardbase setup file (the declarative JSON that provisions a dashboard, usually stored at .dashboardbase/.json). Returns whether the file is valid plus any errors and warnings, with the JSON path, field and line/column of each problem. Use this after writing or editing a setup file, before telling the user it is ready to import.
Inputs: path, content. Returns: valid, errors, warnings
validate_widget_responseValidate dashboardbase widget responseARead-only
Validate the JSON body a dashboardbase widget endpoint returns, against the widget contract. Pass the complete response body — the envelope with title, actions, data and alert — exactly as the endpoint returns it, not just the inner data payload. Returns whether the response is valid, the widget type it was checked against, and the path and message of each problem. Use this after building or changing an endpoint that dashboardbase will poll.
Inputs: path, response, widgetType. Returns: valid, errors, widgetType
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
TDQS
Scored across 3 tools
Each tool has a clearly distinct purpose: validating a setup file, validating a widget endpoint response, and generating a share link. The two validation tools could superficially overlap, but their descriptions sharply delineate the different contracts (setup JSON vs. widget response envelope).
All three tools follow a consistent verb_noun pattern (validate_setup_file, validate_widget_response, create_setup_link). Conventions are uniform and predictable.
Three tools is on the lean side but each earns its place in a narrow validation-plus-linking scope. Nothing feels redundant, though the surface is thin enough that it sits near the borderline.
The validate-then-share lifecycle is well covered, including a safety guard on credential-shaped fields in the link tool. Minor gaps exist (e.g. no way to fetch the widget contract or read an existing setup file), but they are workable around the stated purpose.
Maintenance
Related MCP Connectors
MCP Spec Compliance MCP — audits any MCP server.json against the official Model Context Protocol
The MCP server that vets MCP servers: identity, risk grade and per-tool risk before you install.
Monitor MCP servers, API contracts and AI outputs for schema drift. Alerts on breaking changes.
Dashboards as data. Author, validate, render, and share dvt dashboards from any MCP client.
Related MCP Servers
- AlicenseNot gradedqualityCmaintenanceMCP server to lint and validate Kubernetes-related manifests(Helm, FluxCD, ArgoCD, Kustomize, etc.)109 PyPIMIT
- AlicenseNot gradedqualityCmaintenanceAn MCP server for validating JSON against schemas, checking email deliverability, verifying URLs, assessing data quality, and validating API responses using RFC-compliant checks and heuristic analysis.4 npm41 PyPIMIT
- AlicenseNot gradedqualityDmaintenanceMCP server for validating JSON against JSON Schema and repairing malformed/invalid JSON.8 npm1MIT
- AlicenseNot gradedqualityDmaintenanceMCP server for generating AntiCMS v3 JSON component templates with validation and field type support.11 npmMIT