Build agent-safe dashboard configuration API #5

New issue

Open

opened 2026-06-18 16:12:16 +02:00 by vince · 0 comments

vince commented

2026-06-18 16:12:16 +02:00

Owner

Parent: #1

Goal

Give AI agents a safe, typed way to configure dashboards without editing raw files or regenerating whole documents.

Scope

Define focused mutation operations such as create_dashboard, add_section, add_service, add_metric_card, connect_datasource, set_status_rule, arrange_item, remove_item, preview_changes, and publish_changes.
Implement API endpoints or server actions for those operations.
Validate every operation against TypeBox/Ajv schemas before commit.
Return structured errors designed for agent repair loops.
Provide dry-run/preview mode that returns a diff before publishing.
Use RFC 6902 JSON Patch-compatible diffs for previews where practical.
Add simple authentication/authorization boundary suitable for a self-hosted first version.

Acceptance criteria

Agents can perform common dashboard edits through typed operations.
Invalid operations return structured, actionable validation failures.
Preview mode shows the proposed document changes without committing.
Publish mode creates a persisted revision only after validation succeeds.
Direct raw document replacement is not the primary agent workflow.
Operation schemas can be reused by future MCP tooling.

Out of scope

Natural-language chat UI.
Full MCP server packaging.
Visual drag-and-drop editor.

Parent: #1 ## Goal Give AI agents a safe, typed way to configure dashboards without editing raw files or regenerating whole documents. ## Scope - Define focused mutation operations such as `create_dashboard`, `add_section`, `add_service`, `add_metric_card`, `connect_datasource`, `set_status_rule`, `arrange_item`, `remove_item`, `preview_changes`, and `publish_changes`. - Implement API endpoints or server actions for those operations. - Validate every operation against TypeBox/Ajv schemas before commit. - Return structured errors designed for agent repair loops. - Provide dry-run/preview mode that returns a diff before publishing. - Use RFC 6902 JSON Patch-compatible diffs for previews where practical. - Add simple authentication/authorization boundary suitable for a self-hosted first version. ## Acceptance criteria - Agents can perform common dashboard edits through typed operations. - Invalid operations return structured, actionable validation failures. - Preview mode shows the proposed document changes without committing. - Publish mode creates a persisted revision only after validation succeeds. - Direct raw document replacement is not the primary agent workflow. - Operation schemas can be reused by future MCP tooling. ## Out of scope - Natural-language chat UI. - Full MCP server packaging. - Visual drag-and-drop editor.