JinDaGe - ragflow-mcp-server MCP Details

article

README

🚀 RAGFlow知识库对话服务器

RAGFlow API 知识库对话服务器可用于搜索知识库和进行聊天，为用户提供便捷的知识查询与交流体验。

🚀 快速开始

下载文档

可通过以下命令下载 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

安装

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", "--api-key=your_api_key_here", "--base-url=http://your_base_url_here" ] } } ```

✨ 主要特性

组件 - 工具

list_datasets
- 功能：列出所有数据集。
- 返回：数据集的 ID 和名称。
create_chat
- 功能：创建一个新的聊天助手。
- 输入：
  - name：聊天助手的名称。
  - dataset_id：数据集的 ID。
- 返回：创建的聊天助手的 ID、名称和会话 ID。
chat
- 功能：与聊天助手进行对话。
- 输入：
  - session_id：聊天助手的会话 ID。
  - question：提问内容。
- 返回：聊天助手的回答。

📚 详细文档

🔧 技术细节

开发

构建和发布

同步依赖：

uv sync

安装依赖：

uv install

运行测试：

uv test

打包：

uv package

调试

使用 MCP 调试工具进行调试：

npm install -g @mcp/debugger
mcp-debugger

通过这些步骤，您可以轻松集成和使用 RAGFlow 知识库对话服务器到您的项目中。

ragflow-mcp-server