Add descriptions to dashboards

[MikeShi42]

Summary

Adds an optional description field to dashboards that can be set, viewed, and edited across the platform. This enables users and agents to document what a dashboard is for, making it easier to find relevant dashboards in listings and programmatic access.

Changes:

• Schema (common-utils): Added optional description (max 40,000 chars) to DashboardSchema; already existed on DashboardTemplateSchema for import/export
• MongoDB model: Added description field to Mongoose dashboard schema
• Internal API: Description flows through create/update/get via existing DashboardSchema.partial() validation
• External API v2: Added description to body schemas, route handlers, response type, and OpenAPI docs
• MCP tools: hyperdx_get_dashboard includes description in listings; hyperdx_save_dashboard accepts a description parameter
• Dashboard detail page: Inline-editable description below the dashboard name (click to edit, with save/cancel)
• Dashboard listing page: Shows description on cards (falls back to tile count if no description)
• Import flow: Description field editable in the mapping form; preserved through export/import cycle
• Search: Dashboard list search also matches against description text

Screenshots or video

Before	After
(no description field)	Dashboard listing with description
	Dashboard detail with editable description
	Editing description inline

dashboard_description_demo.mp4

How to test on Vercel preview

Preview routes: /dashboards/list, /dashboards/[id], /dashboards/import

Steps:

1. Navigate to /dashboards/list and create a new "Saved Dashboard"
2. On the dashboard detail page, hover below the title - verify "Add a description..." appears
3. Click to open the description editor, type a description, click Save
4. Navigate back to /dashboards/list - verify the description appears on the card
5. Open the dashboard again - verify the description persists

References

• Linear Issue: HDX-3813

_{To show artifacts inline, enable in settings.}

Linear Issue: HDX-3813

  

[changeset-bot]

⚠️ No Changeset found

Latest commit: 6469d73

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
hyperdx-oss	Ready	Preview, Comment	May 10, 2026 8:15am

[github-actions]

E2E Test Results

✅ All tests passed • 163 passed • 3 skipped • 1175s

Status	Count
✅ Passed	163
❌ Failed	0
⚠️ Flaky	6
⏭️ Skipped	3

Tests ran across 4 shards in parallel.

View full report →