CustomerDashboard
Measured conclusion: Deep-tested. L2 outcome: tools_ok.
Build dashboards on your own data, including multi-customer views with per-customer login.
| Author | io.customerdashboard |
|---|---|
| Access | remote |
| Publisher key required | No |
| Measured state | Deep-tested |
| L1 liveness | alive |
| L1 latency | 483 ms |
| Last measured | 2026-10-24 |
Add to your agent
Copy this into your MCP client config:
{
"mcpServers": {
"CustomerDashboard": {
"url": "https://app.customerdashboard.io/mcp",
"transport": "streamable-http"
}
}
}
Measured tools (42)
get_platform_overviewread-onlyExplain what CustomerDashboard.io is, how multi-customer dashboards work, and how workspaces, dashboards, views, widgets and customers fit together. Call this first when you are unfamiliar with the product. No sign-in required.
Hints: read-only yes · destructive no · idempotent yes · open-world no
list_supported_data_connectorsread-onlyList every data source type CustomerDashboard can connect to, the settings each one needs, whether widgets can query it, and whether its schema can be introspected. No sign-in required.
Hints: read-only yes · destructive no · idempotent yes · open-world no
list_widget_typesread-onlyList every visualization a widget can use, with the visualizationConfig keys each type requires and accepts. Call this before creating widgets so the configuration is correct first time. No sign-in required.
Hints: read-only yes · destructive no · idempotent yes · open-world no
list_plans_and_limitsread-onlyList CustomerDashboard's subscription plans, their monthly price and the resource limits each one allows. Useful for explaining why a create operation was blocked. No sign-in required.
Hints: read-only yes · destructive no · idempotent yes · open-world no
explain_customer_filteringread-onlyExplain exactly how to write widget queries so each customer only sees their own rows on a multi-customer dashboard. Call this before writing any query for a `customer` type dashboard. No sign-in required.
Hints: read-only yes · destructive no · idempotent yes · open-world no
get_startedread-onlyExplain how to sign up for the free trial and connect this MCP server to a CustomerDashboard account, plus the order of steps for building a first multi-customer dashboard. No sign-in required.
Hints: read-only yes · destructive no · idempotent yes · open-world no
get_accountread-onlyGet the signed-in CustomerDashboard account: name, email, workspace, current plan, what the plan allows and how much of it is already used. Call this first in an authenticated session to learn the workspace you are working in.
Hints: read-only yes · destructive no · idempotent yes · open-world no
list_data_sourcesread-onlyList every data source connected to your workspace. Connection credentials are never included.
Hints: read-only yes · destructive no · idempotent yes · open-world no
get_data_sourceread-onlyGet one data source by id, including its non-secret connection settings. Credentials are never included.
Parameters:
dataSourceId(required) — string — Data source id.
Hints: read-only yes · destructive no · idempotent yes · open-world no
test_data_source_connectionCheck whether a set of connection settings actually works, before saving them. Pass an existing dataSourceId to retest a saved connection, or a type and config to test new settings.
Parameters:
type— string — Connector type. Call list_supported_data_connectors for the settings each one expects.config— object — Connection settings for this connector type, for example { host, port, database, username, password, ssl } for postgres. Credentials are stored encrypted at rest and are never returned by read tools.dataSourceId— string — Test a saved data source. Omit to test new settings.
Hints: read-only no · destructive no · idempotent yes · open-world yes
add_data_sourceConnect a new database or spreadsheet to your workspace. Test the settings with test_data_source_connection first: this tool saves them whether or not they work. Subject to your plan's data source limit.
Parameters:
name(required) — string — A name for this connection, shown in the dashboard editor.type(required) — string — Connector type. Call list_supported_data_connectors for the settings each one expects.config(required) — object — Connection settings for this connector type, for example { host, port, database, username, password, ssl } for postgres. Credentials are stored encrypted at rest and are never returned by read tools.
Hints: read-only no · destructive no · idempotent no · open-world no
update_data_sourceRename a data source or replace its connection settings. The config you pass replaces the stored one entirely, so include every setting, not just the changed ones.
Parameters:
dataSourceId(required) — string — Data source id.name— stringconfig— object — Connection settings for this connector type, for example { host, port, database, username, password, ssl } for postgres. Credentials are stored encrypted at rest and are never returned by read tools.
Hints: read-only no · destructive no · idempotent yes · open-world no
get_data_source_schemaread-onlyList the tables and columns available in a connected data source, so you can write correct widget queries. Supported for PostgreSQL, MySQL, SQL Server, Oracle, Aurora, Redshift and Google Sheets.
Parameters:
dataSourceId(required) — string — Data source id.table— string — Return only this table. Useful when a database has many tables.
Hints: read-only yes · destructive no · idempotent yes · open-world yes
run_query_previewread-onlyRun a query against a connected data source and return the first few rows, so you can confirm it works before putting it on a widget. Results are capped at 100 rows. If the query contains :customer_id you must also say which customer to preview as, using customerId or dashboardId.
Parameters:
dataSourceId(required) — string — Data source id.query(required) — string — The SQL to run, or an A1 range for Google Sheets. Use :customer_id where a customer's own identifier belongs.limit— integer — Rows to return. Defaults to 25.customerId— string — The id of a customer (from list_customers) to run the query as. Required when the query uses :customer_id, unless dashboardId is given.dashboardId— string — A customer dashboard whose configured test customer should be used instead of a real customer. Only needed when the query uses :customer_id.
Hints: read-only yes · destructive no · idempotent no · open-world yes
list_dashboardsread-onlyList every dashboard in your workspace, with its type, publishing state and share URL if published.
Hints: read-only yes · destructive no · idempotent yes · open-world no
get_dashboardread-onlyGet one dashboard in full: its settings, theme, publishing state, every view, and every widget on each view including the widget queries. This is the fastest way to understand an existing dashboard before changing it.
Parameters:
dashboardId(required) — string — Dashboard id.includeWidgets— boolean — Include every widget on every view. Defaults to true.
Hints: read-only yes · destructive no · idempotent yes · open-world no
create_dashboardCreate a dashboard. Use type 'customer' for a multi-customer dashboard where each of your customers signs in and sees only their own rows, or 'internal' for a normal dashboard you view yourself or publish as one shared view. A 'Default' view is created automatically. Subject to your plan's dashboard limit.
Parameters:
name(required) — string — Dashboard name.type— string — 'customer' for a per-customer, login-gated dashboard; 'internal' for a single shared dashboard. Defaults to 'internal'. This cannot be changed later.
Hints: read-only no · destructive no · idempotent no · open-world no
update_dashboardRename a dashboard, set how long each view is shown when the dashboard auto-rotates on a screen, or set the test customer used to preview a customer dashboard. Use set_dashboard_theme for colours and publish_dashboard for sharing.
Parameters:
dashboardId(required) — string — Dashboard id.name— stringtestCustomerId— A customer identifier from your own data, used to preview a customer dashboard before real customers exist. This is bound to :customer_id during previews only.viewRotationSeconds— Seconds each view is shown before rotating to the next, for wall displays. 0 or null turns rotation off.
Hints: read-only no · destructive no · idempotent yes · open-world no
list_viewsread-onlyList the views (tabs) on a dashboard, in display order, with how many widgets each one holds.
Parameters:
dashboardId(required) — string — Dashboard id.
Hints: read-only yes · destructive no · idempotent yes · open-world no
create_viewAdd a view (tab) to a dashboard. New views are appended after the existing ones. Subject to your plan's view limit.
Parameters:
dashboardId(required) — string — Dashboard id.name(required) — string — View name, shown on the tab.
Hints: read-only no · destructive no · idempotent no · open-world no
update_viewRename a view. Use reorder_views to change the tab order.
Parameters:
dashboardId(required) — string — Dashboard id.viewId(required) — string — View id.name(required) — string — New view name.
Hints: read-only no · destructive no · idempotent yes · open-world no
reorder_viewsSet the tab order of a dashboard's views. Pass every view id in the order you want them shown. This is also the order they rotate in on a wall display.
Parameters:
dashboardId(required) — string — Dashboard id.viewIds(required) — array — Every view id on this dashboard, in the order you want.
Hints: read-only no · destructive no · idempotent yes · open-world no
list_widgetsread-onlyList the widgets on a view, including each widget's query and visualization configuration.
Parameters:
viewId(required) — string — View id.
Hints: read-only yes · destructive no · idempotent yes · open-world no
create_widgetAdd a chart, table or KPI to a view. Call list_widget_types for the visualizationConfig each type needs, and run_query_preview first to confirm the query returns the columns you are about to reference. On a multi-customer dashboard the query must filter on :customer_id. Subject to your plan's widget limit.
Parameters:
viewId(required) — string — View id the widget belongs to.dataSourceId(required) — string — Data source the query runs against.title(required) — string — Widget title.query(required) — string — SQL, or an A1 range for Google Sheets. On a customer dashboard include :customer_id, for example "WHERE customer_id = :customer_id".visualizationType(required) — stringlayout— object — Position and size on the 12-column grid. Omit on create and a free slot is chosen for you.visualizationConfig— object — Field mappings and display options for this visualization type. Call list_widget_types for the keys each type expects.allowSharedAcrossAllCustomers— boolean — Only for customer dashboards. Set true, after the user explicitly confirms, to allow a query with no per-customer filter so every customer sees identical rows.
Hints: read-only no · destructive no · idempotent no · open-world no
update_widgetChange a widget's title, query, visualization type, configuration, data source or position. Only the fields you pass are changed.
Parameters:
viewId(required) — string — View id the widget belongs to.widgetId(required) — string — Widget id.query— stringtitle— stringlayout— object — Position and size on the 12-column grid. Omit on create and a free slot is chosen for you.dataSourceId— stringvisualizationType— stringvisualizationConfig— object — Replaces the whole configuration object, so include every key you want to keep.allowSharedAcrossAllCustomers— boolean — Only for customer dashboards. Set true, after the user explicitly confirms, to allow a query with no per-customer filter.
Hints: read-only no · destructive no · idempotent yes · open-world no
set_widget_layoutReposition several widgets on a view at once, on the 12-column grid. Use this to lay out a whole view rather than moving widgets one at a time.
Parameters:
viewId(required) — string — View id.layouts(required) — array — The widgets to move, with their new positions.
Hints: read-only no · destructive no · idempotent yes · open-world no
list_customersread-onlyList the customers on a multi-customer dashboard, each with the customerId their data is filtered by and how many logins they have.
Parameters:
dashboardId(required) — string — Dashboard id.includeUsers— boolean — Include each customer's login email addresses.
Hints: read-only yes · destructive no · idempotent yes · open-world no
add_customerAdd one of your customers to a multi-customer dashboard. The customerId must exactly match the value that identifies them in your own database, because it is what gets bound to :customer_id in every widget query. Adding a customer does not give anyone access; use add_customer_user for that. Subject to your plan's customer limit.
Parameters:
dashboardId(required) — string — A dashboard of type 'customer'.name(required) — string — Display name for this customer, for your own reference.customerId(required) — string — The identifier for this customer in your own data, for example the value in your orders.customer_id column. Must match exactly.
Hints: read-only no · destructive no · idempotent no · open-world no
update_customerRename a customer or correct the customerId their data is filtered by. Changing customerId immediately changes which rows they see, so confirm the new value with the user first.
Parameters:
dashboardId(required) — string — Dashboard id.customerRecordId(required) — string — The customer's id from list_customers (not their customerId).name— stringcustomerId— string — New identifier from your own data. This changes which rows this customer can see.
Hints: read-only no · destructive no · idempotent yes · open-world no
add_customer_userCreate a login for one of your customers so they can sign in to the published dashboard and see their own data. If you do not supply a password a strong one is generated and returned once. Subject to your plan's users-per-customer limit.
Parameters:
dashboardId(required) — string — Dashboard id.customerRecordId(required) — string — The customer's id from list_customers.email(required) — string — The person's email address. Must be unique on this dashboard.password— string — Leave empty to have a strong password generated.
Hints: read-only no · destructive no · idempotent no · open-world no
validate_customer_filteringread-onlyAudit a multi-customer dashboard and report any widget whose query would show the same rows to every customer. Run this before publishing a customer dashboard, and any time its queries change.
Parameters:
dashboardId(required) — string — Dashboard id.
Hints: read-only yes · destructive no · idempotent yes · open-world no
set_dashboard_themeSet the colour theme of a dashboard: page and surface backgrounds, text colours, brand colours and the chart series palette. All colours are hex values. Pass every field, since the theme is stored as one object.
Parameters:
dashboardId(required) — string — Dashboard id.backgroundColor(required) — string — Page background.surfaceColor(required) — string — Background of each widget card.primaryTextColor(required) — string — Main text.secondaryTextColor(required) — string — Muted and secondary text.primaryBrandColor(required) — string — Main accent, used as the first chart series colour.chartSeriesColors— array — Explicit chart series palette. Leave empty to derive one from the brand colours.secondaryBrandColor— string — Secondary accent, used for the second chart series.
Hints: read-only no · destructive no · idempotent yes · open-world no
set_dashboard_formattingSet the default locale and number, currency, percentage, duration, date and datetime formatting for a dashboard. Individual widgets can still override these.
Parameters:
dashboardId(required) — string — Dashboard id.date— objectlocale— string — BCP 47 locale such as en-US, en-GB or de-DE.number— objectcurrency— object — For example { "currency": "USD", "decimals": 2 }.datetime— objectduration— objectpercentage— objectnullDisplay— string — What to show for an empty value, for example a dash.
Hints: read-only no · destructive no · idempotent yes · open-world no
publish_dashboardPublish a dashboard and return its share URL. A customer dashboard is always login-gated, so its customers sign in with the logins you created. An internal dashboard can be published as 'public' (anyone with the link) or 'protected' (one shared username and password).
Parameters:
dashboardId(required) — string — Dashboard id.access— string — For internal dashboards: 'public' means anyone with the link, 'protected' requires a shared username and password. Ignored for customer dashboards, which always require a per-customer login. Defaults to 'protected'.password— string — Shared password, for 'protected' access. Leave empty to have one generated and returned once.username— string — Shared username, for 'protected' access.
Hints: read-only no · destructive no · idempotent yes · open-world no
unpublish_dashboardMake a dashboard private again. The existing share link stops working immediately, and any shared username and password are cleared. Widgets and data are untouched.
Parameters:
dashboardId(required) — string — Dashboard id.
Hints: read-only no · destructive no · idempotent yes · open-world no
get_dashboard_share_urlread-onlyGet the public URL of a published dashboard, and who can open it. Returns nothing to share if the dashboard is still private.
Parameters:
dashboardId(required) — string — Dashboard id.
Hints: read-only yes · destructive no · idempotent yes · open-world no
delete_dashboarddestructivePermanently delete a dashboard and everything on it. Calling this without confirm returns a preview of what would be removed; deleting for real needs confirm plus the dashboard's exact name. This cannot be undone.
Parameters:
dashboardId(required) — string — Dashboard id.confirm— boolean — Set to true only after the user has seen what will be deleted and explicitly agreed. Calling without it returns a preview instead of deleting.confirmName— string — The exact current name of the item being deleted, copied from the preview. Required alongside confirm.
Hints: read-only no · destructive yes · idempotent no · open-world no
delete_viewdestructivePermanently delete a view and every widget on it. Calling this without confirm returns a preview. This cannot be undone.
Parameters:
dashboardId(required) — string — Dashboard id.viewId(required) — string — View id.confirm— boolean — Set to true only after the user has seen what will be deleted and explicitly agreed. Calling without it returns a preview instead of deleting.confirmName— string — The exact current name of the item being deleted, copied from the preview. Required alongside confirm.
Hints: read-only no · destructive yes · idempotent no · open-world no
delete_widgetdestructivePermanently delete a widget. Calling this without confirm returns a preview. This cannot be undone.
Parameters:
viewId(required) — string — View id.widgetId(required) — string — Widget id.confirm— boolean — Set to true only after the user has seen what will be deleted and explicitly agreed. Calling without it returns a preview instead of deleting.confirmName— string — The exact current name of the item being deleted, copied from the preview. Required alongside confirm.
Hints: read-only no · destructive yes · idempotent no · open-world no
delete_data_sourcedestructivePermanently delete a data source connection. This is refused while any widget still uses it. Calling this without confirm returns a preview. Your actual database is untouched; only the connection is removed.
Parameters:
dataSourceId(required) — string — Data source id.confirm— boolean — Set to true only after the user has seen what will be deleted and explicitly agreed. Calling without it returns a preview instead of deleting.confirmName— string — The exact current name of the item being deleted, copied from the preview. Required alongside confirm.
Hints: read-only no · destructive yes · idempotent no · open-world no
delete_customerdestructivePermanently remove a customer from a multi-customer dashboard, along with all of their logins. They lose access immediately. Calling this without confirm returns a preview. This cannot be undone.
Parameters:
dashboardId(required) — string — Dashboard id.customerRecordId(required) — string — The customer's id from list_customers.confirm— boolean — Set to true only after the user has seen what will be deleted and explicitly agreed. Calling without it returns a preview instead of deleting.confirmName— string — The exact current name of the item being deleted, copied from the preview. Required alongside confirm.
Hints: read-only no · destructive yes · idempotent no · open-world no
delete_customer_userdestructivePermanently remove one login from a customer. They can no longer sign in. Calling this without confirm returns a preview. The customer itself and their data access rule remain.
Parameters:
dashboardId(required) — string — Dashboard id.customerRecordId(required) — string — The customer's id from list_customers.userId(required) — string — The login's id.confirm— boolean — Set to true only after the user has seen what will be deleted and explicitly agreed. Calling without it returns a preview instead of deleting.confirmName— string — The exact current name of the item being deleted, copied from the preview. Required alongside confirm.
Hints: read-only no · destructive yes · idempotent no · open-world no
Measured by MCPYP probing. Untested fields are omitted, never estimated. Listing is always free; MCPYP never proxies calls or stores user tokens.