openapi-mcp-server: позволяет ИИ напрямую вызывать службы MCP с помощью открытых API.

Общее введение

openapi-mcp-server - это инструмент с открытым исходным кодом, предназначенный для преобразования API, совместимых с OpenAPI v3.1, в ресурсы, пригодные для использования в искусственном интеллекте. Он поддерживается janwilmake и разработан на основе протокола Model Context Protocol (MCP). Основная функция проекта - выступать в качестве API-прокси, позволяя разработчикам использовать Клод Такие инструменты, как Desktop, взаимодействуют непосредственно с API. Этот инструмент особенно подходит для разработчиков и инженеров по искусственному интеллекту, которым необходимо быстро интегрировать API. Он отличается простотой и понятностью, открыт на GitHub и свободен для использования и внесения кода.

openapi-mcp-server:让AI直接调用开放API的MCP服务

 

Список функций

  • API для прокси MCP: Преобразует конечные точки, специфицированные OpenAPI, в инструменты, пригодные для использования в Claude.
  • Поддержка нескольких форматов: API могут быть преобразованы в OpenAI, Anthropic или MCP Формат инструмента.
  • работа в командной строке: Предоставляет инструменты CLI для облегчения программных вызовов API.
  • образец сервера: Встроенные примеры API Petstore помогут пользователям быстро освоиться.
  • С открытым исходным кодом и бесплатно: Код находится в открытом доступе и может быть свободно изменен и расширен пользователем.

 

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

openapi-mcp-server не требует сложной установки, просто получите исходный код через GitHub и запустите его. Вот подробные шаги.

Установка и эксплуатация

  1. Подготовка среды
    Убедитесь, что на вашем компьютере установлены Node.js и pnpm (рекомендуется). Это можно проверить с помощью команды:
node -v
pnpm -v

Если нет, посетите https://nodejs.org ответить пением https://pnpm.io Загрузите и установите.
2. склад клонов
Откройте терминал и введите:

git clone https://github.com/janwilmake/openapi-mcp-server.git
cd openapi-mcp-server
  1. Установка зависимостей
    Запустите в каталоге проекта:
pnpm install
  1. Постройте проект
    Соберите код для обеспечения правильной работы:
pnpm build
  1. Связывание глобальных команд
    Сделайте доступными инструменты командной строки:
npm link

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

  1. Редактирование файла конфигурации
    Найдите файл конфигурации для Claude Desktop, который обычно находится в:
  • Окна. %AppData%\Claude\claude_desktop_config.json
  • Мак. ~/Library/Application Support/Claude/claude_desktop_config.json
    Если нет, создайте новый файл.
  1. Добавление сервера MCP
    Добавьте следующее в файл конфигурации:
{
"mcpServers": {
"petstore-api": {
"command": "npx",
"args": ["openapi-mcp-server", "/path/to/petstore-openapi.json"]
}
}
}

главнокомандующий (военный) /path/to/petstore-openapi.json Замените его на путь к вашему файлу OpenAPI, например, к файлу проекта examples/petstore-openapi.json.
3. Запустить Claude Desktop
Запустите Claude Desktop, и он автоматически загрузит этот сервер.

Вызов API с помощью CLI

  1. Подготовка файла OpenAPI
    Убедитесь, что у вас есть файл OpenAPI v3.1 JSON для целевого API, например petstore-openapi.json.
  2. Выполнить команду
    Введите его в терминал:
npx openapi-mcp-server /path/to/your-openapi.json

Это приведет к запуску прокси-сервера.
3. Пример тестового зоомагазина
Проект поставляется с примером API Petstore. Запустите его:

npx openapi-mcp-server examples/petstore-openapi.json

Затем взаимодействуйте с ним в Claude Desktop, например, набрав "get pet by ID".

API программной конверсии

  1. модуль импорта
    В свой проект Node.js добавьте код:
import { OpenAPIToMCPConverter } from 'openapi-mcp-server';
  1. API конверсии
    Используйте следующий код для преобразования OpenAPI в инструментальный формат:
const converter = new OpenAPIToMCPConverter(openApiSpec); // openApiSpec 是你的 JSON 数据
const openAiTools = await converter.convertToOpenAITools(); // 转为 OpenAI 格式
const mcpTools = converter.convertToMCPTools(); // 转为 MCP 格式
  1. Вызов API
    Используйте HttpClient для выполнения запроса:
import { HttpClient } from 'openapi-mcp-server';
const httpClient = new HttpClient({ baseUrl: 'https://api.example.com' }, openApiSpec);
const response = await httpClient.executeOperation(mcpTools.openApiLookup['getPetById'], { petId: 123 });

предложение по эксплуатации

  • Проблемы отладки: Если Claude терпит неудачу, проверьте, в порядке ли файл OpenAPI, используя https://editor.swagger.io Валидация.
  • Код обновления: После изменения кода выполните pnpm build и перезапустите Claude Desktop.
  • Пример обучения: Смотреть examples/README.mdЧтобы понять CRUD-операции сервера Petstore, вам нужно знать, как использовать сервер Petstore.

 

сценарий применения

  1. Быстрая интеграция API
    Разработчик хочет добавить в проект функциональность управления домашними животными. Он загрузил API Petstore с помощью openapi-mcp-server и протестировал конечные точки непосредственно в Claude, чтобы сэкономить время на написание кода вручную.
  2. Разработка с помощью искусственного интеллекта
    Инженеру по искусственному интеллекту необходимо сгенерировать код вызова API. Он конвертирует файл OpenAPI с помощью инструмента и генерирует полный код запроса с помощью Claude.
  3. Учебная демонстрация
    На примере Petstore преподаватель показывает студентам, как подключать API к инструментам искусственного интеллекта и изучать взаимодействие API.

 

QA

  1. Нужно ли мне платить?
    В этом нет необходимости, проект полностью открыт и бесплатен, он размещен на GitHub.
  2. Какие API поддерживаются?
    Подойдет любой API, входящий в спецификацию OpenAPI v3.1, например, GitHub, Cloudflare и т.д.
  3. Что, если Клод не узнает его?
    Проверьте правильность пути к файлу конфигурации и файлу OpenAPI и убедитесь, что сервер работает.
© заявление об авторских правах

Похожие статьи

Нет комментариев

Вы должны войти в систему, чтобы участвовать в комментариях!
Войти сейчас
нет
Нет комментариев...