OpCon MCP Server Documentation

Welcome to the OpCon MCP Server documentation. This server enables AI agents and applications to interact with the SMA OpCon automation platform through the Model Context Protocol (MCP).

What is OpCon MCP Server?

The OpCon MCP Server is a bridge between AI agents (like Claude) and the SMA OpCon automation platform. It automatically generates MCP tools from the OpCon OpenAPI specification, providing a standardized way for AI to interact with OpCon’s REST API.

Key Features

Getting Started

Prerequisites

Installation

# Clone the repository
git clone https://github.com/markcoleman/OpyConyMcpy.git
cd OpyConyMcpy

# Install dependencies
npm install

# Build the project
npm run build

Basic Configuration

Set the required environment variables:

export OPCON_BASE_URL="https://your-opcon-server:9010"
export OPCON_TOKEN="your-application-token"

For more configuration options, see the Configuration Guide.

Available Tools by Category

The server provides 257 tools organized into the following categories:

For a complete list of all tools with detailed parameter information, see the Tool Reference.

Common Use Cases

Job Monitoring

Monitor job status and execution:

{
  "name": "getApiDailyjobs",
  "arguments": {
    "date": "2024-01-15"
  }
}

Schedule Management

Manage master and daily schedules:

{
  "name": "getApiMasterSchedules",
  "arguments": {
    "Limit": 20
  }
}

Resource Management

Check and manage OpCon resources:

{
  "name": "getApiResources",
  "arguments": {
    "Limit": 50
  }
}

Integration Examples

Claude Desktop

Add to your Claude Desktop configuration:

{
  "mcpServers": {
    "opcon": {
      "command": "node",
      "args": ["/path/to/OpyConyMcpy/dist/index.js"],
      "env": {
        "OPCON_BASE_URL": "https://opcon-server:9010",
        "OPCON_TOKEN": "your-token-here"
      }
    }
  }
}

See the Integration Guide for more details.

Documentation

Development

Running Tests

npm test

Linting

npm run lint
npm run lint:fix

Building

npm run build

Contributing

Contributions are welcome! Please see the Contributing Guide in the main repository.

License

MIT License - see LICENSE for details.

Support

Resources