Skip to main content
Glama

Add a screen

add_screen

Appends a screen to a course, optionally seeded from a template (see list_screen_templates). Returns the created screen, including the ids you'll need to fill its blocks in with update_screen.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
titleNoThe new screen's title. Defaults to "Untitled screen".
courseIdYesId of the course to append the screen to.
templateKeyNoKey of a screen template from list_screen_templates to seed the screen's blocks, which arrive empty with fresh ids. Omit for a blank screen.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
indexYesThe screen's zero-based position in the course.
screenYesA screen: { id, title, blocks: [...] }. Block shapes are listed by list_block_types.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.3/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already indicate this is a mutating, non-idempotent operation. The description adds useful behavioral detail: it returns the created screen, includes the ids needed for update_screen, and explains that template seeding produces blocks with fresh ids. No contradiction with annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two sentences with no filler. The action and resource are front-loaded, and the template and return-value context are packed efficiently into the second sentence.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With a complete input schema and an output schema present, the description covers what remains essential: the operation's effect, the optional template path, and the next-step relationship to update_screen. Nothing critical is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, and the schema already documents title defaults, courseId, and templateKey semantics. The description adds workflow context around template selection and return value, but it does not materially improve parameter-level understanding beyond the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb and resource: 'Appends a screen to a course.' It also distinguishes the tool from related siblings like add_block and update_screen by clarifying that it creates a screen and returns the ids needed for subsequent block filling.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description gives clear workflow guidance by pointing to list_screen_templates for template keys and update_screen for filling blocks. It does not explicitly state when not to use alternatives such as duplicate_screen, so it stops short of a 5.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources