coder · rafrdz · Sep 10, 2025 · Aug 29, 2025 · Aug 29, 2025 · Aug 29, 2025
diff --git a/agent/proto/agent.pb.go b/agent/proto/agent.pb.go
diff --git a/agent/proto/agent.proto b/agent/proto/agent.proto
@@ -44,6 +44,7 @@ message WorkspaceApp {
 	}
 	Health health = 12;
 	bool hidden = 13;
+	string tooltip = 14;
 }
 
 message WorkspaceAgentScript {
@@ -422,6 +423,7 @@ message CreateSubAgentRequest {
 		optional SharingLevel share = 11;
 		optional bool subdomain = 12;
 		optional string url = 13;
+		optional string tooltip = 14;
 	}
 
 	repeated App apps = 5;

diff --git a/cli/testdata/coder_provisioner_list_--output_json.golden b/cli/testdata/coder_provisioner_list_--output_json.golden
@@ -7,7 +7,7 @@
     "last_seen_at": "====[timestamp]=====",
     "name": "test-daemon",
     "version": "v0.0.0-devel",
-    "api_version": "1.9",
+    "api_version": "1.10",
     "provisioners": [
       "echo"
     ],

diff --git a/coderd/agentapi/subagent.go b/coderd/agentapi/subagent.go
@@ -205,6 +205,7 @@ func (a *SubAgentAPI) CreateSubAgent(ctx context.Context, req *agentproto.Create
 					Valid:  app.GetGroup() != "",
 					String: app.GetGroup(),
 				},
+				Tooltip: app.GetTooltip(),
 			})
 			if err != nil {
 				return xerrors.Errorf("insert workspace app: %w", err)

diff --git a/coderd/agentapi/subagent_test.go b/coderd/agentapi/subagent_test.go
@@ -206,6 +206,7 @@ func TestSubAgentAPI(t *testing.T) {
 							Threshold: 6,
 							Url:       "http://localhost:13337/healthz",
 						},
+						Tooltip: ptr.Ref("Test **Tooltip**"),
 					},
 					{
 						Slug:        "vim",
@@ -232,6 +233,7 @@ func TestSubAgentAPI(t *testing.T) {
 						Hidden:               false,
 						OpenIn:               database.WorkspaceAppOpenInSlimWindow,
 						DisplayGroup:         sql.NullString{},
+						Tooltip:              "Test **Tooltip**",
 					},
 					{
 						Slug:         "547knu0f-vim",
@@ -650,6 +652,7 @@ func TestSubAgentAPI(t *testing.T) {
 					assert.Equal(t, tt.expectApps[idx].SharingLevel, app.SharingLevel)
 					assert.Equal(t, tt.expectApps[idx].Subdomain, app.Subdomain)
 					assert.Equal(t, tt.expectApps[idx].Url, app.Url)
+					assert.Equal(t, tt.expectApps[idx].Tooltip, app.Tooltip)
 				}
 
 				// Verify expected app creation errors

diff --git a/coderd/apidoc/docs.go b/coderd/apidoc/docs.go
diff --git a/coderd/apidoc/swagger.json b/coderd/apidoc/swagger.json
diff --git a/coderd/database/db2sdk/db2sdk.go b/coderd/database/db2sdk/db2sdk.go
@@ -582,6 +582,7 @@ func Apps(dbApps []database.WorkspaceApp, statuses []database.WorkspaceAppStatus
 			Group:    dbApp.DisplayGroup.String,
 			Hidden:   dbApp.Hidden,
 			OpenIn:   codersdk.WorkspaceAppOpenIn(dbApp.OpenIn),
+			Tooltip:  dbApp.Tooltip,
 			Statuses: WorkspaceAppStatuses(statuses),
 		})
 	}

diff --git a/coderd/database/dbgen/dbgen.go b/coderd/database/dbgen/dbgen.go
@@ -866,6 +866,7 @@ func WorkspaceApp(t testing.TB, db database.Store, orig database.WorkspaceApp) d
 		DisplayGroup:         orig.DisplayGroup,
 		Hidden:               orig.Hidden,
 		OpenIn:               takeFirst(orig.OpenIn, database.WorkspaceAppOpenInSlimWindow),
