Search Code Blobs

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

Annotations already indicate readOnlyHint=true, destructiveHint=false, etc. The description adds no additional behavioral context beyond the basic purpose. Does not explain what a 'blob' is, permission needs, pagination, or result structure.

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, which is concise. However, it sacrifices completeness and fails to provide necessary context, so conciseness is not effectively used.

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?

Given the complexity (8 parameters, no output schema, no schema descriptions), the description is far too minimal. It does not explain what a code blob is, how to specify a project, or any search syntax, leaving the agent without enough information to correctly invoke the tool.

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 description coverage is 0% with 8 parameters. The description provides no explanation of any parameter (e.g., ref, path, filename, project_id), leaving the agent to guess their meanings from schema alone. Fails to compensate for lack of schema documentation.

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?

Description states 'Search repository code blobs in a specific project.' This clearly identifies the action (search) and resource (code blobs). The phrase 'in a specific project' distinguishes it from broader search tools among siblings, though it could be more explicit about searching file contents.

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 sibling search tools (e.g., gitlab_search_code, gitlab_search_project_code). The description does not mention when-not or alternative tools.

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