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

ragflow-kb-mcp

by feci
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Hybrid

ragflow_update_search_app

Updates an existing RAGFlow search app by merging new configuration values into its saved settings, letting you adjust search behavior without recreating the app.

Instructions

Change a search app. Configuration keys you pass are merged into the saved ones.

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": {
      "search_id": "<search_id>"
    },
    "name": "ragflow_update_search_app"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameNoNew name
top_kNoCandidates considered before reranking
use_kgNoAlso search the knowledge graph
keywordNoExpand the question with LLM keywords
rerank_idNoRerank model as model_name@factory
search_idYesSearch app ID
chat_modelNoChat model for answers as model_name@factory; default is the tenant's
dataset_idsNoDatasets the search app searches (kb_ids)
descriptionNo
document_idsNoLimit the search to these documents (doc_ids)
search_configNoOther search_config keys to set as-is, e.g. llm_setting
cross_languagesNoAlso translate the question into these languages
meta_data_filterNoMetadata filter applied to the documents
similarity_thresholdNoMinimum similarity for a chunk to count
vector_similarity_weightNoWeight of vector similarity; keyword weight is 1 minus this

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 state readOnlyHint=false and destructiveHint=false, so the safety profile is covered. The description adds the genuinely useful behavioral detail that passed config keys are merged into the saved configuration rather than replacing it, which tells the agent unspecified fields are preserved. It stops there – no mention of what happens to omitted optional fields set to null, or whether the change is reversible.

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

Conciseness5/5

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

Two short sentences, zero filler, and the most important qualifier (merge, not replace) is front-loaded after the action statement. Nothing in it is redundant with the name or title.

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?

The structured data is rich – 15 params at 93% schema coverage, an output schema, and annotations covering safety – so the description does not need to re-explain fields. But for a mutation tool with a free-form search_config passthrough and many nullable optionals, the description leaves the null-vs-omit and nested-merge behavior undefined, which is precisely what the schema cannot express.

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 93%, so nearly every one of the 15 parameters is already documented in the schema and the baseline is 3. The description only adds the merge semantics applying to the optional keys as a group; it gives no extra syntax or interaction guidance (e.g., how nested search_config keys are merged) beyond what the schema says.

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?

"Change a search app" names a specific verb and resource, and the resource (search app) is distinct from sibling updaters like ragflow_update_chat or ragflow_update_agent. It does not, however, contrast with ragflow_create_search_app, ragflow_get_search_app, or ragflow_delete_search_app to help the agent confirm it is picking the mutation tool rather than a create/read/delete one.

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 only implied: the agent must infer that this is the tool for modifying an existing app and that reads belong to get_search_app. The merge note hints that partial updates are supported, but there is no explicit when-to-use, when-not-to-use, or prerequisite (e.g., "the app must already exist").

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