Create KB Sync Connector

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

The description adds no behavioral context beyond what annotations already provide—it does not mention required credentials, response format, or side effects. The non-readonly and non-destructive traits are already captured by annotations, so the description contributes little additional transparency.

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 a single concise sentence, front-loaded with the action and resource, with no filler or redundant 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 create tool with a heterogeneous connector_specific_config and no output schema, the description is too sparse. It omits critical context like prerequisite credentials, source-specific configuration requirements, and expected return value, leaving the agent under-informed for correct invocation.

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 100%, so all three parameters (name, source, connector_specific_config) are already documented. The description adds no extra semantics, which is acceptable given the schema coverage, but it does not clarify the dynamic nature of connector_specific_config.

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 action ('Create a new KB Sync connector') and resource ('KB Sync connector') with a clear scope ('for a document source'). This clearly distinguishes it from sibling operations like get/update/delete/list for the same resource.

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?

Usage is implied by the verb 'Create' and the resource type, but there is no explicit guidance on when to use this tool vs alternatives like lyzr_livesource_add, or on prerequisites such as creating credentials first. No exclusions or alternative tool mentions are included.

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