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

ragflow-kb-mcp

by feci
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Hybrid

ragflow_update_document

Modify a document's name, metadata, enabled status, or parser to manage RAGFlow knowledge base content.

Instructions

Rename a document, replace its metadata, enable or disable it, or change its parser.

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_id": "<document_id>"
    },
    "name": "ragflow_update_document"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameNoNew document name
enabledNoWhether retrieval may use this document
parser_idNoChunking method; takes effect when the document is parsed again
dataset_idYesDataset (knowledge base) ID
document_idYesDocument ID
meta_fieldsNoReplaces the document's metadata

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.1

TDQS

B3.4/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 covered; the description's note that a parser change only applies on the next parse adds genuine behavioral context. However, it omits partial-update semantics (are unmentioned fields preserved?), permission needs, and reversibility, which matter for a mutation tool.

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 front-loaded sentence that lists the capabilities without filler. It is efficiently sized, though the comma-list format is dense rather than structured.

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

Completeness3/5

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

An output schema exists so return values need no explanation, and the required IDs are documented in the schema. What remains missing is the partial-update contract: whether omitted fields are left untouched, whether supplying none is a no-op or an error, and whether enabling/disabling affects already-parsed chunks.

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%, so each parameter is already documented, including that meta_fields replaces metadata and parser_id takes effect on re-parse. The description's field list simply mirrors those parameters and adds no syntax, constraints, or interaction detail beyond the schema.

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?

The description enumerates the concrete mutations (rename, metadata replacement, enable/disable, parser change) on a named resource, which tells an agent exactly what the call can accomplish. It stops short of naming the nearest siblings (ragflow_update_metadata, ragflow_parse_documents) to clarify the boundary.

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?

Usage is implied by the enumerated capabilities: call it when you want to change one of those four attributes. There is no explicit guidance on when to prefer ragflow_update_metadata or ragflow_parse_documents instead, nor prerequisites such as requiring at least one field to be supplied.

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