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

💻 使用例

基本的な使用法

# 会話フローの登録
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)

高度な使用法

# 会話フローの一覧取得と削除
from mcp_flowise import MCPFlowise

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

# 会話フロー一覧取得
chatflows = client.list_chatflows()
print(chatflows)

# 会話フロー削除
response = client.delete_chatflow(chatflow_id="chatflow_id")
print(response)

📚 ドキュメント

環境変数

必要な設定

• FLOWISE_API_KEY: Flowise API トークン（必須）。
• 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 統合
• [ ] アシスタント機能