Skip to main content
Glama
mitsuru

A2UI MCP Server

by mitsuru

Create A2UI Surface

a2ui_create_surface
Idempotent

Create a UI container for A2UI components. Establish the required surface before adding components to render and display.

Instructions

Create a new A2UI surface (UI container) for rendering components.

A surface is the top-level container for A2UI components. You must create a surface before adding components to it.

Args:

  • surface_id (string): Unique identifier for the surface

  • catalog_id (string, optional): Component catalog to use

Returns: JSON message confirming surface creation

Example: Create a surface for a booking form: { "surface_id": "booking_form" }

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
catalog_idNoComponent catalog ID. Defaults to standard A2UI catalog.https://a2ui.dev/specification/0.9/standard_catalog_definition.json
surface_idYesUnique identifier for the surface (e.g., 'booking_form', 'user_profile')

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.2/5.0
Behavior4/5

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

Annotations indicate this is a mutating, idempotent, non-destructive operation. The description adds useful context beyond that: it explains what a surface is, reinforces the prerequisite relationship, and documents the return value as a JSON confirmation. This matches the annotation profile with no contradictions.

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

Conciseness4/5

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

The description is well-organized with a definition, prerequisite note, args, return info, and example. It is not excessively long, but some of the Args section duplicates the schema, slightly reducing information density.

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?

For a two-parameter tool with full schema coverage and no output schema, the description is complete: it states the purpose, the prerequisite, the parameters, the response, and gives a realistic example. An agent has everything needed to call it correctly.

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%, so the schema already documents both parameters fully. The description restates the parameters and gives an example, which adds minor convenience but no new semantic meaning beyond what the schema provides.

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?

Description states a specific verb ('Create'), a concrete resource ('A2UI surface'), and its role as a UI container. It clearly distinguishes the tool from siblings like a2ui_update_components and a2ui_get_state by establishing the surface as the prerequisite top-level container.

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 explicitly says 'You must create a surface before adding components to it,' which gives clear sequencing guidance. It does not explicitly name alternatives or exclusion cases, but the context makes it obvious when this tool should be used first.

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