ragflow_ingest_documents

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

Annotations already declare destructiveHint=true and readOnlyHint=false, so the safety profile is known; the description adds nothing beyond that. It does not say what 'clear' destroys, whether operations are async/long-running, or what happens to documents already parsed. The genuinely useful destruction semantics live only in the schema's enum description, not in the tool description.

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?

It is a single compact sentence with the action list front-loaded, which is good. However, the second clause about datasets and ingestion pipelines is ambiguous enough to cost more attention than it repays.

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?

For a destructive, multi-action mutation tool, the description is too thin: no note on overlap with sibling parse/stop tools, no async or batch expectations, and no clarification of the dataset-pipeline clause. It does benefit from an output schema and 100% parameter coverage, which keeps it from being inadequate.

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 coverage is 100% and the action enum is fully self-documenting, so the schema carries the load. The description contributes no additional meaning about document_ids batch behavior or apply_dataset_config side effects. Baseline 3 applies when the schema already explains every parameter.

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 names a specific resource (documents) and enumerates the four actions, so the general purpose is legible. But it never distinguishes this tool from its near-identical siblings ragflow_parse_documents and ragflow_stop_parsing, which cover overlapping ground. The trailing clause about parsing 'datasets that use an ingestion pipeline' is vague and muddies rather than sharpens the scope.

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?

There is no statement of when to choose this tool over ragflow_parse_documents or ragflow_stop_parsing, both of which appear in the sibling list and do adjacent things. An agent must guess whether 'start' here is a synonym for parse_documents or a different path. No prerequisites or exclusions are given.

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