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

ragflow-kb-mcp

by feci
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Hybrid

ragflow_get_search_app

Read-only

Fetches one search app by its ID with full configuration so you can inspect or reuse its search settings.

Instructions

Get one search app with its full search configuration.

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

Input Schema

NameRequiredDescriptionDefault
search_idYesSearch app 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=true, destructiveHint=false and openWorldHint=false, so the safety profile is covered structurally. The description adds a small amount of value by noting the response includes the 'full search configuration', but says nothing about behavior on an unknown ID or any auth/scope requirements.

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?

A single sentence with zero filler, front-loading the verb and the resource. Nothing redundant or padded.

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?

With one required param, full schema coverage, an output schema and read-only annotations, the description covers what is needed to invoke the tool correctly. Minor gaps (behavior for a missing/invalid ID) are not essential given the structured fields already 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?

Only one parameter (search_id) and schema description coverage is 100%, so the schema already carries the semantics. The description adds no format, sourcing, or lookup guidance beyond what the schema provides, which is the baseline 3 case.

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?

Specific verb ('Get') plus resource ('search app') with an explicit singular scope ('one'), which implicitly distinguishes it from the sibling ragflow_list_search_apps. It stops short of naming that sibling or clarifying how it differs from ragflow_get_chat/get_agent, so it is clear but not fully differentiated.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No statement of when to use this tool versus ragflow_list_search_apps or ragflow_update_search_app, and no preconditions. The only usage signal is the implicit 'one' versus 'list', which the agent must infer.

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