Skip to main content
Glama
deenesjakoruzh
m-7-m

Genesys Flow MCP

by m-7-m
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

Genesys Flow MCP

Локальный MCP-сервер, который подключается к Genesys Cloud, выводит список IVR-маршрутов, получает настроенный поток рабочего времени для IVR и создает читабельную документацию в формате Markdown.

Сгенерированный документ предназначен как для бизнес-, так и для технических читателей:

  • Маршрут — имя IVR, ID, состояние, DNIS (при наличии) и настроенный поток.

  • Бизнес-фокус — назначение потока и маршрутизация клиентского меню.

  • Технический фокус — настройки потока, переменные, подсказки/TTS, задачи, меню и пути решений.

  • Интеграции и зависимости маршрутизации — Data Actions, Bot Flows и очереди ACD.

Предварительные требования

  • Node.js 18 или новее

  • OAuth-клиент Genesys Cloud с типом предоставления Client Credentials

  • Разрешения на чтение IVR и потоков Architect в соответствующей организации Genesys Cloud

Related MCP server: Hive Mind MCP Server

Установка и настройка

Установите зависимости:

cd <path-to-genesys-flow-mcp>
npm install

Создайте файл .env в корне проекта:

GENESYS_CLIENT_ID=your-client-id
GENESYS_CLIENT_SECERET=your-client-secret
GENESYS_REGION=ie

Важно: GENESYS_CLIENT_SECERET намеренно написано именно так, потому что это соответствует текущему исходному коду. Не переименовывайте его в SECRET, если вы также не обновите src/config/env.ts.

Установите GENESYS_REGION в суффикс региона Genesys Cloud, например ie для mypurecloud.ie.

Локальный запуск

Для разработки:

npm run dev

Для скомпилированного сервера, используемого настольными клиентами:

npm run build
npm start

Сервер использует транспорт MCP stdio. Он запускается MCP-клиентом; он не предоставляет URL в браузере или HTTP-порт.

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

Используйте MCP Inspector для непосредственного тестирования сервера перед подключением его к Claude Desktop:

cd <path-to-genesys-flow-mcp>
npm run inspect

Inspector открывает локальный браузерный интерфейс. В нем:

  1. Подключитесь к серверу, используя стандартную конфигурацию stdio.

  2. Откройте вкладку Tools.

  3. Запустите get_ivrs, чтобы подтвердить аутентификацию Genesys и получение маршрутов.

  4. Запустите get_flow_by_name с именем IVR, например:

    {
  "name": "testt call"
}

  5. Проверьте, что ответ начинается с раздела Маршрут и содержит настроенный поток, подсказки и интеграции.

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

get_ivrs

Возвращает список маршрутизации/IVR Genesys Cloud.

Пример запроса:

List the available Genesys IVRs.

get_flow_by_name

Ищет IVR по имени, получает его настроенный поток рабочего времени и возвращает документацию в формате Markdown.

Входные данные:

{
  "name": "testt call"
}

Пример запроса:

Use get_flow_by_name for the IVR named "testt call".

Если IVR не найден или у него нет потока рабочего времени, инструмент возвращает ошибку с описанием проблемы.

Что включает сгенерированная документация

Документация соответствует приведенной ниже взаимосвязи:

Genesys IVR Route
        ↓
Configured Open-Hours Flow
        ├── Business Focus: customer routing and menu choices
        └── Technical Focus: prompts, variables, tasks, menus, integrations

Обнаружение интеграций охватывает следующие распространенные зависимости Architect:

Элемент Architect

Документируется как

DataAction

Data Action / Web Services Data Action

CallBotFlowAction

Bot Flow, включая имя и ID потока

TransferPureMatchAction

Очередь ACD

Все TTS-подсказки, найденные в задачах и приветствиях меню, включены в технический разбор потока.

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

  1. Соберите проект:

    cd <path-to-genesys-flow-mcp>
npm run build

  2. В Claude Desktop откройте:

    File → Settings → Developer → Edit Config

  3. Добавьте следующее на верхний уровень открытого JSON-файла. Сохраните все существующие настройки, такие как preferences.

    {
  "mcpServers": {
    "genesys-flow": {
      "command": "node",
      "args": [
        "<path-to-genesys-flow-mcp>\\dist\\index.js"
      ],
      "env": {
        "GENESYS_CLIENT_ID": "your-client-id",
        "GENESYS_CLIENT_SECERET": "your-client-secret",
        "GENESYS_REGION": "ie"
      }
    }
  }
}

    Замените <path-to-genesys-flow-mcp> на полный путь к вашей локальной папке проекта. Если файл уже содержит свойства, добавьте mcpServers рядом с ними и убедитесь, что предыдущее свойство заканчивается запятой.

  4. Полностью завершите работу и снова откройте Claude Desktop.

  5. Начните новый чат и спросите:

    What Genesys tools are available?

    Затем протестируйте документацию:

    Use get_flow_by_name for the IVR named "testt call" and document its route, configured flow, prompts, and integrations.

