connector_sdk_read

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

It implies read-only behavior by stating 'Read operations', but does not explicitly guarantee no side effects or discuss any limitations or permissions.

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 concise, covering the essential information in two sentences without unnecessary verbosity.

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?

It lists the available endpoints and directs users to list_endpoints for more details, but lacks information about output format, error handling, or endpoint-specific parameters.

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 clarifies that 'name' refers to the endpoint name, but provides no additional detail on the other parameters beyond the generic 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?

The description clearly states it handles read operations for the connector SDK and lists the specific endpoints, making its purpose unambiguous.

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 provides minimal guidance on when to use this tool versus others; it only hints that it's for read operations and suggests using list_endpoints for the full list, but does not explicitly state when to prefer this over other read tools.

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