ingest

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

Describes chunking strategy and entity creation with verbatim observations. Without annotations, it carries the burden but does not disclose effects on existing data, destructive nature, or other side effects. Adequate but limited.

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?

Three sentences, front-loaded with purpose, no redundant information. Efficient.

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 6 params and no output schema/annotations, the description covers the main functionality but lacks information about return values, errors, or post-conditions. Adequate but not comprehensive.

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 covers all 6 parameters with descriptions. The description adds context around chunkBy by mentioning exchange pairs, but does not elaborate on other parameters beyond what schema provides. Baseline 3, with minor added value.

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?

Clearly states it ingests pre-normalized conversation data into the knowledge graph, with chunking and entity creation. Distinguishes from general ingestion by specifying pre-normalized input.

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?

Explicitly says to normalize chat exports before calling, implying a prerequisite. However, it does not explicitly compare to other ingestion tools like ingest_dialogue or provide when-not-to-use guidance.

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