Get KB Sync Connector

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

Annotations already declare readOnlyHint, openWorldHint, and idempotentHint, fully conveying the safety profile. The description adds no extra behavioral context beyond the fact that it fetches by id, which is already captured by the schema. It is consistent with annotations but does not go beyond them.

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 that is front-loaded with the action and resource. Every word is necessary, with no redundant or promotional content.

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 minimal get-by-id tool with strong annotations and a single well-described parameter, the description is adequate. It lacks an explicit statement of what is returned, but given the tool's simplicity and the absence of an output schema, the current description is sufficient for an agent to invoke it correctly.

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% for the single parameter connector_id, which has its own description 'The connector id'. The tool description merely repeats 'by id' without adding any additional semantic detail, so the schema does the heavy lifting.

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 'Fetch a KB Sync connector by id' uses a specific verb (fetch), identifies the resource (KB Sync connector), and indicates the selection method (by id). This clearly distinguishes it from sibling tools like lyzr_kbsync_connector_list, which retrieves multiple connectors.

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 implies usage when a specific connector_id is known, as opposed to listing or creating connectors. However, it does not explicitly state when to use this tool over alternatives or provide any exclusions, so the guidance remains implicit rather than explicit.

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