Skip to main content
Glama
Sign In
ragflow-kb-mcp

ragflow-kb-mcp

by feci
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Hybrid

ragflow_stop_parsing

Stops parsing documents that are queued or running in a RAGFlow knowledge base, using dataset and document IDs to halt processing.

Instructions

Stop parsing documents that are queued or running.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "dataset_id": "<dataset_id>",
      "document_ids": "<document_ids>"
    },
    "name": "ragflow_stop_parsing"
  }
}

Input Schema

NameRequiredDescriptionDefault
dataset_idYesDataset (knowledge base) ID
document_idsYesIDs of the documents to stop

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.1

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=false and destructiveHint=false, so the safety profile is known; the description usefully narrows scope to queued/running documents, which implies a state precondition. However it does not say what happens to partially parsed data, whether non-matching docs error or no-op, or whether any permissions are required — notable gaps for an interrupt-style operation.

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

Conciseness4/5

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

A single sentence, front-loaded with the verb and the key state constraint; nothing is wasted. It is terse to the point of omitting useful conditions, but structurally clean.

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 two-required-parameter action tool with full schema coverage, an output schema, and annotations covering the safety profile, the description covers the essentials. The remaining gap is behavior in edge states (already-completed or failed documents), which is minor given the structured data present.

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

Parameters3/5

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

Schema coverage is 100% (both dataset_id and document_ids documented in-schema), so the baseline is 3. The description adds no parameter-level detail such as whether document_ids must belong to dataset_id or whether batching is supported.

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

Purpose4/5

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

States a specific verb+resource ('Stop parsing documents') and adds a state qualifier ('queued or running') that separates it from sibling ragflow_parse_documents / ragflow_ingest_documents. It does not name those siblings explicitly, so the differentiation is implied rather than spelled out.

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 phrase 'that are queued or running' implies the condition under which the tool applies, but there is no explicit when-to-use vs. when-not guidance, no mention of the sibling tools that start parsing, and no note on what to do for documents in other states.

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