Soracom Knowledge MCP Server

Soracom Knowledge MCP Server — это сервер MCP (Model Context Protocol), который позволяет искусственным агентам искать документацию Soracom и ссылки на Soracom API непосредственно в вашей среде разработки. При подключении к MCP-клиенту, такому как Claude Code, OpenAI Codex, или Claude Desktop, агент может запрашивать руководства по сервисам, процедуры в Soracom User Console, данные о ценах, IoT-рецепты, справочные материалы по Soracom API, команды CLI и разрешения SAM по мере необходимости и опираться на официальную документацию, а не только на данные обучения.

Сервер размещается Soracom как общий, только для чтения конечной точки. Он не изменяет ваши ресурсы Soracom — агент только выполняет поиск и чтение документации.

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

Сервер предоставляет три инструмента только для чтения подключённому агенту. Ни один из них не изменяет вашу учётную запись или её ресурсы.

По умолчанию сервер работает в режиме hybrid, который объединяет поиск по ключевым словам и семантический поиск (с использованием эмбеддингов OpenAI) и объединяет результаты с помощью техники Reciprocal Rank Fusion (RRF).

search_soracom_docs

Поиск руководств по сервисам Soracom, процедур Soracom User Console, обзоров сервисов и цен, а также IoT-рецептов.

Параметр	Описание
query	Запрос на естественном языке (обязательно).
document_names	Ограничивает поиск конкретными сайтами (например, ["developers.soracom.io", "users.soracom.io"]). Доступные сайты перечислены в схеме инструмента. Пропустите, чтобы искать по всем источникам.
search_mode	hybrid (по умолчанию; объединяет поиск по ключевым словам и семантический поиск), keyword (только поиск по ключевым словам) или semantic (только семантическое сходство).
language	English или Japanese. Автоматическое определение языка на основе запроса, если он опущен.
max_results	Количество результатов, которые нужно вернуть. По умолчанию 16, максимум 32.

search_api_docs

Поиск ссылок на Soracom API, CLI-команды и разрешения SAM.

Параметр	Описание
query	Вопрос на естественном языке или имя конечной точки API. Опционально, если задан хотя бы один из tag, method или path.
tag	Ограничивает результаты одним тегом сервиса (например, Sim, Subscriber, Flux). Без учёта регистра — точное совпадение.
method	Ограничивает результаты HTTP-методом (например, GET, POST). Без учёта регистра — точное совпадение.
path	Ограничивает результаты фрагментом пути API (например, /sims). Без учёта регистра — частичное совпадение.
search_mode	hybrid (по умолчанию; объединяет поиск по ключевым словам и семантический поиск), keyword (только поиск по ключевым словам), или semantic (только семантическое сходство).
language	English или Japanese. Автоопределение языка по запросу, если запрос задан. Если запрос опущен, язык следует указать явно.
max_results	Количество результатов. По умолчанию 16, максимум 32.

get_document

Извлекает полный Markdown страницы, возвращённой с помощью search_soracom_docs или search_api_docs.

Параметр	Описание
url	URL страницы, которую нужно получить (обязательно). Передавайте значение url дословно из результата поиска. Результат может возвращать URL, который не напрямую просматривается в браузере (например, фрагмент разделённой ссылки API), но этот инструмент всё равно может извлечь его содержимое.

Подключение сервера

Сервер доступен по стабильной общедоступной HTTPS‑точке и использует транспорт MCP Streamable HTTP:

https://knowledge-mcp.soracom.com

Предупреждение

У сервера нет личной аутентификации пользователя. Он только ищет и возвращает общедоступную документацию Soracom, но любой введённый вами запрос отправляется на конечную точку. В режиме hybrid или semantic ваш запрос также отправляется в OpenAI для генерации эмбеддингов. Не включайте конфиденциальную информацию, идентификаторы учётных записей, учётные данные или персональные данные в ваши запросы.

По условиям и политикам конфиденциальности Soracom смотрите Terms and Conditions и Privacy Policy. Soracom не регистрирует и не сохраняет содержимое ваших запросов в своей серверной аналитике. Soracom также не передаёт входные данные или выходы API OpenAI в OpenAI для улучшения моделей, оценки, тонкой настройки или обучения. Подробности смотрите в OpenAI's Business data privacy, security, and compliance.

Использование этого сервера подпадает под нашу Site Policy (доступна на японском языке), которая включает отказ от ответственности, условия авторского права и устанавливает, что использование регулируется законами Японии, с Токийским окружным судом в качестве исключительной инстанции. Японский текст имеет преимущество.

Claude Code

Claude Code поддерживает удалённые HTTP MCP‑серверы нативно. Добавьте сервер с помощью команды:

claude mcp add --transport http soracom-knowledge https://knowledge-mcp.soracom.com

Проверьте, что сервер подключён:

claude mcp list

Сервер soracom-knowledge и его три инструмента теперь доступны в ваших сессиях Claude Code. Чтобы удалить его позже, выполните claude mcp remove soracom-knowledge.

OpenAI Codex

CLI Codex поддерживает удалённые MCP‑серверы через HTTP. Добавьте сервер со следующим вызовом:

codex mcp add soracom-knowledge --url https://knowledge-mcp.soracom.com

Проверьте конфигурацию серверов:

codex mcp list

Замечания и ограничения

Этот сервер предоставляется бесплатно на основе доброй воли и без SLA. Его характеристики могут изменяться без предупреждения по мере улучшения сервиса.
Доступ может быть временно ограничен при обнаружении чрезмерного количества запросов.
Результаты поиска могут включать страницы, которые не прямо связаны с вашим запросом. Ожидается, что агент их отфильтрует; рассматривайте отдельные результаты как кандидатуры, а не как авторитетные совпадения.
Информация, возвращаемая этим сервером, предоставляется «AS-IS»; ответы, сгенерированные AI-агентом, не гарантируются как абсолютно точные. Проверяйте важные детали по ссылкам на исходные страницы.
Индекс поиска обновляется периодически, поэтому изменения в публичной документации могут отражаться в результатах поиска с задержкой.

Эта страница повторяет официальную документацию: English | Japanese. Реестр: com.soracom/knowledge на Official MCP Registry.