EPICS MCP Server

🚀 EPICS-MCP-Server

The EPICS-MCP-Server is a Python-based server designed to interact with EPICS (Experimental Physics and Industrial Control System) Process Variables (PVs), offering tools for PV value operations and information retrieval.

🚀 Quick Start

To use the EPICS MCP Server with Langchain, you must install the project dependencies:

pip install -r requirements.txt

Langchain

server_params = StdioServerParameters(
    command="python",
    # Make sure to update the full absolute path of the math_server.py file here
    args=["/path/server.py"],
)

EPICS

Before using the EPICS MCP Server, you must successfully install EPICS on your local machine, ensure that the IOC can start normally, and verify the proper functioning of features like caget, caput, and cainfo. For detailed installation instructions, refer to https://epics-controls.org/resources-and-support/base/.

jiangyan@DESKTOP-84CO9VB:~$ softIoc -d ~/EPICS/DB/test.db
Starting iocInit
############################################################################
## EPICS R7.0.8
## Rev. 2025-02-13T14:29+08:00
############################################################################

... Startup logs ...

jiangyan@DESKTOP-84CO9VB:~$ caget temperature.readback.value
88.0

✨ Features

The EPICS MCP Server provides the following tools:

1. get_pv_value

   • Create or update a single file.
   • Input:
     • pv_name (string): The name of the PV variable.
   • Return: A JSON object containing the status (success or error) and the retrieved value or error message.

2. set_pv_value

   • Set a new value for the specified PV.
   • Input:
     • pv_name (string): The name of the PV variable.
     • pv_value (string): The new PV value to be set.
   • Return: A JSON object containing the status (success or error) and a confirmation message or error message.

3. get_pv_info

   • Retrieve detailed information about the specified PV.
   • Input:
     • pv_name (string): The name of the PV variable.
   • Return: A JSON object containing the status (success or error) and detailed PV information or an error message.

💻 Usage Examples

Basic Usage

Here is a test result example:

{
  "pv_name": "temperature.readback.value",
  "pv_value": 88.0,
  "timestamp": "2025-02-13T14:29:00"
}

Advanced Usage

The following is a complete test log:

# Test Log

## Step 1: Start the IOC
jiangyan@DESKTOP-84CO9VB:~$ softIoc -d ~/EPICS/DB/test.db
Starting iocInit
############################################################################
## EPICS R7.0.8
## Rev. 2025-02-13T14:29+08:00
############################################################################

... Startup logs ...

## Step 2: Connect to the PV
jiangyan@DESKTOP-84CO9VB:~$ caget temperature.readback.value
88.0

## Step 3: Set the PV Value
jiangyan@DESKTOP-84CO9VB:~$ caput temperature.setpoint.value 100
Write access allowed by default.
No security callback
old value = 88.0
new value = 100.0

## Step 4: Get PV Information
jiangyan@DESKTOP-84CO9VB:~$ cainfo temperature.readback.value
{
  "pv_name": "temperature.readback.value",
  "description": "Temperature Readback Value",
  "type": "double",
  "value": 100.0,
  "alarm Severety": "NO_ALARM",
  "timeStamp": "2025-02-13T14:29:00"
}