appflowy_import_markdown_file

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

No annotations are provided, so the description carries full burden. It discloses that local image references are resolved relative to the file, uploaded, and replaced with URLs when upload_assets is true. However, it does not detail side effects, required permissions, idempotency, or failure handling.

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 is two sentences with no unnecessary words. It front-loads the core purpose and adds a key behavioral detail about image handling efficiently.

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?

Given the complexity of file import with image processing, no output schema, and no annotations, the description is incomplete. It omits file size limits, return format, error behavior, and path handling details beyond the schema.

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 low (0% per context, though parent_view_id has a description in the schema). The description only indirectly references upload_assets via the upload logic. It does not explain workspace_id, path, or title beyond what the schema provides.

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 action ('Import one local Markdown file') and the result ('as an AppFlowy page'), with specific verb and resource. It also distinguishes from the sibling tool 'appflowy_import_markdown_directory' by specifying it imports a single file.

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 does not provide explicit guidance on when to use this tool versus alternatives (e.g., appflowy_import_markdown_directory). It mentions image handling but lacks context on prerequisites, error scenarios, or when not to use. The parent_view_id constraint is in the schema, not the description.

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