Skip to main content
Glama
ragflow-kb-mcp
by feci

ragflow_set_chunks_availability

Enable or disable multiple chunks in a document for retrieval at once by specifying the dataset, document, and chunk IDs.

Instructions

Switch many chunks of a document on or off for retrieval at once.

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>",
      "chunk_ids": "<chunk_ids>",
      "available": "<available>"
    },
    "name": "ragflow_set_chunks_availability"
  }
}

Input Schema

NameRequiredDescriptionDefault
availableYesWhether retrieval may return them
chunk_idsYesIDs of the chunks to switch
dataset_idYesDataset (knowledge base) ID
document_idYesDocument ID

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 mutation-without-destruction profile is covered structurally. The description adds that the effect is on retrieval eligibility (reversible toggling), but says nothing about permissions, atomicity of partial failures, or whether changes apply to live chats/retrieval sessions.

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 with zero filler; the batch scope and the on/off effect are both stated up front. Brevity borders on underspecification given the mutation, but structurally it is clean.

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?

With an output schema present and full parameter descriptions, most of the calling surface is covered, but for a mutation affecting retrieval the description lacks prerequisites (datasets/documents must be parsed), error behavior, and limits on chunk_ids count.

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 four parameters are already documented, including the 'available' boolean meaning. The description only confirms the batch nature of chunk_ids and document scoping; it adds no syntax, limits, or format 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 names a specific verb and resource ('Switch ... chunks ... on or off') and specifies batch scope ('many chunks ... at once'), which distinguishes it from the single-chunk ragflow_update_chunk. It doesn't explicitly name siblings, so it falls short of a 5.

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?

'Many chunks ... at once' implies batch use versus the sibling single-chunk update, but there is no explicit when-to-use/when-not guidance, no mention of when to prefer delete_chunks or update_chunk, and no stated prerequisites.

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