doc_query

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

No annotations are provided, so the description carries full burden for behavioral disclosure. It mentions authentication via api_key and returns a ContextResponse, but fails to explain what the tool does beyond 'query' (e.g., how it processes queries, any rate limits, error handling, or what ContextResponse entails). This leaves significant gaps in understanding its behavior.

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 structured with clear sections for Args and Returns, making it easy to parse. It's front-loaded with the purpose statement and avoids unnecessary fluff. However, the parameter explanations are very brief and could be more informative without sacrificing conciseness.

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 of a query tool with 3 parameters, no annotations, and no output schema, the description is incomplete. It doesn't explain the return value (ContextResponse is undefined), lacks details on query processing or limitations, and provides minimal parameter guidance, making it inadequate for full understanding.

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%, so the description must compensate. It lists all three parameters with brief explanations (e.g., 'query text from the user'), adding basic semantics beyond the schema's titles. However, it doesn't provide details like format constraints, examples, or deeper meaning, offering only minimal compensation 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 states the tool 'Query project documentation' which provides a clear verb ('Query') and resource ('project documentation'), establishing its basic purpose. However, it lacks specificity about what kind of querying it performs (e.g., semantic search, keyword matching, retrieval) and doesn't differentiate from siblings since there are none, making it somewhat vague.

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?

The description provides no guidance on when to use this tool, such as prerequisites, typical use cases, or alternatives. With no sibling tools, there's no need for differentiation, but it still lacks any context about appropriate scenarios or limitations, leaving usage unclear.

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