db_query_index

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

No annotations are provided, so the description must disclose behavioral traits (e.g., read vs write, side effects, required permissions). The single phrase 'Build/search' is insufficient; it does not clarify if the tool modifies state or is read-only.

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?

Extremely concise (5 words) but at the cost of essential detail. It lacks structure and fails to front-load critical information. While brevity is valued, it omits necessary context for an agent to use the tool correctly.

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 tool has 5 parameters, a complex feature set (building/searching an index), and no annotations or output schema details in the description, it is severely incomplete. The description does not explain how parameters work together, what the index contains, or expected return type.

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 100%, providing baseline. The description adds no additional meaning beyond what the parameter descriptions already state. For example, it does not explain how 'query' interacts with 'include_components' or 'link_status'.

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 'Build/search DB query and DB component index' is vague and fails to distinguish the tool from siblings like 'search_db_usage' or 'query_dependencies'. It does not specify whether it builds or searches primarily, and lacks a clear verb-resource combination.

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 instead of alternatives. No mention of prerequisites, exclusions, or scenarios where it is not appropriate.

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