ragflow_rate_chat_message

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

Annotations declare readOnlyHint=false, destructiveHint=false, and openWorldHint=false, so the mutation is known to be a non-destructive local write. The description adds nothing beyond that: it does not say the rating persists on the session, whether it overwrites a prior rating, or whether feedback is discarded when thumbup is true (that rule lives only in the schema).

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 short sentence, front-loaded with the action and zero filler. It is efficient, though the terseness leaves room that could have been spent on the workflow prerequisites rather than omitted entirely.

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?

An output schema exists and annotations cover the safety profile, so return values and risk do not need explaining. However, for a 5-parameter mutation tied to chat/session/message IDs, the description omits how to obtain those IDs and what the rating affects, leaving it minimally viable rather than complete.

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 100%, so chat_id, session_id, message_id, thumbup, and feedback are all already documented in the schema, including the 'feedback kept only with thumbup false' rule. The description's mention of thumbs up/down and optional feedback merely restates those fields at a lower resolution, so baseline 3 applies.

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 states a specific verb and resource: rating (thumbs up/down) a chat message that contains an assistant answer. This is distinguishable from siblings like ragflow_delete_chat_message or ragflow_chat, though it never names a sibling to contrast with.

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 when-to-use or when-not-to-use guidance, no prerequisites (e.g. needing an existing message_id from a completed chat turn), and no mention of what to do instead if the user simply wants to re-ask. The agent must infer the entire workflow context.

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