RAGFlow MCP Server

RAGFlow MCP Server

RAGFlow API MCP Server，可用于查找知识库和聊天。

下载 MCP 开发文档和 RAGFlow API 参考：

wget https://modelcontextprotocol.io/llms-full.txt -O docs/mcp-llms-full.txt
wget https://github.com/infiniflow/ragflow/raw/refs/heads/main/docs/references/python_api_reference.md -O docs/ragflow-python_api_reference.md

组件

工具

1. list_datasets

   • 列出所有数据集
   • 返回数据集的 ID 和名称

2. create_chat

   • 创建新的聊天助手
   • 输入：
     • name：聊天助手的名称
     • dataset_id：数据集的 ID
   • 返回创建的聊天助手的 ID、名称和会话 ID

3. chat

   • 与聊天助手对话
   • 输入：
     • session_id：聊天助手的会话 ID
     • question：提问内容
   • 返回聊天助手的回答

配置

[TODO: 添加适用于你的实现的配置详情]

快速入门

安装

GitHub Copilot

.vscode/mcp.json

{
    "servers": {
        "ragflow-mcp-server": {
            "command": "uvx",
            "args": [
                "ragflow-mcp-server",
                "--api-key=ragflow-dhMzViYzJlMTM1NjExZjBiNWU5MDI0Mm",
                "--base-url=http://172.16.33.66:8060"
            ]
        }
    }
}

Continue

config.yaml

mcpServers:
  - name: RAGFlow Server
    command: uvx
    args:
      - ragflow-mcp-server
      - --api-key
      - ragflow-dhMzViYzJlMTM1NjExZjBiNWU5MDI0Mm
      - --base-url
      - http://172.16.33.66:8060

Claude Desktop

MacOS：~/Library/Application\ Support/Claude/claude_desktop_config.json Windows：%APPDATA%/Claude/claude_desktop_config.json

开发/未发布服务的配置

``` "mcpServers": { "ragflow-mcp-server": { "command": "uv", "args": [ "--directory", "/Users/junjian/GitHub/wang-junjian/ragflow-mcp-server", "run", "ragflow-mcp-server" ] } } ```

已发布服务的配置

``` "mcpServers": { "ragflow-mcp-server": { "command": "uvx", "args": [ "ragflow-mcp-server" ] } } ```

开发

构建和发布

准备分发软件包：

1. 同步依赖项并更新锁文件：

uv sync

2. 构建软件包分发文件：

uv build

这将在 dist/ 目录中创建源代码分发包和 wheel 分发包。

3. 发布到 PyPI：

uv publish

注意：你需要通过环境变量或命令标志设置 PyPI 凭据：

• 令牌：--token 或 UV_PUBLISH_TOKEN
• 或用户名/密码：--username/UV_PUBLISH_USERNAME 和 --password/UV_PUBLISH_PASSWORD

调试

由于 MCP 服务通过 stdio 运行，调试可能颇具挑战。为了获得最佳调试体验，我们强烈建议使用 MCP Inspector。

你可以通过 npm 使用以下命令启动 MCP Inspector：

npx @modelcontextprotocol/inspector \
  uv --directory /Users/junjian/GitHub/wang-junjian/ragflow-mcp-server \
  run ragflow-mcp-server \
  --api-key ragflow-dhMzViYzJlMTM1NjExZjBiNWU5MDI0Mm \
  --base-url http://172.16.33.66:8060

启动后，Inspector 会显示一个 URL，你可以在浏览器中访问该 URL 开始调试。