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

ragflow-kb-mcp

by feci
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Hybrid

ragflow_list_commit_files

Read-only

List the files changed in a specific commit to review modifications in a RAGFlow knowledge base, optionally scoped to a dataset or workspace folder.

Instructions

List the file changes recorded in one commit.

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": {
      "commit_id": "<commit_id>"
    },
    "name": "ragflow_list_commit_files"
  }
}

Input Schema

NameRequiredDescriptionDefault
commit_idYesCommit ID
dataset_idNoDataset ID; resolves to the dataset's folder. Use instead of workspace_id.
workspace_idNoWorkspace = a folder in the file manager; pass its folder ID. Use dataset_id instead to address the folder that holds a dataset's files.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.1

TDQS

C2.9/5.0
Behavior2/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. The description adds essentially nothing beyond that: no mention of pagination, ordering, or whether the commit must belong to a specific dataset/workspace. With annotations providing the behavior, the description should supply the remaining operational context but does not.

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 tight sentence with the operation front-loaded and no filler. However, the brevity comes at the cost of omitting useful selection guidance rather than being maximally informative per sentence.

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 needn't be explained. Still, for a read tool in a dense commit-tool family, the description leaves the agent without enough to choose it confidently over get_commit or get_commit_file_content, which is a meaningful gap.

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%, including the distinction between dataset_id and workspace_id, so the schema carries the parameter semantics. The description contributes no additional parameter meaning, which is acceptable at baseline 3 when the schema is complete.

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: listing file changes for a single commit. An agent can understand the operation, but nothing in the text distinguishes it from closely named siblings like ragflow_get_commit, ragflow_diff_commits, or ragflow_get_commit_file_content.

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 guidance on when to use this versus alternatives. In a cluster of commit-related tools (list_commits, get_commit, diff_commits, get_uncommitted_changes, get_commit_file_content), the description gives no selection criteria or prerequisites such as needing a commit_id from list_commits.

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