search_code

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

Lacks annotations, so description must bear the load. Mentions Elasticsearch requirement and limit defaults, but does not disclose return format, pagination, error behaviors, or whether results include snippets.

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?

Description is concise with a clear first sentence followed by structured Args. No superfluous text, though the Args block could be more integrated.

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?

Covers prerequisite, scope parameters, and limit. With output schema existing, missing return details are acceptable. Minor gap: no explanation of query language or wildcard support.

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 description adds necessary parameter context: query required, project_key and repo_slug optional with constraint that repo_slug requires project_key, limit default and max. However, query syntax and expected format are not explained.

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?

Clearly states it searches code across repositories using Bitbucket Server code search. Differentiates from siblings like browse_files and find_file by specifying 'code search' but does not explicitly contrast with them.

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?

Provides prerequisite (Elasticsearch enabled) but no directives on when to use vs alternatives like find_file or browse_files. Usage is implied by the tool's unique function.

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