trmnl_get_room_booking_integration_connect_url

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

Annotations already say readOnlyHint=false and openWorldHint=true, and the description is consistent with that, adding the important non-obvious traits: the result is a CSRF-protected HTML form action, not a plain link, and the flow must be run within the user-authorized scope. It still omits URL lifetime/one-time-use behavior, but the added context is substantive.

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?

The core answer — what the tool returns and how to use it — is front-loaded in the first two sentences, with the route and caveat following. The final sentence ('Changes remote state or starts work. Run only within the user-authorized scope.') is generic boilerplate that largely restates the readOnlyHint=false annotation and could be dropped.

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?

There is no output schema, so the description must explain the return value, and it does: the answer is a form action to be submitted with the given method from a TRMNL page. For a two-parameter, nested-schema call this is nearly sufficient; the unmentioned profile parameter and unspecified URL expiry are the remaining gaps.

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?

Only half the schema is described (integration_type has no description), so the description has to compensate. It partially does: the route template shows installation_id and integration_type as path variables, and 'Google or Microsoft' hints at the integration_type values in the absence of an enum. The profile parameter is never mentioned, and no format or allowed-value detail is given.

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?

The description states a specific outcome — it returns the form action (URL) that starts an OAuth-style connect flow for a room-booking integration, with the API route spelled out. It is distinguishable from siblings by name and content, but never explicitly contrasts itself with trmnl_update_room_booking_integration or trmnl_disconnect_room_booking_integration.

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?

It gives real context for use: the owner must consent at Google or Microsoft in a browser while signed in to TRMNL, and the returned form must be submitted from a TRMNL page. However, it names no alternative tool (e.g. sync or disconnect) and gives no explicit 'do not use when' condition, so the selection guidance is implied rather than stated.

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