mcp-конфлюэнтный

Реализация сервера MCP, которая позволяет помощникам ИИ взаимодействовать с API REST Confluent Cloud. Этот сервер позволяет инструментам ИИ, таким как Claude Desktop и Goose CLI, управлять темами Kafka, коннекторами и операторами Flink SQL посредством взаимодействия на естественном языке.

Демо

Гусь CLI

Клод Десктоп

Оглавление

• mcp-конфлюэнтный

  • Демо

    • Гусь CLI

    • Клод Десктоп

  • Оглавление

  • Руководство пользователя

    • Начиная

    • Конфигурация

    • Справочник переменных среды

    • Использование

    • Настройка рабочего стола Claude

    • Настройка Goose CLI

    • Использование CLI mcp-confluent

      • Базовое использование

      • Пример: Развертывание с использованием всех транспортов

      • Пример: разрешить только определенные инструменты

      • Пример: блокировка определенных инструментов

      • Пример: использование списков инструментов из файлов

      • Пример: список всех доступных инструментов

  • Руководство разработчика

    • Структура проекта

    • Строительство и запуск

    • Тестирование

      • Инспектор МКП

    • Добавление нового инструмента

    • Генерация типов

    • Внося вклад

Руководство пользователя

Начиная

1. Создайте файл скопируйте пример структуры файла .env (показанный ниже) в новый файл с именем .env в корневом каталоге вашего проекта.

2. Заполните файл заполните необходимые значения для вашей среды Confluent Cloud. Подробности по каждой переменной см. в разделе «Конфигурация» .

3. Установите Node.js (если еще не установлен)

   • Мы рекомендуем использовать NVM (Node Version Manager) для управления версиями Node.js.

   • Установите и используйте Node.js:

   nvm install 22 nvm use 22

Конфигурация

Создайте файл .env в корневом каталоге вашего проекта со следующей конфигурацией:

Справочник переменных среды

Использование

Этот сервер MCP предназначен для использования с различными клиентами MCP, такими как Claude Desktop или Goose CLI/Desktop. Конкретная конфигурация и взаимодействие будут зависеть от используемого вами клиента. Однако общие шаги таковы:

1. Запуск сервера: Вы можете запустить сервер MCP одним из двух способов:

   • Из источника: Следуйте инструкциям в Руководстве разработчика , чтобы собрать и запустить сервер из источника. Обычно это включает:

     • Установка зависимостей ( npm install )

     • Сборка проекта ( npm run build или npm run dev )

   • С помощью npx: Вы можете запустить сервер напрямую с помощью npx (сборка не требуется):

     npx -y @confluentinc/mcp-confluent -e /path/to/confluent-mcp-server/.env

2. Настройте свой MCP-клиент: у каждого клиента будет свой собственный способ указания адреса сервера MCP и любых требуемых учетных данных. Вам нужно будет настроить своего клиента (например, Claude, Goose) для подключения к адресу, где работает этот сервер (вероятно, localhost с определенным портом). Порт, на котором работает сервер, может быть настроен переменной среды.

3. Запустите MCP Client: После того, как ваш клиент настроен на подключение к MCP-серверу, вы можете запустить свой mcp-клиент, и при запуске он поднимет экземпляр этого MCP-сервера локально. Этот экземпляр будет отвечать за управление схемами данных и взаимодействие с Confluent Cloud от вашего имени.

4. Взаимодействие с Confluent через Клиент: После подключения клиента вы можете использовать интерфейс клиента для взаимодействия с ресурсами Confluent Cloud. Клиент будет отправлять запросы на этот сервер MCP, который затем будет взаимодействовать с Confluent Cloud от вашего имени.

Настройка рабочего стола Claude

Более подробную информацию об установке Claude Desktop и серверов MCP смотрите здесь .

Чтобы настроить Claude Desktop для использования этого сервера MCP:

1. Открыть конфигурацию рабочего стола Claude

   • На Mac: ~/Library/Application Support/Claude/claude_desktop_config.json

   • В Windows: %APPDATA%\Claude\claude_desktop_config.json

2. Редактировать файл конфигурации

   • Откройте файл конфигурации в предпочитаемом вами текстовом редакторе.

   • Добавьте или измените конфигурацию одним из следующих способов:

   { "mcpServers": { "confluent": { "command": "node", "args": [ "/path/to/confluent-mcp-server/dist/index.js", "--env-file", "/path/to/confluent-mcp-server/.env", ] } } }
   { "mcpServers": { "confluent": { "command": "npx", "args": [ "-y" "@confluentinc/mcp-confluent", "-e", "/path/to/confluent-mcp-server/.env" ] } } }

   Замените /path/to/confluent-mcp-server/ на фактический путь, по которому вы установили этот сервер MCP.

3. Перезагрузить рабочий стол Клода

   • Закройте и снова откройте Claude Desktop, чтобы изменения вступили в силу.

   • Сервер MCP автоматически запустится при запуске Claude Desktop.

Теперь Claude Desktop будет настроен на использование вашего локального сервера MCP для взаимодействий Confluent.

Настройка Goose CLI

Подробные инструкции по установке Goose CLI смотрите здесь .

После установки выполните следующие действия:

1. Выполните команду конфигурации:

   goose configure

2. Следуйте интерактивным подсказкам:

   • Выберите Add extension

   • Выберите Command-line Extension

   • Введите mcp-confluent в качестве имени расширения.

   • Выберите один из следующих методов настройки:

   node /path/to/confluent-mcp-server/dist/index.js --env-file /path/to/confluent-mcp-server/.env
   npx -y @confluentinc/mcp-confluent -e /path/to/confluent-mcp-server/.env

Замените /path/to/confluent-mcp-server/ на фактический путь, по которому вы установили этот сервер MCP.

Использование CLI mcp-confluent

Сервер MCP предоставляет гибкий интерфейс командной строки (CLI) для расширенной конфигурации и управления. CLI позволяет вам указывать файлы среды, транспорты и настраивать, какие инструменты включены или заблокированы.

Базовое использование

Вы можете просмотреть все варианты CLI и получить помощь по следующим вопросам:

Пример: Развертывание с использованием всех транспортов

Пример: разрешить только определенные инструменты

Пример: блокировка определенных инструментов

Пример: использование списков инструментов из файлов

Пример: список всех доступных инструментов

Совет: список разрешений применяется до списка блокировок. Если ни один из них не указан, все инструменты включены по умолчанию.

Руководство разработчика

Структура проекта

Строительство и запуск

1. Установить зависимости:

   npm install

2. Режим разработки (следите за изменениями):

   npm run dev

   Эта команда компилирует код TypeScript в JavaScript и автоматически перестраивает его при обнаружении изменений в каталоге src/ .

3. Производственная сборка (однократная компиляция):

   npm run build

4. Запустите сервер:

   npm run start

Тестирование

Инспектор МКП

Для тестирования серверов MCP вы можете использовать MCP Inspector — интерактивный инструмент разработчика для тестирования и отладки серверов MCP.

Добавление нового инструмента

1. Добавьте новое перечисление в класс перечисления ToolName .

2. Добавьте новый инструмент в карту обработчиков в классе ToolFactory .

3. Создайте новый файл, экспортирующий класс, расширяющий BaseToolHandler .

   1. Реализуйте метод handle базового класса.

   2. Реализуйте метод getToolConfig базового класса.

4. После того, как вы все удовлетворены, добавьте его в набор enabledTools в index.ts .

Генерация типов

Внося вклад

Сообщения об ошибках и отзывы приветствуются в форме Github Issues. Для рекомендаций по внесению вклада см. CONTRIBUTING.md