Не коммитьте и не публикуйте конфигурацию Claude Desktop, если она содержит ваш секрет клиента. Для локального тестирования на личном устройстве допустимо передавать учетные данные через блок env в MCP. Используйте выделенный OAuth-клиент с минимально необходимыми разрешениями Genesys.

Проверка сборки

Запустите проверку сборки TypeScript после изменений кода:

npm run build

Структура проекта

src/
├── config/       Environment variable validation
├── mcp/          MCP server and tool registration
├── services/     Genesys authentication, API access, and documentation generation
├── tools/        MCP tool handlers
└── types/        Genesys Cloud response types

Available Tools

2 tools
get_flow_by_nameB

Get a documented Genesys flow by IVR name.

ParametersJSON Schema
NameRequiredDescriptionDefault
nameYesIVR name

TDQS

B3.3/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations exist, so the description carries the full burden. It only states the action (get by name) and adds the adjective 'documented' as a constraint, but does not disclose output format, error behavior, authentication needs, or whether the operation is safe/read-only. Minimal behavioral context beyond the name.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single, front-loaded sentence with the verb and resource clearly stated. No filler or redundancy. Every word earns its place.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple one-parameter lookup tool, the description covers the core purpose. However, with no output schema, it omits return value details (what a 'documented flow' looks like) and does not disambiguate from the sibling tool. Adequate but with notable gaps.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% with the 'name' parameter described as 'IVR name'. The description repeats this same context, adding no new meaning beyond the schema. Baseline of 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description uses a specific verb 'Get' and resource 'documented Genesys flow' with a clear lookup scope ('by IVR name'). It effectively distinguishes itself from the sibling tool 'get_ivrs' by targeting flows rather than IVR lists.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No explicit when-to-use or alternatives are provided. The sibling tool 'get_ivrs' is not mentioned, and the description does not clarify when to choose this over getting IVRs. Guidance is only implicit via the IVR name parameter.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

get_ivrsA

Get all available IVRs from Genesys Cloud.

ParametersJSON Schema
NameRequiredDescriptionDefault

No parameters

TDQS

A3.8/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations exist, and the description does not disclose any behavioral aspects such as permissions, side effects, or rate limits.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, concise sentence with no superfluous words, perfectly sized for its simplicity.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the absence of an output schema, the description adequately conveys that the tool returns all available IVRs, satisfying the need for a simple list retrieval.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

There are no parameters, so the description fully covers the input schema; no additional explanation needed.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the verb 'Get' and the resource 'all available IVRs', distinct from the sibling tool 'get_flow_by_name' which targets flows.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No explicit guidance on when to use this tool versus alternatives; usage is implied as the go-to for fetching all IVRs.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

  1. 2 tool updatesv1.0.0
    • First observedget_flow_by_name
    • First observedget_ivrs
Deploy Server
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

TDQS

B3.4/5.0

Scored across 2 tools

Disambiguation4/5

The two tools are distinct: one retrieves IVRs, the other retrieves a flow by name. However, the second tool's description is unclear about what 'documented' means and how it relates to the IVR name, which could cause slight confusion.

Naming Consistency4/5

Both tools follow the get_ pattern with noun complements (ivrs, flow_by_name). The naming is mostly consistent but 'flow_by_name' includes a qualifier that 'ivrs' lacks, a minor deviation.

Tool Count3/5

With only two tools, the server covers a very narrow scope. While this may be appropriate for a minimal integration, it feels thin and may not justify a dedicated server.

Completeness2/5

The domain appears to be IVR and flow management, but only retrieval operations are present. Missing operations like creating, updating, or deleting flows/IVRs are significant gaps, leaving the surface incomplete.

Maintenance

ActivityMaintained
ResponsivenessSyncing

Resources

Related MCP Connectors

Related MCP Servers

  • Hive Mind MCP Server

    Jahanzaib-Kaleem
    A
    license
    Not graded
    quality
    D
    maintenance
    Automatically generates and maintains living documentation for codebases by creating hierarchical hivemind.md files and flowchart diagrams at every directory level, enabling AI navigation and real-time or retroactive documentation of code structure, requirements, and dependencies.
    MIT

  • Documentation MCP Server

    esola-thomas
    A
    license
    A
    quality
    C
    maintenance
    Enables AI assistants to navigate and query hierarchical documentation structures, supporting markdown files with YAML metadata and OpenAPI 3.x specifications. It features intelligent full-text search, metadata filtering, and a built-in web interface for both human and AI-driven documentation access.
    6
    MIT