Get Orphan Documents

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

No annotations provided, so description carries full burden. It discloses performance behavior (O(n) scanning) but leaves out other aspects like read-only nature, permission requirements, or return value details.

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 concise, informative sentences with no unnecessary words. Front-loaded with the primary function and followed by usage hint and performance note.

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?

Adequate for a simple tool with one optional parameter and no output schema. Missing details about return format (e.g., list of doc IDs) and error conditions, but covers core functionality and performance.

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?

The single parameter workspaceId is not described in the text. With 0% schema coverage, the description should explain its purpose, but it does not add meaning beyond the schema's basic type.

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 tool finds documents with no parent (orphans) and links to the concept of embed_linked_doc. It is specific and distinguishable from siblings like list_docs or search_docs, though it does not explicitly compare to them.

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 notes usefulness for workspace hygiene and warns of O(n) scanning, implying when to use and a performance consideration. However, it does not give explicit when-not-to-use or alternatives among siblings.

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