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

ragflow-kb-mcp

by feci
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Hybrid

ragflow_parse_documents

Parse RAGFlow documents into chunks for retrieval, with an option to wait for completion or return immediately.

Instructions

Start (or restart) parsing documents into chunks; optionally wait until it finishes.

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_parse_documents"
  }
}

Input Schema

NameRequiredDescriptionDefault
dataset_idYesDataset (knowledge base) ID
document_idsYesIDs of the documents to parse
wait_secondsNoSeconds to wait for parsing to finish; 0 returns immediately

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.1

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare this is a non-read-only, non-destructive, closed-world mutation. The description adds real value by disclosing that existing parses can be restarted and that the call can block via waiting. It does not say what happens to previously generated chunks on restart, nor the timeouts/failure semantics beyond the schema's 600s cap.

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 compact sentence with the action front-loaded and the optional blocking behavior trailing. Nothing is wasted, though the parenthetical '(or restart)' is slightly buried mid-sentence rather than given its own emphasis.

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

Completeness5/5

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

With an output schema present and annotations covering the safety profile, the description only needs to convey the action and the blocking option, which it does. Remaining questions (polling, chunk replacement) are secondary for a correctly-invokable call.

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 description coverage is 100%, so all three parameters are documented in the schema itself; baseline is 3. The description's 'optionally wait until it finishes' reinforces the wait_seconds semantics but adds no format or behavioral detail beyond the schema's 'Seconds to wait for parsing to finish; 0 returns immediately'.

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 and resource: 'parsing documents into chunks', plus the restart capability and optional blocking behavior. An agent can distinguish it from ragflow_stop_parsing by the verb, though the relationship to ragflow_ingest_documents (also document-processing) is never clarified.

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 'start (or restart)' implies it operates on unparsed or already-parsed documents, but there is no explicit when-to-use guidance, no mention of when to prefer ragflow_ingest_documents, and no note about prerequisites such as documents already being uploaded to the dataset.

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