kb.add

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It implies creation ('Add a document') and mentions a required follow-up ('regenerate the index page'), suggesting the tool does not automatically update the index. However, it does not disclose whether the operation is idempotent, what happens to existing documents with the same title, or if authentication is needed.

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 exceptionally concise at two sentences, each earning its place: one for the core action, one for the required post-step. No wasted words.

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 7 parameters (only 2 required) and no output schema, the description is inadequate. It fails to explain key parameters like qdrantUrl, qdrantCollection, source, and vector, leaving an AI agent with minimal guidance on how to use the tool correctly. The post-indexing instruction is useful but not sufficient for a complex 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 only 14% (only project_id has a description). The description does not add any parameter-specific meaning beyond what the schemas provide, leaving six undocumented parameters. A baseline 3 is appropriate but the description fails to compensate for the low coverage.

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 verb 'Add' and the resource 'document to the knowledge base', distinguishing it from siblings like kb.search and kb.index. However, it does not differentiate from other kb tools like kb.update or kb.init.

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 a specific when-to-use instruction: 'After adding, regenerate the index page with kb.index.' This gives a clear next step but does not explain when not to use this tool (e.g., for updating or searching) or specify prerequisites for use.

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