List Document Children

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

Despite no annotations, the description discloses the return type (docId, title, URL) and scope (direct children). It implies read-only behavior. Could explicitly state read-only nature, but sufficient for a simple list tool.

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?

One sentence, 17 words, with no wasted words. Front-loads the action and resource.

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?

Adequately covers the basic operation and return fields. Lacks context about the optional workspaceId parameter and any pagination or limits. No output schema, so description partially mitigates this.

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 50% (docId described, workspaceId not). The description does not add meaning to workspaceId, leaving it ambiguous. It repeats docId purpose from the schema but does not compensate for the missing description.

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 verb 'List', the resource 'direct children of a document', and the context 'sidebar (embed_linked_doc blocks)'. It distinguishes from sibling tools like list_docs or get_doc by specifying the type of children.

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 implies usage for listing children but provides no explicit guidance on when to use this tool versus alternatives like list_docs or search_docs. No when-not-to-use or alternative mentions.

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