Сервер протокола управления моделями (MCP), позволяющий помощникам с искусственным интеллектом взаимодействовать с базами данных и действиями Metabase.
![Сервер метабазы MCP]
Обзор
Metabase MCP Server обеспечивает мост между помощниками ИИ и Metabase, позволяя моделям ИИ:
- Перечислите и изучите базы данных, настроенные в Metabase
- Извлекайте подробные метаданные о схемах, таблицах и полях базы данных
- Визуализация связей между таблицами в базе данных
- Список и выполнение действий Metabase
- Выполнение операций с данными Metabase через безопасный API
Этот сервер реализует спецификацию [Model Control Protocol (MCP)], что делает его совместимым с помощниками на основе искусственного интеллекта, поддерживающими инструменты MCP.
Функции
- Исследование базы данных : список всех баз данных и исследование их схем.
- Извлечение метаданных : получение подробной информации о таблицах, полях и связях.
- Визуализация отношений : создание визуальных представлений отношений в базе данных.
- Управление действиями : список, просмотр подробностей и выполнение действ��й Metabase
- Безопасная обработка ключей API : хранение ключей API в зашифрованном виде и предотвращение раскрытия информации.
- Веб-интерфейс : тестирование и отладка функциональности через удобный веб-интерфейс.
- Поддержка Docker : простое развертывание с Docker и Docker Compose
Предпосылки
- Экземпляр метабазы (рекомендуется v0.46.0 или выше)
- Ключ API Metabase с соответствующими разрешениями
- Docker (для контейнерного развертывания)
- Python 3.10+ (для локальной разработки)
Установка
Использование Docker (рекомендуется)
- Клонируйте этот репозиторий:
git clone https://github.com/yourusername/metabase-mcp.git
cd metabase-mcp
- Соберите и запустите контейнер Docker:
- Доступ к интерфейсу конфигурации по адресу http://localhost:5001
Ручная установка
- Клонируйте этот репозиторий:
git clone https://github.com/yourusername/metabase-mcp.git
cd metabase-mcp
- Установить зависимости:
pip install -r requirements.txt
- Запустите интерфейс конфигурации:
python -m src.server.web_interface
- Доступ к интерфейсу конфигурации по адресу http://localhost:5000
Конфигурация
- Откройте веб-интерфейс в вашем браузере.
- Введите URL-адрес вашей метабазы (например, http://localhost:3000 )
- Введите свой ключ API Metabase
- Нажмите «Сохранить конфигурацию» и проверьте соединение.
- Войдите в свой экземпляр Metabase как администратор.
- Перейдите в Настройки > Настройки администратора > Ключи API.
- Создайте новый ключ API с соответствующими разрешениями.
- Скопируйте сгенерированный ключ для использования на сервере MCP.
Использование
Запуск сервера MCP
После настройки вы можете запустить сервер MCP:
# Using Docker
docker run -p 5001:5000 metabase-mcp
# Manually
python -m src.server.mcp_server
Доступные инструменты
Сервер MCP предоставляет следующие инструменты помощникам ИИ:
- list_databases : список всех баз данных, настроенных в Metabase
- get_database_metadata : Получить подробные метаданные для определенной базы данных
- db_overview : получить общий обзор всех таблиц в базе данных
- table_detail : Получить подробную информацию о конкретной таблице
- visualize_database_relationships : создание визуального представления связей в базе данных
- run_database_query : Выполнение SQL-запроса к базе данных
- list_actions : Список всех действий, настроенных в Metabase
- get_action_details : Получить подробную информацию о конкретном действии
- execute_action : Выполнить действие Metabase с параметрами
Инструменты тестирования через веб-интерфейс
Веб-интерфейс предоставляет область тестирования для каждого инструмента:
- Список баз данных : просмотр всех баз данных, настроенных в Metabase
- Получить метаданные базы данных : просмотреть подробную информацию о схеме базы данных.
- Обзор БД : просмотр краткого списка всех таблиц в базе данных.
- Подробная информация о таблице : просмотр подробной информации о конкретной таблице.
- Визуализация связей в базе данных : создание визуального представления связей в таблицах.
- Выполнить запрос : выполнение SQL-запросов к базам данных.
- Список действий : просмотр всех действий, настроенных в Metabase
- Получить сведения о действии : просмотреть подробную информацию о конкретном действии.
- Выполнить действие : Тест выполнения действия с параметрами
Соображения безопасности
- Ключи API хранятся в зашифрованном виде.
- Веб-интерфейс никогда не отображает ключи API в виде простого текста.
- Все запросы API используют HTTPS при настройке с защищенным URL-адресом Metabase.
- Сервер должен быть развернут за защищенным прокси-сервером в производственных средах.
Разработка
Структура проекта
metabase-mcp/
├── src/
│ ├── api/ # Metabase API client
│ ├── config/ # Configuration management
│ ├── server/ # MCP and web servers
│ └── tools/ # Tool implementations
├── templates/ # Web interface templates
├── docker-compose.yml # Docker Compose configuration
├── Dockerfile # Docker build configuration
├── requirements.txt # Python dependencies
└── README.md # Documentation
Добавление новых инструментов
Чтобы добавить новый инструмент:
- Реализуйте функцию инструмента в
src/tools/ - Зарегистрируйте инструмент в
src/server/mcp_server.py - Добавьте тестовый интерфейс в
templates/config.html (необязательно) - Добавьте маршрут в
src/server/web_interface.py (если добавляете тестовый интерфейс)
Поиск неисправностей
Распространенные проблемы
- Ошибка подключения : убедитесь, что URL-адрес вашей метабазы правильный и доступен.
- Ошибка аутентификации : убедитесь, что ваш ключ API имеет необходимые разрешения.
- Проблемы с сетью Docker : при использовании Docker убедитесь в правильности конфигурации сети.
Журналы
Проверьте журналы для получения подробной информации об ошибках:
# Docker logs
docker logs metabase-mcp
# Manual execution logs
# Logs are printed to the console
Внося вклад
Вклады приветствуются! Пожалуйста, не стесняйтесь отправлять запрос на включение.