Skip to main content

MCP server for Gramax documentation portal — search, read articles, browse catalogs

Project description

gramax-docportal-mcp

MCP-сервер для доступа к порталу документации Gramax. Позволяет искать статьи, получать контент и навигацию через Claude и другие LLM.

Инструменты

Инструмент Описание
gramax_list_catalogs Список всех каталогов документации
gramax_get_navigation Дерево навигации каталога
gramax_search Поиск по статьям (фильтры по свойствам, языку, семантический поиск)
gramax_get_article Содержимое статьи в Markdown

Установка

uv tool install gramax-docportal-mcp

Настройка

Добавьте в .mcp.json:

{
  "mcpServers": {
    "gramax": {
      "command": "uvx",
      "args": ["gramax-docportal-mcp"],
      "env": {
        "GRAMAX_BASE_URL": "https://your-portal.example.com",
        "GRAMAX_API_TOKEN": "ваш-api-токен"
      }
    }
  }
}

Публичные порталы (без токена)

Если портал публичный (не требует авторизации), GRAMAX_API_TOKEN можно не задавать — сервер работает в анонимном режиме:

{
  "mcpServers": {
    "gramax": {
      "command": "uvx",
      "args": ["gramax-docportal-mcp"],
      "env": {
        "GRAMAX_BASE_URL": "https://your-portal.example.com"
      }
    }
  }
}

Получение токена

Если портал защищён, откройте в браузере (будучи залогиненным на портале):

https://your-portal.example.com/api/user/token

Токен действует 30 дней. Для кастомного срока:

https://your-portal.example.com/api/user/token?expiresAt=2026-12-31

Без токена или с истёкшим токеном сервер получит 401 при первом запросе и вернёт русскоязычное сообщение об ошибке.

Переменные окружения

Переменная Описание Обязательно
GRAMAX_BASE_URL URL портала документации Да
GRAMAX_API_TOKEN API-токен (Bearer); не нужен для публичных порталов Нет

Расширенный поиск

gramax_search поддерживает дополнительные параметры для точной фильтрации:

Параметр Описание
catalog_name Ограничить поиск одним каталогом
search_type "vector" — семантический поиск (по умолчанию — полнотекстовый)
language Язык статей: "ru", "en", "de", "zh" и др.
resource_filter "without" — только статьи, "only" — только файлы
property_filter Фильтр по свойствам статей (Продукт, Сегмент, Отрасль и др.)

Примеры property_filter

{"op": "eq", "key": "Продукт", "value": "NSD"}

{"op": "contains", "key": "Сегмент", "list": ["Enterprise", "SMB"]}

{"op": "and", "filters": [
  {"op": "eq", "key": "Тип контента", "value": "Кейс"},
  {"op": "eq", "key": "Отрасль", "value": "Логистика"}
]}

В результатах поиска отображаются метаданные статей (🏷️) и рекомендованные результаты (⭐).

Лицензия

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gramax_docportal_mcp-0.3.1.tar.gz (13.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

gramax_docportal_mcp-0.3.1-py3-none-any.whl (13.0 kB view details)

Uploaded Python 3

File details

Details for the file gramax_docportal_mcp-0.3.1.tar.gz.

File metadata

  • Download URL: gramax_docportal_mcp-0.3.1.tar.gz
  • Upload date:
  • Size: 13.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.19 {"installer":{"name":"uv","version":"0.11.19","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for gramax_docportal_mcp-0.3.1.tar.gz
Algorithm Hash digest
SHA256 ac81864909f8a89b50a4802be46225cc3d38dbf54b2d207a0109524912ec88ad
MD5 bab71161270642a2316acd054caba62f
BLAKE2b-256 b69a2b9774a4b57bdad1443a8ebd2b21637abd1311b71743653fe3e4fa7f2912

See more details on using hashes here.

File details

Details for the file gramax_docportal_mcp-0.3.1-py3-none-any.whl.

File metadata

  • Download URL: gramax_docportal_mcp-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 13.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.19 {"installer":{"name":"uv","version":"0.11.19","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for gramax_docportal_mcp-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f9ade02459c3363959df536ef7d39081de840760967aadda8302eb10ef5fc872
MD5 043b2ace1dc686033400649fd87455bb
BLAKE2b-256 b1229d5f459b3d4964130921e957416830e039402d9177736040e23efe194320

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page