How do I use dify-knowledge?

1. Click on "Deploy Server". 2. Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state. 3. In the chat, type @ followed by the MCP server name and your instructions, e.g., "@dify-knowledge search for 'neural networks' in knowledge base" That's it! The server will respond to your query, and you can continue using it as needed. Here is a step-by-step guide with screenshots.

dify-knowledge

by salted-butter-joshua

Overview Schema Source Related Servers Discussions Admin

Python

Local

dify-mcp

Expose Dify knowledge base retrieval capabilities via MCP (Model Context Protocol), for use in Cursor and other MCP-compatible clients.

Connect to a self-hosted or remote Dify instance over HTTP, with optional dataset allowlisting for access control.

Features

Knowledge base discovery — list and inspect allowed datasets
Semantic retrieval — search chunks via Dify POST /datasets/{dataset_id}/retrieve
Document browsing — list documents and segments within a dataset
Dataset allowlist — restrict access to specific dataset_id values
stdio transport — no manual server startup; the MCP client launches the process

Related MCP server: open-webui-knowledge-mcp-server

Requirements

Python 3.11+
A running Dify instance with Knowledge Base API enabled
Network access from the machine running the MCP server to your Dify API endpoint
A Dify Knowledge Base API Key (Dify → Knowledge → Service API → API Key)

Quick Start

1. Clone and install

git clone https://github.com/salted-butter-joshua/dify-mcp.git
cd dify-mcp

python3.11 -m venv .venv

# Windows
.venv\Scripts\python.exe -m pip install -e .

# macOS / Linux
.venv/bin/python -m pip install -e .

Verify import:

# Windows
.venv\Scripts\python.exe -c "import dify_mcp; print('OK')"

# macOS / Linux
.venv/bin/python -c "import dify_mcp; print('OK')"

2. Configure environment

Copy the example env file and edit it:

cp .env.example .env

DIFY_API_BASE=http://your-dify-host/v1
DIFY_API_KEY=dataset-your-api-key
DIFY_ALLOWED_DATASETS=dataset-uuid-1,dataset-uuid-2
DIFY_TIMEOUT=30
DIFY_VERIFY_SSL=false

Variable	Description
`DIFY_API_BASE`	Dify Knowledge API base URL, e.g. `http://192.168.1.100/v1`
`DIFY_API_KEY`	Knowledge Base API key
`DIFY_ALLOWED_DATASETS`	Comma-separated dataset UUIDs to expose (required)
`DIFY_TIMEOUT`	HTTP timeout in seconds (default: `30`)
`DIFY_VERIFY_SSL`	Verify TLS certificates (default: `false` for self-signed certs)

Run the health check:

# Windows
.venv\Scripts\python.exe scripts/health_check.py

# macOS / Linux
.venv/bin/python scripts/health_check.py

3. Add to Cursor

You do not need to start the MCP server manually. Cursor launches it automatically via stdio.

Open Cursor Settings → MCP → Edit config
Add the following to mcpServers in your MCP config file:
- Windows: %USERPROFILE%\.cursor\mcp.json
- macOS / Linux: ~/.cursor/mcp.json
Replace paths and env values with your own
Restart Cursor

See mcp.json.example for a full example.

Windows example:

{
  "mcpServers": {
    "dify-knowledge": {
      "command": "/absolute/path/to/dify-mcp/.venv/Scripts/python.exe",
      "args": ["-m", "dify_mcp.server"],
      "cwd": "/absolute/path/to/dify-mcp",
      "env": {
        "DIFY_API_BASE": "http://your-dify-host/v1",
        "DIFY_API_KEY": "dataset-your-api-key",
        "DIFY_ALLOWED_DATASETS": "dataset-uuid-1,dataset-uuid-2",
        "DIFY_TIMEOUT": "30",
        "DIFY_VERIFY_SSL": "false"
      }
    }
  }
}

macOS / Linux example:

{
  "mcpServers": {
    "dify-knowledge": {
      "command": "/absolute/path/to/dify-mcp/.venv/bin/python",
      "args": ["-m", "dify_mcp.server"],
      "cwd": "/absolute/path/to/dify-mcp",
      "env": {
        "DIFY_API_BASE": "http://your-dify-host/v1",
        "DIFY_API_KEY": "dataset-your-api-key",
        "DIFY_ALLOWED_DATASETS": "dataset-uuid-1,dataset-uuid-2"
      }
    }
  }
}

4. Verify in Cursor

