Get Orphan Documents

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

With no annotations, description bears full burden for behavioral cues. It discloses that the tool scans all documents (O(n)), giving agents awareness of cost. Does not hide destructive or readonly intent (implied readonly). Adds value beyond basic purpose.

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 sentences, each essential. Front-loaded with key purpose and actionable detail. No filler or repetition. Highly 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?

Lacks output schema and does not describe return format (e.g., list of IDs vs full documents). The workspaceId parameter is not explained, leaving potential ambiguity. For a simple tool, could be more complete by clarifying return structure and param effect.

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?

Input schema has workspaceId with no description (0% coverage). Description does not mention workspaceId at all, leaving its role and optionality ambiguous. Agents cannot infer whether it filters by workspace or is required. Fails to add meaning beyond 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?

Description clearly states the tool finds documents with no parent, and specifies the mechanism (not linked via embed_linked_doc). It distinctly identifies the resource (orphan documents) and action (find). Effectively differentiates from siblings like list_docs or search_docs by the specific criterion.

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 notes it is 'useful for workspace hygiene,' indicating when to use. Mentions O(n) complexity hinting at performance considerations. Lacks explicit exclusions or direct comparison to siblings, but purpose alone provides reasonable guidance.

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