codebase_search

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

No annotations are provided, so the description bears full responsibility for behavioral disclosure. It explains parameter behavior but does not mention whether the tool is read-only, whether it modifies state, rate limits, or side effects. For a search tool, it likely performs only reads, but that is not explicitly stated.

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 starts with a concise purpose line, followed by a bulleted list of parameters. Each sentence serves a clear purpose, and there is no redundant information. The structure is efficient and easy to parse.

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?

The tool has an output schema (from context signals) so return values need not be described. However, the description lacks context on prerequisites (e.g., valid directory_path on server), performance implications, or when to use this tool over others. Given moderate complexity, it is minimally complete but has gaps.

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?

With schema description coverage at 0%, the description adds substantial value by explaining each parameter: 'information_request' as natural language query, 'path_filter' with glob matching logic, 'include_related' default, 'top_n' defaulting to SCM_TOP_N. This compensates fully for the lack of schema descriptions.

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 '语义检索代码库，返回最相关的代码片段', which is a specific verb-resource combination indicating semantic search of a codebase. Despite no sibling tools, the purpose is unambiguous and well-defined.

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 versus alternatives. With no sibling tools, the description could still indicate scenarios or prerequisites (e.g., requires a local codebase path). The parameter descriptions explain what they do but not when the tool is appropriate.

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