Cursor Settings → MCP → confirm dify-knowledge shows as enabled
In chat, try:
- List available Dify knowledge bases
- Search the knowledge base for "your query"

MCP Tools

Tool	Description
`list_datasets`	List knowledge bases within the allowlist
`get_dataset`	Get metadata for one dataset
`search_knowledge`	Retrieve relevant chunks (primary retrieval tool)
`list_documents`	List documents in a dataset
`list_document_segments`	List text segments for a document

Architecture

Cursor (MCP client)
    │ stdio
    ▼
dify-mcp (local process)
    │ HTTPS / HTTP
    ▼
Dify Knowledge API (/v1/datasets/...)

The MCP server runs locally on your machine and calls the Dify API over the network. Dify does not need to reach your machine.

Troubleshooting

Issue	Cause	Fix
`No matching distribution found for mcp`	Python < 3.11	Use Python 3.11+ in `.venv`
MCP shows error (red)	Wrong Python path, invalid key, or network issue	Check `mcp.json` paths and env vars
`401 Unauthorized`	Invalid API key	Regenerate key in Dify Service API panel
`Dataset not in allowed list`	UUID not in `DIFY_ALLOWED_DATASETS`	Add the dataset UUID to the allowlist
Health check missing env vars	`.env` not found	Ensure `.env` exists in the project root
Connection timeout	Dify unreachable	Check network / VPN / firewall

Project Structure

dify-mcp/
├── src/dify_mcp/
│   ├── server.py        # MCP entry point
│   ├── config.py        # Settings and allowlist
│   ├── dify_client.py   # Dify Knowledge API client
│   └── formatters.py    # Response formatting
├── scripts/
│   └── health_check.py  # Connectivity test
├── mcp.json.example     # Cursor MCP config template
├── .env.example         # Environment variable template
└── Dify-API.md          # Local API path reference

API Reference

Security Notes

Never commit .env or API keys to version control
A single Knowledge Base API key can access all visible datasets under the account — use DIFY_ALLOWED_DATASETS to limit exposure
Prefer running MCP locally; keep API keys in mcp.json env or .env on your machine only

This server cannot be deployed

One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Maintenance

ActivityStale

ResponsivenessNo issues

Resources

Need Help?

Related Servers

Related MCP Connectors

iknowOAuth
dev.iknow
Knowledge base MCP for AI agents on iknow.dev. Search, read, and maintain via OAuth.
Knowledge & Memory Search Documentation Access
1
Dewey
com.meetdewey
Agentic search over your Dewey document collections from any MCP-compatible client.
Search Knowledge & Memory RAG Systems
2
Knowledge Raven
com.knowledge-raven
Make your knowledge agent-ready. One MCP endpoint, 5 connectors, 3 search modes.
RAG Systems Knowledge & Memory Search
2
docbaseOAuth
io.github.krayinc
DocBase MCP server for AI agents
Documentation Access Search Developer Tools
2

Related MCP Servers

Dify Knowledge MCP Server
Knowledge & Memory Search
liiklin
A
license
B
quality
D
maintenance
A Model Context Protocol server that enables AI assistants like Cursor to directly query and retrieve information from Dify knowledge bases through natural language.
Updated 8 months ago (2026-01-28 07:18 UTC)
2
13 npm
6
MIT
open-webui-knowledge-mcp
Search Knowledge & Memory RAG Systems
RonasIT
A
license
Not graded
quality
C
maintenance
MCP server for Open WebUI Knowledge Bases – search and access your knowledge bases from Cursor, Claude Desktop, and other MCP clients.
Updated a month ago (2026-08-27 14:23 UTC)
41 npm
11
MIT
Dify Doc MCP Server
RAG Systems Search
shellus
A
license
Not graded
quality
D
maintenance
An MCP server that integrates Dify knowledge bases, enabling AI assistants to retrieve and search content from Dify via tools like list datasets, get dataset details, and knowledge retrieval.
Updated a year ago (2025-07-28 12:47 UTC)
8 npm
4
MIT
porta-rag-mcp
RAG Systems Search Documentation Access
Ira-Korshunova
F
license
Not graded
quality
C
maintenance
MCP server exposing a RAG knowledge base as read-only tools (search_knowledge_base, ask_knowledge_base, kb_stats, kb_diagnostic) for AI clients like Claude Desktop and Cursor, enabling token-efficient document retrieval and Q&A.
Updated 2 months ago (2026-08-08 08:50 UTC)
-