trmnl_framework_guide

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

Annotations already establish this as a safe, idempotent, closed-world read, so the safety profile is covered. The description adds that the content is authoritative and 'mandatory', which is meaningful behavioral context. It does not indicate whether the payload is long, whether it includes version-specific content, or what the links point to.

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

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

A single front-loaded sentence naming the action, the resource, and the qualifier 'mandatory' with zero padding. Nothing here could be cut without losing information.

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

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

For a zero-parameter, read-only reference tool with no output schema, this is nearly complete: an agent knows it retrieves binding conventions and links. A brief note on what the response looks like (conventions text vs. a link list) or where it fits relative to trmnl_docs_read would close the remaining gap.

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

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

The tool takes zero parameters, so the baseline is 4; there are no argument semantics to explain or compensate for. Nothing in the description contradicts the empty schema.

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

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

States a specific verb (Read) and a specific resource: the TRMNL Framework authoring conventions plus official reference links. This is clearly a documentation/reference tool rather than a device or plugin operation. It does not, however, differentiate itself from the nearby sibling trmnl_docs_read, so an agent could hesitate between the two.

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

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

'Mandatory' strongly implies the tool should be consulted before authoring markup, which is useful implied guidance. But the description never explicitly says when to call it, when to prefer trmnl_docs_read or trmnl_read_markup instead, or whether it must precede operations like trmnl_write_markup — the agent must infer the sequencing.

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