wdata_refresh_connection

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

No annotations provided, so description must carry burden. It notes 'WRITE' (mutation), 'wait for it to settle' (asynchronous), and 'updates in place'. However, it lacks details on auth requirements, error handling, timeout consequences, or side effects beyond the basic behavior.

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?

Very concise: three sentences, front-loaded with 'WRITE.' No superfluous words. All information is relevant and scannable.

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?

Output schema exists but not described. Parameter details missing. For a tool with no annotations and 100% schema coverage gap, the description is minimally adequate but leaves important gaps about return values and parameter specifics.

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?

Schema description coverage is 0%, but description does not explain the two parameters: connection_id and timeout. Only the tool's action implies connection_id is needed. Timeout is not mentioned at all. Description fails to compensate for lacking schema descriptions.

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?

Description clearly states the tool refreshes an existing connection and updates spreadsheet data in place. It specifies the resource (connection) and action (refresh, wait). It also distinguishes from creation by stating connections can only be refreshed via API.

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?

Provides clear prerequisite: 'Find connection ids with wdata_list_connections'. Notes that connections cannot be created via API, implying when to use this tool (refresh only). However, it does not explicitly compare to sibling tools or state when not to use it.

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