Sync Live Source

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

Annotations already indicate non-read-only, non-idempotent, non-destructive, open-world behavior. Description adds no further context about whether sync is asynchronous, how to monitor status, what side effects occur, or failure behavior. It is too vague for a side-effectful operation.

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?

Description is a single short sentence with zero wasted words. It is front-loaded and retains full clarity for the core action.

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?

No output schema and minimal annotation enrichment. The description omits crucial context such as async behavior, return value, prerequisites (e.g., live source must exist), or how to check sync status. This is insufficient for a tool that triggers a potentially long-running operation.

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 covers both parameters with clear descriptions ('Knowledge base id', 'Live source id'), achieving 100% coverage. Description does not add new parameter meaning, so baseline 3 applies.

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 uses specific verb 'trigger' and resource 'live source', clearly identifying the action. It distinguishes from sibling tools like add, remove, pause, resume, and repoint by focusing on the sync action.

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?

No guidance on when to use this tool vs alternatives. The description does not mention preconditions, scheduling alternatives, or how it differs from related tools like lyzr_livesource_ext_sync_permissions or lyzr_livesource_pause/resume.

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