Flowise MCP Server

使用说明(Markdown 格式)

  • 项目简介

    • 该仓库实现了一个 Flowise 相关的 MCP 服务器,能够暴露资源、工具、提示模板等接口,供 MCP 客户端(如与 Flowise 相关的 LLM 客户端)通过标准的 MCP 协议进行交互。服务器侧负责与 Flowise API 的对接,聚合流控、分析、向量检索、文档存储等能力,提供统一的上下文服务。
  • 主要功能点

    • MCP 核心能力
      • Tools:提供 flowise_list_flows、flowise_get_flow、flowise_predict、flowise_analyze_flow、flowise_create_flow、flowise_update_flow、flowise_delete_flow、flowise_get_chat_history、flowise_list_variables、flowise_list_tools、flowise_ping、flowise_list_assistants、flowise_get_assistant、flowise_delete_chat_history、flowise_list_document_stores、flowise_get_document_store、flowise_upsert_vector、flowise_query_vector_store 等工具,方便 LLM 客户端调用外部流程、分析、数据检索等能力。
      • Prompts:定义 analyze_agentflow、improve_chatbot 等用于与 Flowise 流程相关的提示模板。
      • Resources:提供 flow 数据的资源接口,如 list_all_flows、get_flow_resource,便于客户端获取 Flowise 流的配置和列表。
    • 与 Flowise 的对接
      • 通过 flowise_mcp/client.py 和 flowise_mcp/server.py 的组合实现对 Flowise API 的统一访问和封装,支持错误处理和响应格式化。
    • 输出格式
      • 支持返回 Markdown 或 JSON 两种格式,便于人类读释或机器处理。
  • 安装步骤(简明可执行)

    • 依赖项与环境准备
      • 需要 Python 3.10+ 环境
      • 依赖库包含 fastmcp、httpx、pydantic 等,请按照项目的 setup 配置安装
    • 安装与运行
      • 安装依赖并安装本仓库(开发模式)
        • 其中一种方式:
          • 安装并直接运行服务器:python -m flowise_mcp.server
          • 或者在开发环境中安装并通过 Python 运行入口启动
      • 环境变量配置(流程调用 Flowise 的必要信息)
        • FLOWISE_BASE_URL:Flowise 实例地址,例如 https://your-flowise-instance.com
        • FLOWISE_API_KEY:Flowise 的 API Key,用于认证
        • FLOWISE_TIMEOUT:请求超时(可选,默认 60 秒)
    • MCP 客户端启动配置(后续连接本 MCP 服务器所需,不需要运行客户端本身)
      • 客户端需要通过配置启动命令来连接 MCP 服务器(请参考下方“服务器配置”中的示例)
  • 服务器配置(MCP 客户端需要的启动信息,JSON 格式) 说明:以下配置用于 MCP 客户端在启动时连接并使用本 MCP 服务器。服务器名称与启动参数应与实际环境一致。

    { "server_name": "Flowise MCP Server", "command": "python", "args": ["-m", "flowise_mcp.server"], "env": { "FLOWISE_BASE_URL": "https://your-flowise-instance.com", "FLOWISE_API_KEY": "your-api-key", "FLOWISE_TIMEOUT": "60" } }

    注释说明:

    • server_name: MCP 客户端在界面中显示的服务器名称,用于区分多台 MCP 服务器。
    • command: 启动服务器的命令,例如 Python 解释器。
    • args: 启动服务器的参数,此处通过 -m flowise_mcp.server 启动服务器入口。
    • env: 启动时注入的环境变量,包含与 Flowise 的连接信息。
    • 以上参数为示例,请根据实际运行环境调整 Flowise 地址、API Key 和超时设置。
  • 基本使用方法(简明易懂)

    • 启动前准备
      • 设置 FLOWISE_BASE_URL、FLOWISE_API_KEY 等环境变量,确保 Flowise 实例可访问并授权。
    • 启动 MCP 服务器
      • 在合适的工作环境执行 python -m flowise_mcp.server
    • 客户端接入
      • 使用 MCP 客户端(如 VS Code、Claude Desktop 等)添加服务器配置,指定上述 server_name、command、args,以及相应的环境变量即可与 MCP 服务器建立连接。
    • 使用示例
      • 通过 MCP 客户端调用 flowise_list_flows、flowise_predict 等工具与 Flowise 实例交互,获得 Flowise 流的列表、详情、预测结果、分析建议等。
    • 调试与排错
      • 如遇连接失败、鉴权失败、超时等,请检查 FLOWISE_BASE_URL、FLOWISE_API_KEY、网络连通性及 Flowise 服务状态;服务器端会通过格式化错误信息返回友好提示。
  • 运行与测试建议

    • 先在本地搭建 Flowise 流程与 API Key,确保 Flowise API 可工作。
    • 启动 Flowise MCP Server,确保环境变量正确加载。
    • 使用 MCP 客户端连接并执行基本的 flowise_list_flows、flowise_ping 等操作,验证输出格式和错误信息。

服务器信息