Skip to main content

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

Components

Tools

  1. list_datasets

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

    • 创建一个新的聊天助手
    • 输入:
      • name: 聊天助手的名称
      • dataset_id: 数据集的 ID
    • 返回创建的聊天助手的 ID、名称和会话 ID
  3. chat

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

Configuration

[TODO: Add configuration details specific to your implementation]

Quickstart

Install

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

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

Development/Unpublished Servers Configuration ``` "mcpServers": { "ragflow-mcp-server": { "command": "uv", "args": [ "--directory", "/Users/junjian/GitHub/wang-junjian/ragflow-mcp-server", "run", "ragflow-mcp-server" ] } } ```
Published Servers Configuration ``` "mcpServers": { "ragflow-mcp-server": { "command": "uvx", "args": [ "ragflow-mcp-server" ] } } ```

Development

Building and Publishing

To prepare the package for distribution:

  1. Sync dependencies and update lockfile:
uv sync
  1. Build package distributions:
uv build

This will create source and wheel distributions in the dist/ directory.

  1. Publish to PyPI:
uv publish

Note: You'll need to set PyPI credentials via environment variables or command flags:

  • Token: --token or UV_PUBLISH_TOKEN
  • Or username/password: --username/UV_PUBLISH_USERNAME and --password/UV_PUBLISH_PASSWORD

Debugging

Since MCP servers run over stdio, debugging can be challenging. For the best debugging experience, we strongly recommend using the MCP Inspector.

You can launch the MCP Inspector via npm with this command:

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

Upon launching, the Inspector will display a URL that you can access in your browser to begin debugging.

Metadata

Release files for tmeragflow-mcp-server 0.1.7

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for tmeragflow-mcp-server 0.1.7
File Size Uploaded Provenance
tmeragflow_mcp_server-0.1.7.tar.gz 118.6 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for tmeragflow-mcp-server 0.1.7
File Interpreter ABI Platform
tmeragflow_mcp_server-0.1.7-py3-none-any.whl Python 3 none any Details

Total release size: 124.9 kB

Release files / tmeragflow_mcp_server-0.1.7.tar.gz

Download URL tmeragflow_mcp_server-0.1.7.tar.gz
Size 118.6 kB
Tags Source
SHA-256 checksum
How to use checksums
6db6babd2fca63da3ed238ef80fb89b9c1a17d10b71a9152aa6e2d4b0b7a9d00
BLAKE2b-256 checksum
How to use checksums
49757657ebcef92919e208722010308a5ff7c466d2c2553526f801337849e068
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.11.6

Release files / tmeragflow_mcp_server-0.1.7-py3-none-any.whl

Download URL tmeragflow_mcp_server-0.1.7-py3-none-any.whl
Size 6.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
2d0055ec16443fbf4a129501dce3b83f2b5810c2c7cce7992007de4ae0ff72f4
BLAKE2b-256 checksum
How to use checksums
473cae0ea9c9f07c60032bec39fd0102ecc5f340a1723eda5a783afd1cdab20f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.11.6

Security for tmeragflow-mcp-server 0.1.7

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page