ms82119/nifimcp

NiFi MCP (Model Context Protocol)

Это хранилище содержит проект NiFi MCP. Его можно использовать двумя способами:

Как простой MCP-сервер, к которому могут подключаться такие инструменты, как Cursor AI, Claude Code, Antigravity и т. Д. Или со встроенным (содержащимся в этом репо) чат-ботом, к которому вы можете подключиться из своего браузера.

Любой подход позволяет взаимодействовать с экземплярами Apache NiFi с использованием естественного языка. В настоящее время доступно около 30 инструментов, охватывающих строительство, обновление, запуск, отладку и документирование потоков нифи. Он был протестирован с версиями Nifi 1.23 и 1.28, но должен работать с другими версиями, такими как 2.x.

Встроенный чат-бот требует, чтобы вы поставляли свои собственные ключи API LLM, лучшие модели дают лучшие результаты, и выбор более высокого контекста токена также может помочь. Однако я обнаружил, что использование Cursor AI в автоматическом режиме обеспечивает лучшую производительность и результаты. Это оказалось гораздо лучшим интерфейсом, чем я мог создать с помощью своего собственного чат-бота. Поэтому я рекомендую встроенный чат-бот, только если у вас нет других вариантов.

Примеры разговоров (использование встроенного чат-бота)

NiFi MCP (Model Context Protocol)

This repository contains the NiFi MCP project. It can be used in two ways, either:

• As a plain MCP Server that tools like Cursor AI, Claude Code, Antigravity etc. can connect to via stdio
• Or, with a built-in (contained in this repo) chat bot that you can connect to from your browser.

Either approach allows you to interact with Apache NiFi instances using natural language. There are currently around 30 tools available, covering building, updating, running, debugging, and documenting nifi flows. This has been tested with Nifi versions 1.23 and 1.28, but should work on other versions like 2.x assuming the Nifi REST Api stays consistent.

The built-in chat bot requires you to supply your own LLM API keys, better models give better results and selecting higher token context can help too. I have however found that using Cursor AI in Auto mode gives the best performance and results. It turned out to be a much better interface than I could build with my own chat bot. So I only recommend the built-in chat bot if you have no other options.

Example Conversations (Using built-in chat bot)

• Build A New Flow From A Spec - See how the system creates a complete NiFi flow from requirements
• Debug An Existing Flow - Watch the system diagnose and fix issues in an existing flow

Recent Updates

Version 2.0 - Major UI Overhaul

• Added direct MCP server support for IDE’s like Cursor AI (best option)
• Enhanced the built in chatbot
  • Migrated from Streamlit to FastAPI/JavaScript client for improved performance and user experience
  • Enhanced real-time WebSocket communication for better workflow status updates
  • Improved message handling and duplicate message prevention
  • Modern, responsive UI with better accessibility and mobile support
  • Added a new workflow “Flow Documentation” to help generate better documentation about a flow

For the latest updates and release notes, see the GitHub Releases page.

Setup Instructions

Note: These instructions should also be followed after pulling a new version as there may be new package requirements.

Common Setup Steps (All Versions)

1. Clone the Repository:

   git clone [email protected]:ms82119/NiFiMCP.git
   cd NiFiMCP
   

2. Set Up a Virtual Environment: It’s recommended to use a virtual environment to manage dependencies. You can create one using venv:

   python3 -m venv .venv
   

3. Activate the Virtual Environment:

   • On macOS and Linux:

     source .venv/bin/activate
     

   • On Windows:

     .venv\Scripts\activate
     

4. Install Dependencies: Use uv to install dependencies based on pyproject.toml and uv.lock:

   uv sync