get_connection

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

The description discloses that it returns metadata with stream summaries and recent sync jobs, but does not cover error behavior (e.g., if connection not found), authorization requirements, or rate limits. Since no annotations are provided, the description carries full burden but offers only basic behavioral info.

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 description is two sentences long with no redundancy. The first sentence states the purpose and lookup method, the second describes the output. Every word adds value.

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?

The description sufficiently explains the tool's behavior for a simple get-by-ID operation. It identifies the lookup parameter and output shape. Although error handling and env parameter are missing, the presence of an output schema reduces the burden. Minor gap in not explaining the env parameter.

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 description adds meaning to the 'connection' parameter by stating it can be an exact name or UUID, but does not explain the optional 'env' parameter. With 0% schema description coverage, the description partially compensates but leaves one parameter unexplained.

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 clearly states the verb 'Get', the resource 'one connection', and the lookup criteria 'by exact name or connectionId UUID'. It also specifies the return value includes stream summaries and recent sync jobs, distinguishing it from siblings like list_connections.

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?

The description indicates when to use this tool (to get a specific connection by name or UUID). It does not provide explicit when-not-to-use or alternatives, but the context of sibling tools is clear enough for an agent to differentiate.

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