search_kcl_samples

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

With no annotations, the description carries the full burden and does well: it discloses case-insensitivity, relevance ranking, a best-effort 'multipleFiles' caveat with a fallback tool, and retryable error behavior (ToolError). It omits any pagination or result-count caps beyond max_results.

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?

Front-loaded with the core purpose, then cleanly sectioned into Args/Returns/Raises. The Returns block is fairly long for a tool that already has an output schema, making it slightly more verbose than necessary, but it stays structured and readable.

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?

An output schema exists, so the return-field enumeration is partly redundant, but it usefully documents how to consume results (name → get_kcl_sample). Error handling, parameter semantics, and routing hints together make this complete for a search tool, short of explicit sibling comparisons.

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 coverage is 0%, so the description must compensate, and it documents both parameters: 'query' is case-insensitive and 'max_results' defaults to 5. This is meaningful added detail, though format constraints on the query are not covered.

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?

States a specific verb and resource ('Search KCL samples by keyword') and clarifies the search scope ('titles and descriptions'). It implicitly distinguishes itself from search_kcl_docs and list_kcl_samples by naming the 'samples' resource, though it never explicitly names those siblings.

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?

Usage is implied: call this to find a sample, then use get_kcl_sample with the returned 'name'. The Returns section nudges the agent toward get_kcl_sample for a reliable multipleFiles answer. However, there is no explicit when-to-use-this-vs-list_kcl_samples or vs search_kcl_docs guidance.

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