Cognigy.AI Management MCP

Servidor MCP para Cognigy.AI - 132 ferramentas que permitem que Claude, Cursor e outros assistentes de IA construam, configurem, testem e operem agentes de IA conversacional por meio do Model Context Protocol.

Documentação

Servidor MCP de Gerenciamento Cognigy.AI

CI npm version npm downloads node License: MIT Glama Score MCP Registry MCP Badge

cognigy-ai-mcp-management-server

Servidor de Protocolo de Contexto de Modelo (MCP) para gerenciar agentes virtuais Cognigy.AI por meio da API de Gerenciamento

Este é um servidor MCP independente e de código aberto, não afiliado, endossado ou patrocinado pela Cognigy ou NiCE. Ele requer sua própria conta válida no Cognigy.AI e chave de API, usados de acordo com os termos de licença comercial da Cognigy. "Cognigy" e "Cognigy.AI" são marcas registradas de seus respectivos proprietários.

O que é isso?

cognigy-ai-mcp-management-server é um servidor MCP local que permite que assistentes de codificação com IA (Claude, Cursor, etc.) criem, configurem, testem e operem agentes de IA conversacional Cognigy.AI programaticamente.

Em vez de navegar pela interface do Cognigy, agora você pode:

  • Criar e gerenciar fluxos, nós e intenções por meio de linguagem natural
  • Executar treinamento de NLU e testes de regressão automaticamente
  • Implantar snapshots e pacotes entre ambientes
  • Configurar LLMs, Knowledge AI e integrações

Feito para: Desenvolvedores, arquitetos de soluções e parceiros de SI que desenvolvem na Cognigy.AI.

Requisitos

  • Node.js 20.0.0 ou superior
  • Conta Cognigy.AI com acesso à API (Trial, SaaS ou on-premises)
  • Chave de API gerada na interface do Cognigy (Meu Perfil → Chaves de API)

Instalação

# 1. Install the Cognigy REST API client (required peer dependency)
npm install @cognigy/rest-api-client

# 2. Install this MCP server
npm install -g cognigy-ai-mcp-management-server

Importante: O pacote @cognigy/rest-api-client é licenciado sob a "Licença Proprietária Cognigy". Ao instalá-lo, você concorda com os termos de licença da Cognigy.

Configuração

Defina as variáveis de ambiente antes de executar:

# Required: Your Cognigy API endpoint
export COGNIGY_BASE_URL=https://api-trial.cognigy.ai

# Required: Your API key (never commit this!)
export COGNIGY_API_KEY=your-api-key-here

# Optional: Default project for operations
export COGNIGY_DEFAULT_PROJECT_ID=your-project-id

URLs Base Comuns:

AmbienteURL Base
Trialhttps://api-trial.cognigy.ai
SaaS UEhttps://api-app.cognigy.ai
SaaS EUAhttps://api-app-us.cognigy.ai
Dedicadohttps://api-<company>.cognigy.cloud

Configuração do Cliente MCP

Claude Desktop

Adicione ao ~/Library/Application Support/Claude/claude_desktop_config.json (macOS) ou %APPDATA%\Claude\claude_desktop_config.json (Windows):

{
  "mcpServers": {
    "cognigy": {
      "command": "npx",
      "args": ["cognigy-ai-mcp-management-server"],
      "env": {
        "COGNIGY_BASE_URL": "https://api-trial.cognigy.ai",
        "COGNIGY_API_KEY": "your-api-key-here"
      }
    }
  }
}

Claude Code

Adicione ao .mcp.json na raiz do seu projeto:

{
  "mcpServers": {
    "cognigy": {
      "command": "npx",
      "args": ["cognigy-ai-mcp-management-server"],
      "env": {
        "COGNIGY_BASE_URL": "https://api-trial.cognigy.ai",
        "COGNIGY_API_KEY": "your-api-key-here"
      }
    }
  }
}

Cursor

Adicione ao .cursor/mcp.json:

{
  "mcpServers": {
    "cognigy": {
      "command": "npx",
      "args": ["cognigy-ai-mcp-management-server"],
      "env": {
        "COGNIGY_BASE_URL": "https://api-trial.cognigy.ai",
        "COGNIGY_API_KEY": "your-api-key-here"
      }
    }
  }
}

Ferramentas Disponíveis

Todas as Ferramentas

