Skip to main content

RAGFlow MCP Server - A Model Context Protocol server integrating with RAGFlow APIs

Project description

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

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ragflow_mcp_server-0.1.0.tar.gz (115.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ragflow_mcp_server-0.1.0-py3-none-any.whl (5.8 kB view details)

Uploaded Python 3

File details

Details for the file ragflow_mcp_server-0.1.0.tar.gz.

File metadata

  • Download URL: ragflow_mcp_server-0.1.0.tar.gz
  • Upload date:
  • Size: 115.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.11

File hashes

Hashes for ragflow_mcp_server-0.1.0.tar.gz
Algorithm Hash digest
SHA256 af53817ecab0ed213a75ff8d419a257d7fcb44bdfa571863f2eb00df47101db8
MD5 6f6c6cb9f9025537e9123118d791faea
BLAKE2b-256 853ea8fd7b5b80e01e18b59609dbbb6d0d64f798f7d0513dc7cddab1416aaa8b

See more details on using hashes here.

File details

Details for the file ragflow_mcp_server-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for ragflow_mcp_server-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 83599298e4fe7e51ca5f1ecda01aa250885bff61b4624786a5ef5508eaac89ba
MD5 24276960b5c26fd86e0f7cd8c7e72c56
BLAKE2b-256 2acb222f46c22fb59626a201d9403bdde9d39a59b9f562bca7b9c1061adb9be3

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page