screen

Manages screen catalog and relations to roles and routes.

Source path: libraries/core/src/screen

Module file: screen.module.ts

Introduction

This page documents the screen submodule as part of the Core package. Use it as a quick technical reference for implementation scope, exposed APIs and MCP integration points.

HTTP Endpoints

9 endpoints

List all screens with pagination.

Query: page, pageSize, search

Get a screen by ID.

Params: screenId (int)

Create a new screen.

Body

Field	Type	Required	Notes
slug	string	yes	—
icon	string	no	—

Update a screen.

Params: screenId (int)

Body

Field	Type	Required	Notes
name	string	no	—
slug	string	no	—
description	string	no	—
icon	string	no	—

Delete one or more screens.

Body

Field	Type	Required	Notes
ids	number[]	yes	IDs to delete

List roles associated with a screen.

Params: screenId (int)
Query: page, pageSize

Replace the role assignments for a screen.

Params: screenId (int)

Body

Field	Type	Required	Notes
ids	number[]	yes	Replacement set of IDs

List routes associated with a screen.

Params: screenId (int)
Query: page, pageSize

Replace the route associations for a screen.

Params: screenId (int)

Body

Field	Type	Required	Notes
ids	number[]	yes	Replacement set of IDs

MCP Tools

Named tools callable by AI models via the Model Context Protocol (MCP).

core.screens.list
List all screens with pagination
core.screens.get
Get a screen by ID
core.screens.create
Create a new screen entry
core.screens.update
Update an existing screen
core.screens.delete
Delete one or more screens
core.screens.roles.list
List roles associated with a screen
core.screens.roles.update
Replace the role assignments for a screen
core.screens.routes.list
List routes associated with a screen
core.screens.routes.update
Replace the route associations for a screen