Este servidor fornece 132 ferramentas MCP organizadas por domínio:

CategoriaFerramentasDescrição
Projetos e Fluxos5Listar projetos, fluxos, configurações de fluxo, logs
Nós9Operações CRUD, busca, mover, geração de saída de IA
Intenções e NLU10Gerenciamento de intenções, treinamento, pontuação, auditoria
Endpoints2Listar e inspecionar configurações de endpoints
Sessões2Injetar/redefinir contexto de conversa
Conversas3Buscar conversas, transcrições
Playbooks e Testes6Executar playbooks, testes de regressão
Snapshots9Criar, restaurar, empacotar, comparar, promover
Pacotes7Criar, mesclar, enviar, baixar
Conexões5Gerenciar conexões de API (segredos ocultos)
LLMs7Configurar provedores de IA generativa
Conectores NLU5NLU externo (Dialogflow, LUIS, etc.)
Knowledge AI21Armazenamentos, fontes, blocos, conectores (RAG)
Funções9Funções de código personalizadas, instâncias
Extensões6Enviar, configurar, gerenciar extensões
Perfis de Contato11CRUD de perfis, mesclar, exportar (LGPD)
Analytics4Métricas de conversa, chamada, conhecimento
Auditoria2Logs de eventos de auditoria
Transferência7Provedores e serviços de agente ao vivo
Busca1Busca de recursos em toda a organização
Tarefas2Rastreamento de status de tarefas assíncronas

Principais Recursos

  • Seguro por padrão: Todas as ferramentas de mutação usam dryRun: true por padrão
  • Ciente de assincronia: Operações de longa duração fazem polling até a conclusão
  • Segurança: Chaves de API apenas em memória, segredos ocultos automaticamente
  • Paginação: Todas as operações de listagem suportam limit e skip

Desenvolvimento e Testes

Desenvolvimento com Mock Primeiro

Execute contra o servidor mock Prism (sem necessidade de conta Cognigy):

# Terminal 1: Start mock server
npm run mock

# Terminal 2: Run tests
npm test

Testes com API ao Vivo

# Create .env from template
cp .env.example .env
# Edit .env with your credentials

# Run development server
npm run dev

Build

npm run build    # Compile TypeScript
npm test         # Run test suite (49 tests)
npm run lint     # Check code style

Regenerar Tipos (opcional)

Se você precisar atualizar os tipos gerados a partir de uma API Cognigy mais recente:

npm run update:spec   # Download latest OpenAPI spec
npm run gen:types     # Regenerate TypeScript types

Importante: Dependências

Este pacote requer @cognigy/rest-api-client como dependência de pares (peer dependency). Isso significa:

  1. Você deve instalá-lo separadamente (veja Instalação acima)
  2. Você aceita os termos de licença da Cognigy ao instalar o pacote deles
  3. Não empacotamos nem redistribuímos nenhum código da Cognigy

Você é responsável por:

  • Revisar e aceitar os termos da licença proprietária da Cognigy
  • Ter os direitos apropriados para usar a API Cognigy
  • Manter suas credenciais de API seguras

O cliente da API REST Cognigy é o SDK oficial mantido pela Cognigy GmbH e publicado no npm sob a "Licença Proprietária Cognigy".

Licença

Este servidor MCP é lançado sob a Licença MIT. Veja LICENÇA para detalhes.

Nota: A licença MIT se aplica apenas ao código deste servidor MCP. Dependências (particularmente @cognigy/rest-api-client) estão sujeitas às suas próprias licenças.

Contribuindo

Contribuições são bem-vindas! Por favor:

  1. Faça um fork do repositório
  2. Crie um branch de funcionalidade (git checkout -b feature/amazing-feature)
  3. Siga os padrões de código existentes (esquemas Zod, flags dryRun, etc.)
  4. Adicione testes para novas ferramentas
  5. Execute npm test && npm run build antes de commitar
  6. Envie um Pull Request

Diretrizes de Desenvolvimento

  • Todas as ferramentas devem ter validação de entrada Zod
  • Ferramentas de mutação devem suportar a flag dryRun (padrão: true)
  • Descrições de ferramentas devem ser amigáveis para LLM (1-2 frases)
  • Nunca registre ou exponha chaves/segredos de API
  • Teste contra o servidor mock antes da API ao vivo

Suporte


Construído com o SDK do Model Context Protocol