Create KB Sync Credential

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

Annotations already indicate this is a write operation (readOnlyHint false) and not idempotent, so the description's 'create' is consistent. The description adds context about a distinct credential system but does not disclose error conditions or validation behavior. Overall it adds modest value beyond annotations.

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 sentence that front-loads the action and resource, with a parenthetical distinction. Every word earns its place; there is no redundancy or fluff.

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?

This is a straightforward create operation with a clear name and title, but the description provides no guidance on the structure of credential_json or when this credential should be used relative to the many sibling credential tools. The absence of an output schema means return behavior is not explained, but that is acceptable for a create. Overall it is minimally viable but leaves gaps for users unfamiliar with KB Sync.

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?

Both parameters have descriptions in the schema (100% coverage), so the tool description adds no additional parameter guidance. The credential_json parameter remains vague ('data for the connector's source'), and the description does not compensate for the open-ended object structure.

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 tool creates a KB Sync connector credential, using a specific verb and resource. The parenthetical explicitly distinguishes this from the general RAG credentials system, which differentiates it from sibling tools like lyzr_credential_create.

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 is tied to KB Sync connector credentials rather than general RAG credentials, giving some differentiation. However, it does not explicitly state when to use this tool over alternatives or provide exclusions, so guidance is only implied.

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