Validiert die Responses von dashboardbase Widget-Endpoints und Setup-Dateien gegen den Live-JSON-Contract, um ein korrektes Rendering sicherzustellen.
Auch bekannt als dashboardbase/mcp, mcp, @dashboardbase/mcp
- Stars
- 0
- Tools
- 3
- Downloads, 30 Tage
- 246
- Neueste Version
- 1.0.1
- Letzter Commit
- 14. Okt. 2026
- Lizenz
- MIT
Was ist dashboardbase MCP?
Validiert die Responses von dashboardbase Widget-Endpoints und Setup-Dateien gegen den Live-JSON-Contract, um ein korrektes Rendering sicherzustellen. Er stellt 3 Tools bereit, etwa validate_setup_file, validate_widget_response, create_setup_link.
Zusammenfassung generiert aus dem README des Projekts
Über dashboardbase MCP server
Entwickler, die Datenvisualisierungen bauen, können dashboardbase nutzen, um zu verifizieren, dass ihre JSON-Konfigurationen und Widget-Endpoints den erforderlichen Plattform-Contracts entsprechen. Durch die Integration dieses Servers in AI-Clients wie Claude Code, Cursor oder Windsurf kann ein Agent Fehler in Setup-Dateien oder Endpoint-Responses automatisch erkennen und beheben, bevor sie deployed werden. Das verhindert den typischen Zyklus aus dem Deployment defekter Widgets und dem manuellen Debugging von Rendering-Fehlern.
Der Server bietet drei spezifische Tools: validate_setup_file zum Prüfen von Dashboard-Provisioning-JSON, validate_widget_response zum Testen von Endpoint-Bodies und create_setup_link zum Generieren von Import-Previews. Er verbindet sich mit der öffentlichen dashboardbase tools API, was bedeutet, dass für die Standardnutzung kein Konto oder API-Key erforderlich ist. Er kann lokal via npx mit Node.js 20 ausgeführt oder als stateless HTTP-Server in einem Container bereitgestellt werden.
Da der Server die Live-API aufruft, anstatt lokale Schemas zu speichern, verwendet er immer die aktuellsten Validierungsregeln. Dies stellt sicher, dass Fehlermeldungen und Contract-Anforderungen perfekt mit der dashboardbase Plattform synchron bleiben, ohne dass ständige manuelle Updates erforderlich sind.
Was du damit machen kannst
- 1Beheben von Dashboard-KonfigurationsfehlernLass deinen Agenten eine Setup-Datei auf Tippfehler oder falsche Pfade prüfen, um ein korrektes Rendering zu gewährleisten.
- 2Validieren von Widget-API-ResponsesNutze einen AI-Client, um zu verifizieren, dass ein neu geschriebener Endpoint exakt die JSON-Struktur zurückgibt, die vom Widget-Contract gefordert wird.
- 3Vorschau von Dashboard-SetupsGeneriere einen direkten Link, um eine fertige Setup-Datei innerhalb der dashboardbase Anwendung vorab zu prüfen.
Geschrieben aus dem README des Projekts. Jeder Use Case wurde gegen ein Zitat daraus geprüft.
So installierst du dashboardbase MCP
Formate geprüft am 10. Nov. 2026Zu Cursor hinzufügenZu Goose hinzufügendashboardbase MCP in Claude Code installieren
$ claude mcp add mcp -- npx -y @dashboardbase/mcpdashboardbase MCP in Cursor installieren
~/.cursor/mcp.json
{
"mcpServers": {
"mcp": {
"command": "npx",
"args": [
"-y",
"@dashboardbase/mcp"
]
}
}
}dashboardbase MCP in VS Code installieren
.vscode/mcp.json
{
"servers": {
"mcp": {
"type": "stdio",
"command": "npx",
"args": [
"-y",
"@dashboardbase/mcp"
]
}
}
}dashboardbase MCP in VS Code CLI installieren
$ code --add-mcp '{"name":"mcp","type":"stdio","command":"npx","args":["-y","@dashboardbase/mcp"]}'dashboardbase MCP in Claude Desktop installieren
claude_desktop_config.json
{
"mcpServers": {
"mcp": {
"command": "npx",
"args": [
"-y",
"@dashboardbase/mcp"
]
}
}
}dashboardbase MCP in Codex installieren
$ codex mcp add mcp -- npx -y @dashboardbase/mcpdashboardbase MCP in Codex config.toml installieren
~/.codex/config.toml
[mcp_servers.mcp] command = "npx" args = ["-y", "@dashboardbase/mcp"]
dashboardbase MCP in Gemini CLI installieren
$ gemini mcp add -s user mcp npx -- -y @dashboardbase/mcpdashboardbase MCP in Gemini settings.json installieren
~/.gemini/settings.json
{
"mcpServers": {
"mcp": {
"command": "npx",
"args": [
"-y",
"@dashboardbase/mcp"
]
}
}
}dashboardbase MCP tools 3
Erkannt aus dem READMEvalidate_setup_filevalidate_widget_responsecreate_setup_link
| validate_setup_file | — | |
| validate_widget_response | — | |
| create_setup_link | — |
Konfiguration
DASHBOARDBASE_API_URLBase URL of the dashboardbase API. Defaults to https://api.dashboardbase.com.
| Name | Beschreibung | Typ |
|---|---|---|
| DASHBOARDBASE_API_URL | Base URL of the dashboardbase API. Defaults to https://api.dashboardbase.com. |
Automatisierte Checks
Geluften am 13. Nov. 2026Vollständiger Bericht →Unsere automatisierten Checks bestanden. Das ist kein Security-Audit: Lies den Code und gib dem Server nur den minimal notwendigen Zugriff. Wie die Checks funktionieren
- Source Repository verknüpft und erreichbarBestanden
- Open Source Lizenz (OSI)Bestanden
- Commit oder Release im letzten JahrBestanden
- Package-Name ähnelt keinem populären PackageBestanden
- Remote Endpoint nutzt HTTPSNicht geprüft
- Destruktive Tools sind markiertBestanden
- Keine versteckten Anweisungen an das ModellBestanden
- Keine kritischen Advisories im Paket oder seinen AbhängigkeitenBestanden
README
Auf GitHub ansehenThis 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 Fragen
Wie füge ich dashboardbase MCP zu Claude Code hinzu?
Führe claude mcp add mcp -- npx -y @dashboardbase/mcp in deinem Terminal aus. Füge --scope user hinzu, damit der Server in jedem Projekt verfügbar ist.
Wie füge ich dashboardbase MCP zu Cursor hinzu?
Öffne ~/.cursor/mcp.json und füge den Server unter mcpServers hinzu, mit der Cursor-Config aus dem Installationsabschnitt oben.
Welche Tools bietet dashboardbase MCP?
Er stellt 3 Tools bereit, darunter validate_setup_file, validate_widget_response, create_setup_link.
Benötige ich ein Konto oder einen API-Key, um dies zu nutzen?
Nein, die Validierungs-API ist öffentlich und erfordert kein Konto, keinen API-Key und keine Konfiguration.
Wie geht der Server mit Schema-Updates um?
Der Server ruft die Live-API auf, anstatt lokale Schemas zu speichern. Dadurch erhält er automatisch verbesserte Validierungs-Messages und Regeln, ohne dass ein Update nötig ist.
Was sind die Voraussetzungen, um den Server via npx auszuführen?
Du musst Node.js in der Version 20 oder neuer installiert haben.