Сервер метабазы MCP

Сервер протокола управления моделями (MCP), позволяющий помощникам с искусственным интеллектом взаимодействовать с базами данных и действиями Metabase.

![Сервер метабазы MCP]

Обзор

Metabase MCP Server обеспечивает мост между помощниками ИИ и Metabase, позволяя моделям ИИ:

• Перечислите и изучите базы данных, настроенные в Metabase

• Извлекайте подробные метаданные о схемах, таблицах и полях базы данных

• Визуализация связей между таблицами в базе данных

• Список и выполнение действий Metabase

• Выполнение операций с данными Metabase через безопасный API

Этот сервер реализует спецификацию [Model Control Protocol (MCP)], что делает его совместимым с помощниками на основе искусственного интеллекта, поддерживающими инструменты MCP.

Related MCP server: IoTDB MCP Server

Функции

• Исследование базы данных : список всех баз данных и исследование их схем.

• Извлечение метаданных : получение подробной информации о таблицах, полях и связях.

• Визуализация отношений : создание визуальных представлений отношений в базе данных.

• Управление действиями : список, просмотр подробностей и выполнение действий Metabase

• Безопасная обработка ключей API : хранение ключей API в зашифрованном виде и предотвращение раскрытия информации.

• Веб-интерфейс : тестирование и отладка функциональности через удобный веб-интерфейс.

• Поддержка Docker : простое развертывание с Docker и Docker Compose

Предпосылки

• Экземпляр метабазы (рекомендуется v0.46.0 или выше)

• Ключ API Metabase с соответствующими разрешениями

• Docker (для контейнерного развертывания)

• Python 3.10+ (для локальной разработки)

Установка

Использование Docker (рекомендуется)

1. Клонируйте этот репозиторий:

   git clone https://github.com/yourusername/metabase-mcp.git cd metabase-mcp

2. Соберите и запустите контейнер Docker:

   docker-compose up -d

3. Доступ к интерфейсу конфигурации по адресу http://localhost:5001

Ручная установка

1. Клонируйте этот репозиторий:

   git clone https://github.com/yourusername/metabase-mcp.git cd metabase-mcp

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

   pip install -r requirements.txt

3. Запустите интерфейс конфигурации:

   python -m src.server.web_interface

4. Доступ к интерфейсу конфигурации по адресу http://localhost:5000

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

1. Откройте веб-интерфейс в вашем браузере.

2. Введите URL-адрес вашей метабазы (например, http://localhost:3000 )

3. Введите свой ключ API Metabase

4. Нажмите «Сохранить конфигурацию» и проверьте соединение.

Получение API-ключа Metabase

1. Войдите в свой экземпляр Metabase как администратор.

2. Перейдите в Настройки > Настройки администратора > Ключи API.

3. Создайте новый ключ API с соответствующими разрешениями.

4. Скопируйте сгенерированный ключ для использования на сервере MCP.

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

Запуск сервера MCP

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

Доступные инструменты

Сервер MCP предоставляет следующие инструменты помощникам ИИ:

1. list_databases : список всех баз данных, настроенных в Metabase

2. get_database_metadata : Получить подробные метаданные для определенной базы данных

3. db_overview : получить общий обзор всех таблиц в базе данных

4. table_detail : Получить подробную информацию о конкретной таблице

5. visualize_database_relationships : создание визуального представления связей в базе данных

6. run_database_query : Выполнение SQL-запроса к базе данных

7. list_actions : Список всех действий, настроенных в Metabase

8. get_action_details : Получить подробную информацию о конкретном действии

9. execute_action : Выполнить действие Metabase с параметрами

Инструменты тестирования через веб-интерфейс

Веб-интерфейс предоставляет область тестирования для каждого инструмента:

1. Список баз данных : просмотр всех баз данных, настроенных в Metabase

2. Получить метаданные базы данных : просмотреть подробную информацию о схеме базы данных.

3. Обзор БД : просмотр краткого списка всех таблиц в базе данных.

4. Подробная информация о таблице : просмотр подробной информации о конкретной таблице.

5. Визуализация связей в базе данных : создание визуального представления связей в таблицах.

6. Выполнить запрос : выполнение SQL-запросов к базам данных.

7. Список действий : просмотр всех действий, настроенных в Metabase

8. Получить сведения о действии : просмотреть подробную информацию о конкретном действии.

9. Выполнить действие : Тест выполнения действия с параметрами

Соображения безопасности

• Ключи API хранятся в зашифрованном виде.

• Веб-интерфейс никогда не отображает ключи API в виде простого текста.

• Все запросы API используют HTTPS при настройке с защищенным URL-адресом Metabase.

• Сервер должен быть развернут за защищенным прокси-сервером в производственных средах.

Разработка

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

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

Чтобы добавить новый инструмент:

1. Реализуйте функцию инструмента в src/tools/

2. Зарегистрируйте инструмент в src/server/mcp_server.py

3. Добавьте тестовый интерфейс в templates/config.html (необязательно)

4. Добавьте маршрут в src/server/web_interface.py (если добавляете тестовый интерфейс)

Поиск неисправностей

Распространенные проблемы

• Ошибка подключения : убедитесь, что URL-адрес вашей метабазы правильный и доступен.

• Ошибка аутентификации : убедитесь, что ваш ключ API имеет необходимые разрешения.

• Проблемы с сетью Docker : при использовании Docker убедитесь в правильности конфигурации сети.

Журналы

Проверьте журналы для получения подробной информации об ошибках:

Внося вклад

Вклады приветствуются! Пожалуйста, не стесняйтесь отправлять запрос на включение.