knowledge_ingest_file

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

With no annotations, the description carries the full behavioral burden. It usefully discloses that KB_ALLOWED_DIRS is honoured when set (a path-permission constraint), but says nothing about re-ingest behavior (overwrite vs. duplicate), indexing side effects, or whether the operation is reversible.

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?

Two tight sentences with the core action front-loaded and the constraint second. Nothing is padded, though the brevity borders on under-specification for a tool with a nested parameter.

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?

For a tool with no annotations, no output schema, and an undocumented nested metadata object, the description is too thin. It omits what metadata is for, what a successful ingest returns, and how it interacts with the other ingest variants.

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 coverage is 50%: 'path' is documented in the schema while the nested 'metadata' object is undocumented in both the schema and the description. The description adds no parameter meaning whatsoever, leaving the metadata contract entirely unspecified.

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 a specific compound verb and resource: 'Read a file and store it as a knowledge document,' which is clearly distinct from a text- or dir-based ingest. It does not, however, name the sibling tools (knowledge_ingest_text, knowledge_ingest_dir) it should be chosen over, so an agent must infer the distinction from the name alone.

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?

There is no when-to-use or when-not-to-use guidance and no alternatives are named, despite two close siblings (knowledge_ingest_text, knowledge_ingest_dir) that overlap heavily with this tool. The KB_ALLOWED_DIRS note is a constraint, not usage routing.

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