Skip to content

recommend_surfaces

Read-only per-key A11Y SURFACE RECOMMENDATIONS (#2): for each key, the a11y surfaces implied by its semantic TYPE, derived from the backend's authoritative key.type -> treatment mapping (A11Y_TREATMENTS_BY_TYPE) - the single source of truth; do NOT reimplement the mapping in the client. Returns {project_uuid, version_uuid, active_a11y_surfaces[], keys_scanned, keys_with_gaps, gaps_by_surface{surface:int}, items:[{key_uuid, key_name, namespace_slug, type, base_role (visible_text|alt_text|accessible_name), recommended_surfaces:[{surface, active, present_in_source}], has_gap}]}. A recommended surface that is active && !present_in_source is a config-satisfied GAP to AUTHOR - hand the actual text off to sonenta-a11y (set_a11y_variant), this tool only tells you WHERE. DEVICE surfaces are not included here. Defaults to the production version.

NameTypeDescription
project_uuidstringoptionalProject UUID. Required when multiple projects are configured (SONENTA_PROJECTS); defaults to the single configured project otherwise.
version_idstringoptionalOptional version UUID; defaults to the production version.
namespace_idstringoptionalOptional namespace UUID to scope the scan.
key_idstringoptionalOptional single key UUID to scope the scan.
only_gapsbooleanoptionalWhen true, return only keys that have a gap (has_gap=true).
{
"tool": "recommend_surfaces",
"arguments": {}
}