maixpy-mcp-server

AlexanderChuykin/maixpy-mcp-server

3.2

If you are the rightful owner of maixpy-mcp-server and would like to certify it and/or have it hosted online, please leave a comment on the right or send an email to dayong@mcphub.com.

The MaixPy Documentation MCP Server provides access to MaixPy v4 documentation through LLM models like GitHub Copilot, with Docker support for easy deployment.

Tools
5
Resources
0
Prompts
0

MaixPy Documentation MCP Server

MCP (Model Context Protocol) сервер для предоставления документации MaixPy v4 в LLM модели через GitHub Copilot и другие клиенты.

🐳 Теперь с Docker поддержкой! Запускайте в контейнере и подключайтесь по URL.

Возможности

Сервер предоставляет следующие инструменты для работы с документацией MaixPy:

  • search_docs - Поиск по документации (в заголовках, именах файлов, содержимом)
  • get_api_reference - Получение полной API документации модуля
  • list_modules - Список всех доступных модулей MaixPy
  • get_tutorial - Получение учебных пособий по темам
  • read_doc_file - Чтение конкретного файла документации

Установка

Вариант 1: Docker (Рекомендуется) 🐳

Быстрый старт:

# Запуск контейнера
.\docker-start.bat

# Или вручную
docker-compose up -d

Подробнее: См.

Вариант 2: Локальная установка

# Создать виртуальное окружение (опционально)
python -m venv venv
.\venv\Scripts\Activate.ps1

# Установить зависимости
pip install -r requirements.txt

2. Настройка VS Code + GitHub Copilot

Добавьте конфигурацию MCP сервера в настройки VS Code:

Windows: %APPDATA%\Code\User\settings.json

Для Docker (рекомендуется):

{
  "github.copilot.chat.mcp.servers": {
    "maixpy-docs": {
      "url": "http://localhost:8000/sse"
    }
  }
}

Для локальной установки:

{
  "github.copilot.chat.mcp.servers": {
    "maixpy-docs": {
      "command": "python",
      "args": [
        "c:\\dev\\maixpy_mcp\\mcp_server\\server.py"
      ]
    }
  }
}

Важно:

  • Docker: используйте url для подключения по HTTP
  • Локально: используйте command и укажите правильный путь

3. Перезапуск VS Code

После добавления конфигурации перезапустите VS Code для активации MCP сервера.

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

После настройки вы можете обращаться к документации MaixPy через GitHub Copilot Chat:

Примеры запросов:

@workspace Как использовать модуль camera в MaixPy?

@workspace Покажи API документацию для модуля image

@workspace Найди информацию о детекции объектов в MaixPy

@workspace Как работать с нейронными сетями в MaixPy v4?

@workspace Покажи пример работы с дисплеем

Copilot автоматически будет использовать инструменты MCP сервера для поиска актуальной информации в документации.

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

maixpy_mcp/
├── doc_md/                      # Документация MaixPy (markdown)
│   ├── api/                    # API справочник
│   │   └── maix/              # Модули MaixPy
│   └── doc/                   # Руководства и туториалы
│       ├── en/                # Английская документация
│       └── zh/                # Китайская документация
├── mcp_server/                 # MCP сервер
│   ├── __init__.py
│   └── server.py              # Основной код сервера
├── tests/                      # Тесты
│   └── test_server.py         # Тесты функциональности
├── pyproject.toml             # Конфигурация проекта
├── requirements.txt           # Зависимости Python
├── README.md                  # Основная документация
├── QUICKSTART.md              # Быстрый старт
├── SETUP_INSTRUCTIONS.md      # Детальная инструкция
├── USAGE_EXAMPLES.md          # Примеры использования
├── vscode_mcp_config.json     # Пример конфигурации для VS Code
├── run_tests.bat              # Скрипт проверки (Windows)
└── .gitignore

Доступные модули MaixPy v4

Основные модули:

  • image - Работа с изображениями
  • camera - Управление камерой
  • display - Вывод на дисплей
  • nn - Нейронные сети и AI
  • video - Запись и воспроизведение видео
  • audio - Работа со звуком
  • network - Сетевые функции (WiFi, HTTP)
  • peripheral - Периферия (GPIO, I2C, SPI, UART и т.д.)
  • sensor - Датчики и сенсоры

И многие другие...

Разработка

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

# Запуск сервера напрямую
python mcp_server/server.py

Отладка

Логи MCP сервера можно просмотреть в VS Code:

  1. Откройте Output panel (View → Output)
  2. Выберите "GitHub Copilot Chat" из выпадающего списка

Troubleshooting

Сервер не подключается

  1. Проверьте правильность пути в settings.json
  2. Убедитесь что Python доступен в PATH
  3. Проверьте что установлены все зависимости: pip list | findstr mcp
  4. Перезапустите VS Code

Ошибки при работе

Если Copilot не находит документацию:

  • Убедитесь что папка doc_md/ содержит файлы документации
  • Проверьте логи в Output panel
  • Попробуйте более конкретные запросы

Документация проекта

Быстрый старт:

  • - 🐳 Docker установка (рекомендуется) ⚡
  • - локальная установка за 4 шага

Подробная документация:

  • - чеклист установки с проверками ✅
  • - детальная инструкция по настройке 📝
  • - примеры запросов к Copilot 💡
  • - справочник команд 📚
  • - архитектура и протокол MCP 🏗️
  • - обзор проекта 📊

Лицензия

Проект создан для работы с документацией MaixPy v4.

Полезные ссылки