dashboardbase — Claude Code MCP server: validate dashboards
Checks widget endpoint responses and dashboard setup files against the contract dashboardbase enforces, before the app is opened.
claude mcp add --env DASHBOARDBASE_API_URL=<DASHBOARDBASE_API_URL> --transport stdio dashboardbase -- npx -y @dashboardbase/mcpWhat dashboardbase does
The server exposes three tools to your agent. validate_setup_file reads the JSON that provisions a dashboard's widgets and datasources and reports errors and warnings with field, line and column. validate_widget_response takes the JSON body returned by a widget endpoint and compares it to the widget contract, giving a path and message per problem. create_setup_link uploads a finished setup file and returns a link into its import preview, but only when asked; a file with credentials is refused and the offending fields are listed.
Every tool calls the public dashboardbase tools API. No account, no key, no environment variable to set. The npx routes need Node.js 20 or newer, and that is the only prerequisite.
No schemas live in the server, so improved validation messages reach you as soon as the API changes. A new tool, by contrast, arrives only after the package updates and the client restarts the server: a running process keeps a fixed tool list for the session. If npx -y @dashboardbase/mcp --version reports something older than the latest release, npm is serving cached registry metadata; npx -y @dashboardbase/mcp@latest --version forces a fresh check.
What it helps with
- validate a dashboard setup file before importing it
- catch a misspelled widget type with its line number
- compare a widget endpoint response to the contract
- get an import preview link for a finished setup
- spot credentials inside a setup file before upload
Example prompts for the agent
- Validate my dashboardbase setup file and list the errors
- Check this widget endpoint response against the dashboardbase contract
- Create a setup link for this dashboard file
How to install dashboardbase
Platform CLI
claude mcp add --env DASHBOARDBASE_API_URL=<DASHBOARDBASE_API_URL> --transport stdio dashboardbase -- npx -y @dashboardbase/mcpReplace <…> with your own values
Platform CLI
codex mcp add dashboardbase --env DASHBOARDBASE_API_URL=<DASHBOARDBASE_API_URL> -- npx -y @dashboardbase/mcpReplace <…> with your own values
Config file
{
"mcpServers": {
"dashboardbase": {
"command": "npx",
"args": [
"-y",
"@dashboardbase/mcp"
],
"env": {
"DASHBOARDBASE_API_URL": "<DASHBOARDBASE_API_URL>"
}
}
}
}Replace <…> with your own values
Config file
{
"servers": {
"dashboardbase": {
"type": "stdio",
"command": "npx",
"args": [
"-y",
"@dashboardbase/mcp"
],
"env": {
"DASHBOARDBASE_API_URL": "<DASHBOARDBASE_API_URL>"
}
}
}
}Replace <…> with your own values
Platform CLI
gemini mcp add -e DASHBOARDBASE_API_URL=<DASHBOARDBASE_API_URL> dashboardbase npx -y @dashboardbase/mcpReplace <…> with your own values
Step by step, with commands for each platform: How to add an MCP server to Claude Code, Codex, Cursor, VS Code, Gemini CLI and more
Questions about dashboardbase
How do I install dashboardbase in Claude Code?
Run claude mcp add dashboardbase -- npx -y @dashboardbase/mcp. Then claude mcp list should show the server as connected.
What does dashboardbase do?
It gives your agent tools to check a dashboard setup file and a widget endpoint response against the dashboardbase contract, and to produce an import preview link.
Do I need an API key for dashboardbase?
No. The tools use a public API, so there is no account or key. Installing through npx requires Node.js 20 or newer.
