agentbay_knowledge_export

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

No annotations are provided, so the description must carry full burden. It describes the tool as exporting knowledge, implying it is a read-only operation, but it does not explicitly state side effects, authorization requirements, or data safety. The description lacks behavioral details beyond the basic action.

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 consists of two short sentences: the first states the purpose, and the second provides use cases. Every sentence adds value, with no redundancy or filler.

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?

The tool has 5 parameters and no output schema, but the description does not explain what the export returns (e.g., format, size, pagination) nor any constraints. It only mentions 'all knowledge,' which is vague given the filtering parameters available.

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 80% (4 of 5 parameters have descriptions). The tool description does not add additional meaning beyond the schema; it relies on the schema for parameter details. The undocumented 'types' parameter is not clarified in the description, keeping the score at baseline 3.

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 'Export all knowledge for a project.' It uses a specific verb (Export) and resource (all knowledge for a project), which immediately distinguishes it from sibling tools like knowledge_query or knowledge_record.

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 concrete use cases: 'Use for onboarding a new agent, restoring memory, or syncing to local store.' This gives clear context for when to use the tool, but it does not explicitly mention when NOT to use it or list alternatives among siblings.

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