ConnectWise Manage MCP Server: Unified Access to Data Sources and Tools

Overview: What is ConnectWise Manage MCP Server?

The ConnectWise Manage MCP (Model Context Protocol) Server is a specialized infrastructure designed to facilitate seamless integration between AI applications, such as Claude Desktop, Continue, Cursor, and other tools, with the ConnectWise Manage API. This server leverages Model Context Protocol to provide a standardized way for AI applications to access data from various sources within ConnectWise Manage through RESTful APIs.

🔧 Core Features & MCP Capabilities

The ConnectWise Manage MCP Server is built around several core features that enhance its interoperability and flexibility:

1. Context Management: It supports the creation, connection, retrieval of system information, companies, tickets, and execution of custom commands using Model Context Protocol.
2. Bridge Between AI Applications and APIs: The server acts as a bridge, converting API calls from AI applications into ConnectWise Manage PowerShell commands and vice versa.
3. Multi-Protocol Support: It uses Node.js and the ConnectWiseManageAPI PowerShell module to ensure compatibility with various AI clients and tools.

Detailed MCP Capabilities

• Context Creation: POST /context endpoints for initializing a context, returning a unique contextId.
• Connecting to ConnectWise Manage: POST /context/:contextId/connect for establishing connections using provided or default credentials.
• System Information Retrieval: POST /context/:contextId/getSystemInfo to retrieve system details.
• Company and Ticket Fetching: Flexible endpoints like GET Companies, GET Tickets with optional conditions.
• Custom Command Execution: Executing complex tasks using /context/:contextId/executeCommand.

⚙️ MCP Architecture & Protocol Implementation

The architecture of the ConnectWise Manage MCP Server is designed around a robust and extensible framework. Key components include:

1. server.js: The Express.js server that exposes API endpoints following Model Context Protocol.
2. powershell-bridge.js: A bridge for translating JSON requests to PowerShell commands.
3. fetch-module.ps1: Script for integrating the ConnectWiseManageAPI module into the server environment.

Protocol Flow Diagram

graph TD
    A[AI Application] -->|MCP Client| B[MCP Protocol]
    B --> C[MCP Server]
    C --> D[Data Source/Tool]
    style A fill:#e1f5fe
    style C fill:#f3e5f5
    style D fill:#e8f5e8

Data Architecture Diagram

graph TD
    A[MCP Server] --> B[Context] 
    B -->|POST /context| C[New Context]
    C -->|Status "created"| D[Context ID]
    D -->|POST /context/:contextId/connect| E[Connected to API]
    E --> F[System Info Requested]
    F -->|GET /context/:contextId/getSystemInfo| G[System Info Retrieved]
    G --> H[Company Data Retrieval]
    H -->|POST /context/:contextId/getCompanies| I[Companies Returned with Conditions]
    I --> J[Ticket Data Retrieval]
    J -->|POST /context/:contextId/getTickets| K[Tickets Returned with Conditions]
    K --> L[Custom Command Execution]
    L -->|POST /context/:contextId/executeCommand| M[Command Executed]
    M --> N[Data Returned or Action Perfomed]

🚀 Getting Started with Installation

Prerequisites

1. Node.js (v14 or higher)
2. PowerShell 5.1 or higher
3. ConnectWiseManageAPI PowerShell module (installation options below)
4. ConnectWise Manage API credentials

Step-by-Step Installation

1. Clone the Repository

   git clone https://github.com/jasondsmith72/CWM-MCP.git cd CWM-MCP
   

2. Install Node.js Dependencies

   npm install
   

3. Install ConnectWiseManageAPI PowerShell Module

   • Option 1 (Recommended): Bundle the module with the MCP server

     .\install-module.ps1 -Bundle
     

   • Option 2: Install from PowerShell Gallery

     # Run as Administrator 
     Install-Module 'ConnectWiseManageAPI'
     

   • Option 3: Local Installation via Git

     .\install-module.ps1 -Local
     

