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.2.tar.gz (14.4 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.2-py3-none-any.whl (13.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: gramax_docportal_mcp-0.3.2.tar.gz
  • Upload date:
  • Size: 14.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.20 {"installer":{"name":"uv","version":"0.11.20","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.2.tar.gz
Algorithm Hash digest
SHA256 4b3cd3e997d813b4ec28a00ead5a448e1a3c13b0b80e6915aec9e4b2dc480d54
MD5 274d7e4a7d15179b4d625c62e32ad8fc
BLAKE2b-256 202caccaac10bf98a6387959c377e68e04d7f81a9f7fe35f7ccc25bd2c264508

See more details on using hashes here.

File details

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

File metadata

  • Download URL: gramax_docportal_mcp-0.3.2-py3-none-any.whl
  • Upload date:
  • Size: 13.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.20 {"installer":{"name":"uv","version":"0.11.20","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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 be4ecb9d1aa0f619df80fa53a283ccf606ff7d0bcd7b62f256024e862ae1b4a2
MD5 4a95a13a4237296c1c6218ce4fefe05e
BLAKE2b-256 743cde0aa0d78fbd9f465722071d3ccd8b15e21a55f30ce49b4577ce135f5615

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