Skip to main content
Glama

render_framework

Generate a HAL C init skeleton (bsp_init.c/bsp_init.h) from a synthesized FrameworkPlan, with unresolved values marked TODO; returns file content and todo_count. Run design_framework first.

Instructions

Render the synthesized FrameworkPlan to a HAL C init skeleton (bsp_init.c + bsp_init.h). Every derived fact (clock enables, GPIO modes, mapped .Init fields) is concrete; every unresolved value is a clearly marked TODO — nothing is fabricated. Returns the files, their content, and a todo_count. Run design_framework first.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
styleNoCode style (default 'hal').
sessionNoTarget session id (default 'default').

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.15.1

TDQS

A4.2/5.0
Behavior4/5

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

Beyond the annotations, the description discloses meaningful behavior: each unresolved value becomes a clearly marked TODO and 'nothing is fabricated,' and it names what is returned (files, content, todo_count). It does not clarify whether files are written to disk (annotations imply non-read-only) or describe error/permission conditions, so it is strong but not exhaustive.

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?

Three tight sentences, front-loaded with the core action and output, followed by the behavior guarantee (TODOs, no fabrication) and the prerequisite. No filler.

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?

With no output schema, the description carries the return-value burden and does so (files, content, todo_count), and it names the upstream dependency. It is nearly complete for this tool; only error/failure and disk-write behavior are left unspecified.

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 both parameters (style, session) are already documented with defaults in the schema. The description adds no parameter-level detail, so baseline 3 is appropriate.

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?

States a specific verb (Render) plus the exact resource and output artifacts: the synthesized FrameworkPlan turned into a HAL C init skeleton (bsp_init.c + bsp_init.h). An agent immediately knows what this produces and can distinguish it from design_framework (which builds the plan) and describe_framework.

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?

Explicitly states the prerequisite: 'Run design_framework first.' This is clear context for when the tool is actionable, but it offers no alternatives or when-not-to-use conditions, so it stops short of full routing guidance.

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