JinDaGe - Flowise MCP Details

article

README

🚀 mcp-flowise

mcp-flowise 是一个 Python 包，它实现了一个 Model Context Protocol (MCP) 服务器，并与 Flowise API 集成。该包主要用于在 Flowise 平台上注册和管理对话流程（chatflows），为开发者提供便捷的对话流程管理方案。

🚀 快速开始

启动 MCP 服务器：

mcp-flowise --port 8000

默认情况下，服务器会在端口 8000 上运行。

📦 安装指南

要安装 mcp-flowise，请运行以下命令：

pip install mcp-flowise

✨ 主要特性

1. 注册对话流程（chatflows）

将对话流程注册到 Flowise 平台：

from mcp_flowise import MCPFlowise

client = MCPFlowise(
    api_key="your_api_key",
    api_endpoint="http://localhost:3000"
)

response = client.register_chatflow(name="My Chatflow", description="A test chatflow")
print(response)

2. 获取对话流程列表

获取已注册的对话流程：

from mcp_flowise import MCPFlowise

client = MCPFlowise(
    api_key="your_api_key",
    api_endpoint="http://localhost:3000"
)

chatflows = client.list_chatflows()
print(chatflows)

3. 删除对话流程

删除指定的对话流程：

from mcp_flowise import MCPFlowise

client = MCPFlowise(
    api_key="your_api_key",
    api_endpoint="http://localhost:3000"
)

response = client.delete_chatflow(chatflow_id="chatflow_id")
print(response)

📚 详细文档

环境变量

必要配置

FLOWISE_API_KEY：Flowise API token（必需）。
FLOWISE_API_ENDPOINT：Flowise 的基础 URL，默认为 http://localhost:3000。

附加配置

FLOWISE_CHATFLOW_DESCRIPTIONS：逗号分隔的 chatflow_id:description 对列表，例如：
```
FLOWISE_CHATFLOW_DESCRIPTIONS="abc123:Chatflow One,xyz789:Chatflow Two"
```

过滤对话流程

可以使用以下环境变量对对话流程进行过滤：

按 ID 白名单：
FLOWISE_WHITELIST_ID="id1,id2,id3"
按 ID 黑名单：
FLOWISE_BLACKLIST_ID="id4,id5"
按名称正则白名单：
FLOWISE_WHITELIST_NAME_REGEX=".*important.*"
按名称正则黑名单：
FLOWISE_BLACKLIST_NAME_REGEX=".*deprecated.*"

⚠️ 重要提示

白名单优先于黑名单。如果同时设置了白名单和黑名单，将以最严格的规则为准。

安全

保护 API 密钥：确保 FLOWISE_API_KEY 不被泄露或暴露在日志或代码仓库中。
环境配置：使用 .env 文件或环境变量来管理敏感配置。

将 .env 添加到你的 .gitignore：

# .gitignore
.env

故障排除

缺少 API 密钥：确保 FLOWISE_API_KEY 设置正确。
无效配置：如果同时设置了 FLOWISE_CHATFLOW_ID 和 FLOWISE_ASSISTANT_ID，服务器将拒绝启动。
连接错误：验证 FLOWISE_API_ENDPOINT 是否可达。

📄 许可证

此项目采用 MIT 许可证。详细信息请参阅 LICENSE 文件。

TODO

[x] Fastmcp 模式
[x] Lowlevel 模式
[x] 过滤功能
[x] Claude desktop 集成
[ ] 助手功能

Flowise