Skip to main content
Glama

ui_init

Inspect project files, auto-detect the framework, and write a starter .agy-ui-scope config for immediate use of UI implement and review tools.

Instructions

Auto-detect the stack and write a starter .agy-ui-scope config.

Zero-to-config helper for non-technical users: inspects the project's manifests (package.json / pubspec.yaml / lockfiles), guesses the framework, serve command, and edit-scope globs, and writes a .agy-ui-scope YAML at the project root that the user can then tweak by hand. After this, the ui_implement / ui_review tools run with no further setup.

Args: project_dir: Path to the project root to scan and write into. overwrite: When False (default) an existing .agy-ui-scope is left untouched and status: "exists" is returned. Pass True to regenerate it (clobbering the existing file).

Returns: A dict describing the outcome: status (ok/exists/error), scope_path (absolute), written (whether the file was written), detected (framework/platform/serve/package-manager), allow and deny globs, design_dir_found, next_steps, and warnings.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
project_dirNo.
overwriteNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Behavior4/5

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

With no annotations, the description carries full burden. It explains the write behavior, including what happens when overwrite is false (leaves existing file untouched) and true (clobbers). It describes reading project files and the return format. However, it could mention that it reads files non-destructively.

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?

The description is well-structured with a concise summary, a paragraph explaining the purpose, then explicit Args and Returns sections. Every sentence adds value and there is no waste.

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?

Given the tool has an output schema but the description already lists return fields, it is fairly complete. It covers purpose, parameters, and return. It could mention potential prerequisites (e.g., existence of package.json), but not necessary for a setup tool.

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

Parameters5/5

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

Schema coverage is 0%, so description compensates fully. For project_dir, it says 'Path to the project root to scan and write into.' For overwrite, it explains the behavior in detail, including the status returned when not overwriting. This adds significant meaning 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 clearly states the tool auto-detects the stack and writes a config file, with specific actions like inspecting manifests and guessing framework. It distinguishes itself from sibling tools (ui_implement, ui_review) by noting that after this tool, the others run with no further setup.

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 says it's a 'zero-to-config helper for non-technical users' and implies usage before ui_implement/ui_review. It doesn't explicitly state when not to use it, but the context makes it clear that it's for initial setup. An explicit 'when not to use' would improve it.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/qdzsh/agy-ui-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server