mcp-server-neon

Сервер Neon MCP

Neon MCP Server — это инструмент с открытым исходным кодом, позволяющий вам взаимодействовать с базами данных Neon Postgres на естественном языке .

Model Context Protocol (MCP) — это новый стандартизированный протокол, предназначенный для управления контекстом между большими языковыми моделями (LLM) и внешними системами. Этот репозиторий предлагает установщик и сервер MCP для Neon .

Сервер Neon MCP выступает в качестве моста между запросами на естественном языке и API Neon . Созданный на основе MCP, он преобразует ваши запросы в необходимые вызовы API, позволяя вам легко управлять такими задачами, как создание проектов и ветвей, выполнение запросов и миграция баз данных.

Некоторые из ключевых особенностей сервера Neon MCP включают в себя:

• Взаимодействие на естественном языке: управляйте базами данных Neon с помощью интуитивно понятных диалоговых команд.
• Упрощенное управление базой данных: выполняйте сложные действия без написания SQL или прямого использования API Neon.
• Доступность для неразработчиков: предоставьте пользователям с различным техническим опытом возможность взаимодействовать с базами данных Neon.
• Поддержка миграции базы данных: используйте возможности ветвления Neon для изменений схемы базы данных, инициированных с помощью естественного языка.

Например, в Claude Desktop или любом MCP Client вы можете использовать естественный язык для выполнения задач с Neon, таких как:

• Let's create a new Postgres database, and call it "my-database". Let's then create a table called users with the following columns: id, name, email, and password.
• I want to run a migration on my project called "my-project" that alters the users table to add a new column called "created_at".
• Can you give me a summary of all of my Neon projects and what data is in each one?

[!ПРИМЕЧАНИЕ]
Сервер Neon MCP предоставляет мощные возможности управления базами данных с помощью запросов на естественном языке. Всегда проверяйте и авторизуйте действия, запрошенные LLM, перед выполнением. Убедитесь, что только авторизованные пользователи и приложения имеют доступ к серверу Neon MCP и ключам API Neon.

Настройка сервера Neon MCP

У вас есть два варианта подключения вашего клиента MCP к Neon:

1. Удаленный сервер MCP (предварительная версия): подключение к управляемому серверу MCP Neon с использованием OAuth для аутентификации. Этот метод более удобен, поскольку устраняет необходимость управления ключами API. Кроме того, вы автоматически получите новейшие функции и улучшения, как только они будут выпущены.
2. Локальный сервер MCP: запустите сервер Neon MCP локально на своем компьютере, выполнив аутентификацию с помощью ключа API Neon.

Предпосылки

• Клиентское приложение MCP.
• Аккаунт Neon .
• Node.js (>= v18.0.0) и npm: загрузить с nodejs.org .

Для настройки локального сервера MCP вам также понадобится ключ Neon API. Инструкции по его генерации см. в документации по ключам Neon API .

Вариант 1. Удаленный сервер MCP (предварительная версия)

Подключитесь к управляемому серверу MCP Neon, используя OAuth для аутентификации. Это самая простая настройка, не требующая локальной установки этого сервера и не требующая ключа API Neon, настроенного в клиенте.

• Добавьте следующую запись «Neon» в файл конфигурации сервера MCP вашего клиента (например, mcp.json , mcp_config.json ):
  { "mcpServers": { "Neon": { "command": "npx", "args": ["-y", "mcp-remote", "https://mcp.neon.tech/sse"] } } }
• Сохраните файл конфигурации.
• Перезапустите или обновите клиент MCP.
• В вашем браузере откроется окно OAuth. Следуйте инструкциям, чтобы авторизовать вашего клиента MCP для доступа к вашей учетной записи Neon.

Вариант 2. Локальный MCP-сервер

Запустите сервер Neon MCP на локальном компьютере.

Настройка через Smithery:

Вам будет предложено ввести ключ API Neon. Введите ключ API, который вы получили в разделе предварительных условий. Замените <client_name> на имя вашего клиентского приложения MCP. Поддерживаемые имена клиентов включают:

• claude для рабочего стола Клода
• cursor для курсора (Установка через smithery делает сервер MCP глобальным сервером MCP в курсоре)
• windsurf для редактора Windsurf
• roo-cline для расширения Roo Cline VS Code
• witsy для остроумный
• enconvo для Enconvo
• vscode для Visual Studio Code (предварительная версия)

