docs-mcp

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

With no annotations provided, the description carries the full burden. It discloses that results are ordered by relevance and include URLs and markdown content, which is useful. However, it lacks details on rate limits, authentication needs, or error handling, leaving behavioral gaps.

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 concise and front-loaded, with three sentences that efficiently cover purpose, usage, and result ordering. Each sentence adds value without redundancy, making it well-structured.

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 no annotations, no output schema, and low parameter coverage, the description provides basic purpose and usage but lacks details on return format, error cases, or parameter semantics. It's minimally adequate but has clear gaps for a search 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%, so the description must compensate. It mentions 'user query' which hints at the 'question' parameter but doesn't explain 'top_k' or provide any parameter details beyond what's implied. This adds minimal value over the bare schema.

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 the tool's purpose: searching Redpanda documentation and returning relevant sections with URLs and markdown content. It specifies the verb 'search' and resource 'official Redpanda documentation,' but lacks explicit differentiation from siblings since none exist.

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 clear usage context: 'Use this tool for all queries that require Redpanda knowledge.' This gives explicit guidance on when to use it, though it doesn't mention alternatives or exclusions, which is acceptable given no sibling tools.

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