CCTV VMS MCP

🚀 MCP Server - VMS Integration

An MCP (Model Context Protocol) server that connects to a CCTV recording program (VMS) to retrieve recorded and live video streams. It also provides tools to control VMS software, such as displaying live or playback dialogs for specific channels.

🚀 Quick Start

This MCP server is designed to connect with VMS for video stream retrieval and control. Follow the steps in the "Installation" section to set it up and start using its features.

✨ Features

• Retrieve video channel information, including connection and recording status.
• Get the recording dates and times for specific channels.
• Obtain live or recorded images from video channels.
• Display live video streams or playback dialogs for specific channels and timestamps.
• Control PTZ (pan-tilt-zoom) cameras to move to preset positions.
• Comprehensive error handling and logging.

📦 Installation

Prerequisites

• Python version 3.12+
• vmspy library (for VMS integration)
• Pillow library (for image processing)

Installation Steps

1. Install the UV Package Manager

Run the following command in PowerShell to install UV:

powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

For other installation methods, refer to the official UV documentation.

2. Install the VMS Server

Download and install the VMS server: http://surveillance-logic.com/en/download.html (Required before using this MCP server)

3. Install Python Dependencies

Download the vmspy library: vmspy1.3-python3.12-x64.zip Extract the contents to your mcp_vms directory.

The mcp-vms directory structure should be as follows:

mcp-vms/
├── .gitignore
├── .python-version
├── LICENSE
├── README.md
├── pyproject.toml
├── uv.lock
├── mcp_vms.py            # Main file for server implementation
├── mcp_vms_config.py     # VMS connection configuration
├── vmspy.pyd             # VMS Python library
├── avcodec-61.dll        # FFmpeg library
├── avutil-59.dll
├── swresample-5.dll
├── swscale-8.dll

📚 Documentation

MCP Server Configuration

If you want to use mcp-vms in Claude Desktop, you need to set up the claude_desktop_config.json file as follows:

{
  "mcpServers": {
    "vms": {
      "command": "uv",
      "args": [
        "--directory",
        "X:\\path\\to\\mcp-vms",
        "run",
        "mcp_vms.py"
      ]
    }
  }
}

VMS Connection Configuration

The server uses the following default configuration to connect to the VMS:

• mcp_vms_config.py

vms_config = {
    'img_width': 320,
    'img_height': 240,
    'pixel_format': 'RGB',
    'url': '127.0.0.1',
    'port': 3300,
    'access_id': 'admin',
    'access_pw': 'admin',
}