Перезапустите клиент MCP после установки.

Настройка через npm

Если ваш клиент MCP не указан здесь, вы можете вручную добавить данные сервера Neon MCP в файл mcp_config вашего клиента.

Добавьте следующую конфигурацию JSON в раздел mcpServers файла mcp_config вашего клиента, заменив <YOUR_NEON_API_KEY> вашим фактическим ключом API Neon:

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

Если ваш клиент не использует JSON для настройки серверов MCP (например, старые версии Cursor), вы можете использовать следующую команду при появлении соответствующего запроса:

Устранение неполадок в Windows

Если вы используете Windows и столкнулись с проблемами при добавлении сервера MCP, вам может потребоваться использовать командную строку ( cmd ) или подсистему Windows для Linux ( wsl ) для запуска необходимых команд. Ваша настройка конфигурации может выглядеть следующим образом:

Руководства

• Руководство по серверу Neon MCP
• Подключите клиентов MCP к Neon
• Курсор с Neon MCP Server
• Рабочий стол Claude с сервером Neon MCP
• Cline с сервером Neon MCP
• Виндсерфинг с сервером Neon MCP
• Zed с сервером Neon MCP

Функции

Поддерживаемые инструменты

Neon MCP Server предоставляет следующие действия, которые представлены как «инструменты» для MCP Clients. Вы можете использовать эти инструменты для взаимодействия с вашими проектами и базами данных Neon с помощью команд естественного языка.

Управление проектом:

• list_projects : извлекает список ваших проектов Neon, предоставляя сводку по каждому проекту, связанному с вашей учетной записью Neon.
• describe_project : извлекает подробную информацию о конкретном проекте Neon, включая его идентификатор, название и связанные ветви и базы данных.
• create_project : Создает новый проект Neon в вашей учетной записи Neon. Проект действует как контейнер для ветвей, баз данных, ролей и вычислений.
• delete_project : Удаляет существующий проект Neon и все связанные с ним ресурсы.

Управление филиалом:

• create_branch : Создает новую ветку в указанном проекте Neon. Использует функцию ветвления Neon для разработки, тестирования или миграции.
• delete_branch : Удаляет существующую ветку из проекта Neon.
• describe_branch : Извлекает сведения о конкретной ветви, такие как ее имя, идентификатор и родительскую ветвь.

Выполнение SQL-запроса:

• get_connection_string : Возвращает строку подключения к базе данных.
• run_sql : Выполняет один SQL-запрос к указанной базе данных Neon. Поддерживает операции чтения и записи.
• run_sql_transaction : выполняет серию SQL-запросов в рамках одной транзакции к базе данных Neon.
• get_database_tables : выводит список всех таблиц в указанной базе данных Neon.
• describe_table_schema : извлекает определение схемы конкретной таблицы, подробно описывая столбцы, типы данных и ограничения.

Миграции базы данных (изменения схемы):

• prepare_database_migration : Инициирует процесс миграции базы данных. Что особенно важно, создает временную ветвь для безопасного применения и тестирования миграции перед тем, как затронуть основную ветвь.
• complete_database_migration : Завершает и применяет подготовленную миграцию базы данных к основной ветке. Это действие объединяет изменения из временной ветки миграции и очищает временные ресурсы.

Неоновая аутентификация:

• provision_neon_auth : Действие по предоставлению Neon Auth для проекта Neon. Позволяет разработчикам легко настраивать инфраструктуру аутентификации, создавая интеграцию со Stack Auth ( @stackframe/stack ).

Миграции

Миграции — это способ управления изменениями в схеме базы данных с течением времени. С сервером Neon MCP LLM могут безопасно выполнять миграции с помощью отдельных команд «Start» ( prepare_database_migration ) и «Commit» ( complete_database_migration ).

Команда "Start" принимает миграцию и запускает ее в новой временной ветке. После возврата эта команда намекает LLM, что он должен протестировать миграцию в этой ветке. Затем LLM может запустить команду "Commit", чтобы применить миграцию к исходной ветке.

Разработка

Разработка с использованием MCP CLI Client

Самый простой способ итерации на сервере MCP — использовать mcp-client/ . Подробнее см. в mcp-client/README.md .

Разработка с использованием Claude Desktop (локальный сервер MCP)

Затем перезапускайте Claude каждый раз, когда захотите протестировать изменения.

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

Для запуска тестов необходимо настроить файл .env в соответствии с файлом .env.example .