Skip to main content
Glama

List Document Children

list_children
Read-onlyIdempotent

Lists the direct children of an AFFiNE document, including linked and synced docs, and returns each child's ID, title, URL, and trash status.

Instructions

List the direct children of a document in the sidebar (embed_linked_doc / embed_synced_doc blocks and inline LinkedPage references). Returns docId, title, URL, and inTrash for each child.

Input Schema

NameRequiredDescriptionDefault
docIdYesThe parent doc whose children to list.
workspaceIdNo

Output Schema

NameRequiredDescriptionDefault
okNo
codeNo
countNo
docIdNo
errorNo
detailsNo
childrenNo
causeCodeNo
retryableNo
recoveryGuidanceNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv3.10.2

TDQS

A3.7/5.0
Behavior3/5

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

Annotations already declare readOnly, idempotent, non-destructive, and open-world, so the safety profile is covered. The description adds the shape of the result (docId, title, URL, inTrash) and the semantic definition of a child, but says nothing about depth limits, pagination, or whether inline references outside the sidebar are included — useful but modest added context.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two sentences, both earning their place: the first defines scope and child semantics up front, the second gives the return shape. No filler or restatement of the name.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a read-only list tool with full annotations and an output schema, the description covers the essential ambiguity (what a 'child' is) and the return fields. The only real gap is the unexplained optional workspaceId, which is left entirely to the schema and isn't documented there either.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 50%: docId is documented in the schema, but workspaceId has no description anywhere. The tool description mentions no parameters at all, so it does nothing to compensate for the undocumented workspaceId (e.g. whether it scopes the lookup or overrides the doc's workspace).

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('List the direct children of a document in the sidebar') and then defines exactly what counts as a child (embed_linked_doc / embed_synced_doc blocks and inline LinkedPage references). This sharply separates it from list_docs, list_workspace_tree, and list_organize_nodes, which an agent might otherwise confuse it with.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The sidebar/child-block framing implies when this tool applies, but it never states when to prefer it over list_workspace_tree or get_orphan_docs, nor any prerequisites. Usage is inferable rather than guided.

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

Deploy Server

Other Tools