Skip to main content
Glama
yordcode
by yordcode

Guide an interface

guide_interface

Get community implementation notes, a checklist, and official Apple HIG topics for a UI task and platform before writing the interface.

Instructions

Given a UI task and platform, return community implementation notes inspired by Apple's HIG, a short checklist, and two or three official Apple topics to fetch before writing the interface.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
taskYesWhat to design, such as settings screen, checkout sheet, or onboarding.
platformNoTarget platform. Use web for websites and web apps.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

A3.5/5.0
Behavior3/5

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

With no annotations, the description carries the full behavioral burden, and it does disclose the shape of the return payload (notes + checklist + topics), which is genuinely useful since there is no output schema. It stops short of stating that it produces guidance rather than code/files, or any limits on repeated calls or platform defaults.

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?

A single front-loaded sentence with no filler; the input precondition ('Given a UI task and platform') precedes the payoff. It is dense but every clause earns its place.

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

Completeness4/5

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

For a two-parameter, annotation-free tool with no output schema, the description adequately covers inputs and return contents. The only meaningful gap is behavior when the optional platform is omitted, which is left unstated.

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 both parameters (task, platform) are documented in the schema itself, including the enum and the 'use web for websites' note. The description merely references 'a UI task and platform' without adding format or syntax detail, so baseline 3 applies.

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

Purpose4/5

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

The description names a specific verb (return) and enumerates the exact artifacts produced: community implementation notes, a short checklist, and two or three Apple topics. That is far more informative than a restatement of the title, though it never contrasts itself with siblings like search_hig or get_design_reference.

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

Usage Guidelines3/5

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

The phrase 'before writing the interface' implies the intended workflow position, giving implicit usage guidance. However, it never states when to prefer this over search_hig, list_topics, or get_design_reference, nor any exclusions, so an agent must infer the routing.

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