4. Configure Environment Variables

   Copy .env.example to .env and edit the values:

   PORT=3000 CWM_SERVER=your-cwm-server CWM_COMPANY=your-company CWM_PUBKEY=your-public-key CWM_PRIVATEKEY=your-private-key CWM_CLIENTID=your-client-id
   

5. Start the Server

   npm start 
   

   Or run the included batch file:

   start-server.bat
   

6. Integrate with Claude Desktop (Manual Post-Installation Step)

   Copy claude_desktop_config.json to your configuration directory:

   # Windows (default location) 
   C:\Users\<YourUsername>\AppData\Roaming\Claude\claude_desktop_config.json
   

   The file contains:

   {
     "mcpServers": [
       {
         "name": "ConnectWise Manage MCP",
         "description": "MCP server for ConnectWise Manage API integration",
         "proxyUrl": "http://localhost:3000"
       }
     ]
   }
   

💡 Key Use Cases in AI Workflows

The ConnectWise Manage MCP Server empowers developers to create seamless integrations between AI applications and ConnectWise Manage. Here are two realistic use cases:

1. Automated Ticket Creation and Resolution:

   • Scenario: A developer wants to integrate an AI-enabled customer support tool with ConnectWise Manage.
   • Implementation:

     {
       "command": "New-CWMTicket",
       "params": { "Title": "New Support Request", "Description": "Customer has issue with software" }
     }
     

   This command creates a new ticket in ConnectWise Manage whenever the AI application identifies a support request.

2. Real-Time Data Sync and Reporting:

   • Scenario: An administrator needs to automate data synchronization between an external CRM tool and ConnectWise Manage.
   • Implementation:

     {
       "command": "Get-CWMCompany",
       "params": { "Conditions": "name like '%Sales%'"}
     }
     

   This command retrieves all sales-related companies for batch processing.

🔌 Integration with MCP Clients

The ConnectWise Manage MCP Server is compatible with various AI clients and tools:

• Claude Desktop: Full Support
• Continue: Full Support
• Cursor: Tools Only

📊 Performance & Compatibility Matrix

Tool	Data Source/Tool	Prompts	Status
Claude Desktop	✅	✅	Full
Continue	✅	✅	Full
Cursor	❌	✅	Tools

🛠️ Advanced Configuration & Security

• Environment Variables: Edit .env to set values like PORT, CWM_SERVER, CWM_COMPANY, etc.
• Security Best Practices: Ensure proper environment variables are not exposed in source control and use secure storage methods.

❓ Frequently Asked Questions (FAQ)

1. Q: How do I install the ConnectWiseManageAPI PowerShell module?
   • A: You can bundle it with the server using .\install-module.ps1 -Bundle or install it globally via PowerShell Gallery as an Administrator.
2. Q: What is Model Context Protocol (MCP)?
   • A: MCP is a universal adapter protocol for AI applications, enabling standardized access to data sources and tools through RESTful APIs.
3. Q: Can I configure multiple ConnectWise Manage contexts?
   • A: Yes, by managing multiple context IDs via the mcpServers configuration in your custom JSON files.
4. Q: How do I troubleshoot issues with the module installation?
   • A: Run the bundled installation script .\\install-module.ps1 -Bundle, ensure the module is correctly downloaded, or use administrator privileges for the global installation method.
5. Q: Does this server support all types of ConnectWise Manage connections?
   • A: Yes, it supports various connections including companies, tickets, and custom command executions.

👨‍💻 Development & Contribution Guidelines

• Development Environment: Use Node.js v14 or higher, PowerShell 5.1 or later.
• Contributions: Fork the repository, create a new branch, commit changes, push to the branch, and submit a pull request.

🌐 MCP Ecosystem & Resources

• ConnectWise Manage API Documentation: Detailed documentation for working with ConnectWise API.
• Model Context Protocol (MCP) Specification: Official document outlining the protocol features and best practices.

---

With this comprehensive documentation, developers can effectively leverage the ConnectWise Manage MCP Server to integrate AI applications with ConnectWise Manage through a standardized Model Context Protocol.