Add Live Source

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

Annotations already indicate this is a mutating, non-idempotent operation. The description adds that it returns the created live source, but it fails to disclose potential side effects like triggering a sync or requiring connector-specific credentials, which would be useful behavioral context beyond what annotations provide.

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 short sentences, front-loaded with the action and the result. There is no filler, repetition, or unnecessary technical detail.

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 operation with a rich schema, this minimal description covers the basic purpose and return value, but it omits broader context such as how live sources are set up, that credentials are required for some source types, or that adding a live source initiates syncing. The openWorldHint annotation hints at side effects, so the description could have elaborated on those.

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%, meaning all 8 parameters already have detailed descriptions in the schema. The tool description adds no additional parameter semantics beyond what the schema preserves, so the baseline score of 3 is appropriate.

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 action ('Add') and the target resource ('a live source to a knowledge base'), which distinguishes it from sibling list/get/remove operations. The title 'Add Live Source' reinforces the same message.

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 that the tool is used to add a live source to a knowledge base, but provides no explicit guidance on when to prefer this over related tools like lyzr_kb_train_website or lyzr_parse_website. It also does not mention prerequisites such as requiring credentials for certain source types.

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