List KB Sync Credentials

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

Annotations already declare readOnlyHint, openWorldHint, and idempotentHint, so the safety and idempotency are covered. The description adds a scope distinction but no additional behavioral details such as pagination or output format. It provides minimal extra value beyond annotations, but is not contradictory.

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 states the purpose and includes a crucial disambiguating caveat. No unnecessary words, and the key information is front-loaded.

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 zero-parameter, read-only list tool with no output schema, the description provides the essential information for selection and invocation. It does not describe the exact fields returned, but the tool's simplicity and annotations compensate for that gap.

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 input schema has zero parameters, so the baseline is 4. The description clarifies exactly what the list contains (KB Sync connector credentials), which is sufficient since there is nothing to document about parameters.

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 uses a specific verb 'List' with a clear resource 'KB Sync connector credentials', and the parenthetical explicitly distinguishes it from the general RAG credentials system. This prevents confusion with sibling tools like lyzr_credential_list or other credential-related tools.

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 provides clear context by noting that these credentials are 'distinct from the general RAG credentials system', which helps an agent decide when to use this tool. However, it does not explicitly name alternative tools, but the distinction is enough to guide selection.

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