Flowise

🚀 mcp-flowise

mcp-flowise is a Python package that implements a Model Context Protocol (MCP) server and integrates with the Flowise API. This package is used to register and manage chatflows on the Flowise platform.

🚀 Quick Start

Start the MCP server:

mcp-flowise --port 8000

By default, the server runs on port 8000.

✨ Features

1. Register Chatflows

Register chatflows to the Flowise platform:

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. List Chatflows

Get the list of registered chatflows:

from mcp_flowise import MCPFlowise

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

chatflows = client.list_chatflows()
print(chatflows)

3. Delete Chatflows

Delete a specified chatflow:

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)

📦 Installation

To install mcp-flowise, run the following command:

pip install mcp-flowise

📚 Documentation

Environment Variables

Required Configuration

• FLOWISE_API_KEY: Flowise API token (required).
• FLOWISE_API_ENDPOINT: The base URL of Flowise, defaulting to http://localhost:3000.

Additional Configuration

• FLOWISE_CHATFLOW_DESCRIPTIONS: A comma-separated list of chatflow_id:description pairs, for example:

  FLOWISE_CHATFLOW_DESCRIPTIONS="abc123:Chatflow One,xyz789:Chatflow Two"
  

Filtering Chatflows

You can use the following environment variables to filter chatflows:

• Whitelist by ID:
  FLOWISE_WHITELIST_ID="id1,id2,id3"
• Blacklist by ID:
  FLOWISE_BLACKLIST_ID="id4,id5"
• Whitelist by Name Regex:
  FLOWISE_WHITELIST_NAME_REGEX=".*important.*"
• Blacklist by Name Regex:
  FLOWISE_BLACKLIST_NAME_REGEX=".*deprecated.*"

⚠️ Important Note

The whitelist takes precedence over the blacklist. If both the whitelist and blacklist are set, the strictest rule will apply.

Security

• Protect API Keys: Ensure that FLOWISE_API_KEY is not leaked or exposed in logs or code repositories.
• Environment Configuration: Use the .env file or environment variables to manage sensitive configurations.

Add .env to your .gitignore:

# .gitignore
.env

Troubleshooting

• Missing API Key: Make sure FLOWISE_API_KEY is set correctly.
• Invalid Configuration: If both FLOWISE_CHATFLOW_ID and FLOWISE_ASSISTANT_ID are set, the server will refuse to start.
• Connection Error: Verify that FLOWISE_API_ENDPOINT is reachable.

📄 License

This project is licensed under the MIT License. For more details, see the LICENSE file.

TODO

• [x] Fastmcp mode
• [x] Lowlevel mode
• [x] Filtering feature
• [x] Claude desktop integration
• [ ] Assistant feature