@nuxtagentic/workspace

Workspace contracts

@nuxtagentic/workspace connects feature packages to the host application. It supplies contribution types, context and action registration, feature discovery, and account-scoped installation state. Its Nuxt dependencies install Identity, Data, and Prompt. It does not install dashboard layouts, pages, components, or styles.

The starter owns its shell in app/: dashboard pages and layout, prompt and search controllers, navigation, operation review, settings composition, UI defaults, and color tokens. Shell regression tests live in tests/workspace/. Features keep their own UI, server code, schemas, and contributions in their packages.

Connect a feature to the host

Available features implement the contribution contracts. They provide collection components, prompt parsers, search providers, resource navigation, actions, settings panels, and layout contributions as needed. Kit builds #workspace/features and #workspace/modules from those registrations. The host consumes the generated contributions without importing business features.

The host layout provides WorkspaceContext through provideWorkspaceContext and an action registry through provideAgentActionHandlers. Feature pages read useWorkspaceContext and call useWorkspaceRoute to ask the host for navigation based on that page's own Nuxt route. Feature components register active commands with useAgentActionHandler. These APIs keep feature packages independent of application files.

See the starter's app/layouts/dashboard.vue, app/composables/useDashboardWorkspace.ts, and app/composables/useDashboardRoute.ts for the host implementation. Include the starter's editable app/ shell when installing these packages in another application, or supply your own layout and controllers.

Input, selection, project, and view state stay in the URL. Changes to the prompt, route, or account scope invalidate stale planning results. Mutations finish on the server; late results refresh the current scope without replacing a newer prompt or restoring a stale completion message.

Installation state

workspaceModels stores module installation choices; business models stay with their features. Compose it into the host's CloudConfig schema. This starter disables module management and keeps every registered agentic feature available.

Hosts that enable workspace: { moduleManagement: true } use useWorkspaceModules to manage installation state. Defaults come from the generated catalog, and removal retains records. Hosts own the catalog page and route guards; the starter's isModuleManagementEnabled flag in nuxt.config.ts controls both the module option and whether /dashboard/modules is registered.

Core features omit their catalog entry and remain available regardless of saved installation choices. Agents, Integrations, and Automations use this registration. Prompt tools and Google connections use the same installation state on the server. The host keys its layout by workspace and installation revision to recreate controllers after those values change.

Presentation

Dashboard colors live in the host's app/assets/css/main.css and component defaults in app/app.config.ts. Use Nuxt UI's semantic success and error tokens for status indicators and switches. Avatars use bg-avatar with --avatar-hue; shared lightness and chroma keep them softer than status indicators.