+		Tooltip:              takeFirst(orig.Tooltip, testutil.GetRandomName(t)),
 	})
 	require.NoError(t, err, "insert app")
 	return resource

diff --git a/coderd/database/dump.sql b/coderd/database/dump.sql
diff --git a/coderd/database/migrations/000363_workspaceapp_tooltip.down.sql b/coderd/database/migrations/000363_workspaceapp_tooltip.down.sql
@@ -0,0 +1,2 @@
+ALTER TABLE workspace_apps
+	DROP COLUMN IF EXISTS tooltip;
diff --git a/coderd/database/migrations/000363_workspaceapp_tooltip.up.sql b/coderd/database/migrations/000363_workspaceapp_tooltip.up.sql
@@ -0,0 +1,4 @@
+ALTER TABLE workspace_apps
+	ADD COLUMN IF NOT EXISTS tooltip VARCHAR(512) NOT NULL DEFAULT '';
+
+COMMENT ON COLUMN workspace_apps.tooltip IS 'Markdown-supported text that is displayed when hovering over app icons in the workspace dashboard (max 512 characters).';
diff --git a/coderd/database/models.go b/coderd/database/models.go
diff --git a/coderd/database/queries.sql.go b/coderd/database/queries.sql.go
diff --git a/coderd/database/queries/workspaceapps.sql b/coderd/database/queries/workspaceapps.sql
@@ -31,10 +31,11 @@ INSERT INTO
         display_order,
         hidden,
         open_in,
-        display_group
+        display_group,
+        tooltip
     )
 VALUES
-    ($1, $2, $3, $4, $5, $6, $7, $8, $9, $10, $11, $12, $13, $14, $15, $16, $17, $18, $19)
+    ($1, $2, $3, $4, $5, $6, $7, $8, $9, $10, $11, $12, $13, $14, $15, $16, $17, $18, $19, $20)
 ON CONFLICT (id) DO UPDATE SET
     display_name = EXCLUDED.display_name,
     icon = EXCLUDED.icon,
@@ -52,7 +53,8 @@ ON CONFLICT (id) DO UPDATE SET
     open_in = EXCLUDED.open_in,
     display_group = EXCLUDED.display_group,
     agent_id = EXCLUDED.agent_id,
-    slug = EXCLUDED.slug
+    slug = EXCLUDED.slug,
+    tooltip = EXCLUDED.tooltip
 RETURNING *;
 
 -- name: UpdateWorkspaceAppHealthByID :exec

diff --git a/coderd/provisionerdserver/provisionerdserver.go b/coderd/provisionerdserver/provisionerdserver.go
@@ -2925,6 +2925,7 @@ func InsertWorkspaceResource(ctx context.Context, db database.Store, jobID uuid.
 				DisplayGroup: displayGroup,
 				Hidden:       app.Hidden,
 				OpenIn:       openIn,
+				Tooltip:      app.Tooltip,
 			})
 			if err != nil {
 				return xerrors.Errorf("upsert app: %w", err)

diff --git a/codersdk/workspaceapps.go b/codersdk/workspaceapps.go
@@ -89,6 +89,9 @@ type WorkspaceApp struct {
 	Group       string             `json:"group,omitempty"`
 	Hidden      bool               `json:"hidden"`
 	OpenIn      WorkspaceAppOpenIn `json:"open_in"`
+	// Tooltip is an optional markdown supported field that is displayed when
+	// hovering over app buttons in the workspace dashboard.
+	Tooltip string `json:"tooltip,omitempty"`
 
 	// Statuses is a list of statuses for the app.
 	Statuses []WorkspaceAppStatus `json:"statuses"`

diff --git a/docs/reference/api/agents.md b/docs/reference/api/agents.md
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		ALTER TABLE workspace_apps
		DROP COLUMN IF EXISTS tooltip;