Flowise

🚀 mcp-flowise

mcp-flowise 是一個 Python 包，它實現了一個 Model Context Protocol (MCP) 服務器，並與 Flowise API 集成。該包可用於在 Flowise 平臺上註冊和管理對話流程（chatflows），為開發者提供便捷的對話流程管理體驗。

🚀 快速開始

啟動 MCP 服務器：

mcp-flowise --port 8000

默認情況下，服務器會在端口 8000 上運行。

✨ 主要特性

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)

📦 安裝指南

要安裝 mcp-flowise，請運行以下命令：

pip install mcp-flowise

📚 詳細文檔

環境變量

必要配置

• 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 集成
• [ ] 助手功能