Skip to main content

Cognigy AI agent demo builder MCP server

Project description

cognigy-vibe-mcp

A local Python MCP server for building Cognigy AI agent demos with Claude Code. Provides 15 tools covering the full Cognigy REST API surface — node creation, flow inspection, code push with conflict detection, session testing, and a 20-topic reference library.

Part of the cognigy-claude-plugin.

Installation

uvx cognigy-vibe-mcp

Or install permanently:

uv tool install cognigy-vibe-mcp

Quick start

In your demo project directory, run the cognigy:init-mcp skill in Claude Code. It will:

  1. Create ~/.config/cognigy-mcp/<project-id>/ for state and cache
  2. Create a .cognigy-mcp symlink in your project root
  3. Write the MCP server entry to .claude/mcp.json

Then restart Claude Code and call sync_remote_state to populate state from your Cognigy project.

Manual configuration

Add to .claude/mcp.json:

{
  "mcpServers": {
    "cognigy-vibe": {
      "command": "uvx",
      "args": ["cognigy-vibe-mcp"],
      "env": {
        "COGNIGY_BASE_URL": "https://cognigy-api-au1.nicecxone.com",
        "COGNIGY_API_KEY": "<your-api-key>",
        "COGNIGY_PROJECT_ID": "<your-project-id>"
      }
    }
  }
}

Environment variables

Variable Required Default Description
COGNIGY_BASE_URL Yes Cognigy API base URL
COGNIGY_API_KEY Yes API key from Cognigy UI → My Profile → API Keys
COGNIGY_PROJECT_ID No Default project; prompted if omitted
COGNIGY_VIBE_RESYNC_HOURS No 4 Hours of idle before auto-resync
COGNIGY_VIBE_CACHE_TTL No 300 Resource cache TTL in seconds

Tools

State & sync

Tool Description
sync_remote_state Wipe cache and repopulate from Cognigy remote
get_build_state Return name→ID mappings (filterable by resource_type)
resolve_resource Fast name→ID lookup from local state (no API call)

Flow operations

Tool Description
cognigy_get GET any resource, cache-first
cognigy_list List resources; singular/plural resource_type both accepted
cognigy_create POST resource; extension auto-injected, Say config auto-normalised
cognigy_update PATCH with always-fresh GET + optional deep merge
cognigy_delete DELETE any resource including nodes
cognigy_invoke Named operations: move, clone, train, inject, search
get_flow_chart Chart with relations array + readable hierarchy string

File push

Tool Description
push_code_node Push local .js/.ts to a code node with conflict detection
push_html_node Push local .html to a setHTMLAppState node

Testing

Tool Description
talk_to_agent Send a message to a flow via REST endpoint

Guidance

Tool Description
explain 20-topic reference library (see below)

explain topics

Call explain() for an overview. Call explain("topic") for full details.

node-positioning · node-wiring · agent-tool-branch · node-config-update · flow-chart-reading · tool-conditions · two-pass-confirm · turn-structure · xapp-delivery · cognigyScript · code-node-patterns · voice-gateway · outbound-trigger · knowledge-store · endpoint-config · function-execution · session-injection · extension-map · node-types · mcp-comparison

Topics are front-loaded in the tool description — no tool call needed to see what's available.

Key behaviours

  • Extension auto-injectioncognigy_create injects extension for all known node types: @cognigy/voicegateway2 for setSessionConfig/hangup, cognigy-ai-agent for AI agent nodes, cxone-utils for xApp nodes
  • Say node normalisationconfig: { text: "Hello" } is automatically wrapped into the full config.say.text envelope
  • Conflict detectionpush_code_node snapshots the last-pushed content and blocks if the Cognigy UI has been edited since
  • Auto-resync — sessions idle longer than the threshold are silently re-synced before the next tool call
  • Atomic writes — state and cache files use write-to-tmp-then-replace to survive process interrupts

Development

git clone https://github.com/ben-elliot-nice/cognigy-claude-plugin
cd cognigy-claude-plugin/cognigy-mcp
uv sync --extra dev
uv run pytest tests/ -v

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

cognigy_vibe_mcp-1.3.10.tar.gz (85.9 kB view details)

Uploaded Source

Built Distribution

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

cognigy_vibe_mcp-1.3.10-py3-none-any.whl (38.7 kB view details)

Uploaded Python 3

File details

Details for the file cognigy_vibe_mcp-1.3.10.tar.gz.

File metadata

  • Download URL: cognigy_vibe_mcp-1.3.10.tar.gz
  • Upload date:
  • Size: 85.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.21 {"installer":{"name":"uv","version":"0.11.21","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 cognigy_vibe_mcp-1.3.10.tar.gz
Algorithm Hash digest
SHA256 6d665aa9d7de105a302b9d4c4626f076ada85597dbe7471e0a407d0f6957deca
MD5 0b6f12b8e79e2455cb89d409c5ad95ff
BLAKE2b-256 747fea07d6d280b7716da10907580814ba8a760bca090f84452f0e154b19631e

See more details on using hashes here.

File details

Details for the file cognigy_vibe_mcp-1.3.10-py3-none-any.whl.

File metadata

  • Download URL: cognigy_vibe_mcp-1.3.10-py3-none-any.whl
  • Upload date:
  • Size: 38.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.21 {"installer":{"name":"uv","version":"0.11.21","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 cognigy_vibe_mcp-1.3.10-py3-none-any.whl
Algorithm Hash digest
SHA256 6b02fe6dd351dd6b5428070a4dd883569d4ad2268e085a432bbe5805317cdb78
MD5 3fce257cd37fbd75fba54800cc9682cf
BLAKE2b-256 3d0f006f1efd23f5ed4e3f8f1ec9c41863e486d3b7d3d8d556898d26d1312fe7

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