ConnectWise API Gateway

You run a ConnectWise API Gateway MCP Server to discover, execute, and manage ConnectWise Manage API endpoints with ease. It streamlines API access, lets you save frequently used queries, and provides both friendly high‑level interactions and raw API control for advanced tasks.

How to use

You interact with the MCP Server through an MCP client to discover endpoints, run API calls, and reuse past queries. Start by selecting an endpoint category or describing what you need, then execute calls with guided parameters. Save useful queries to Fast Memory for quick reuse, and view detailed endpoint information to understand required fields, response formats, and schemas.

How to install

Prerequisites: install Node.js and Python runtimes as needed, and have ConnectWise API credentials ready.

Step 1. Install the MCP package for the gateway (choose one method):

npm install -g jasondsmith72/CWM-API-Gateway-MCP

Step 2. Prepare environment variables with your ConnectWise credentials (these are required to authenticate against the API). Set them in your shell or environment manager.

CONNECTWISE_API_URL=https://na.myconnectwise.net/v4_6_release/apis/3.0
CONNECTWISE_COMPANY_ID=your_company_id
CONNECTWISE_PUBLIC_KEY=your_public_key
CONNECTWISE_PRIVATE_KEY=your_private_key
CONNECTWISE_AUTH_PREFIX=yourprefix+

Step 3. If you installed via npm, run the MCP server from your command line to start serving requests.

cwm-api-gateway-mcp

Configuration and startup options

You can run multiple MCP connection methods. The documented options include an HTTP remote server and local stdio (Node or Python scripts) configurations. The HTTP option connects to the ConnectWise API Gateway URL. The stdio options let you run the gateway locally via different runtimes.

HTTP MCP server configuration (remote) shows the base URL for API access and an empty argument list.

{
  "mcpServers": {
    "cwm_api": {
      "type": "http",
      "url": "https://na.myconnectwise.net/v4_6_release/apis/3.0",
      "args": []
    }
  }
}

STDIO MCP server configurations (local) show commands to run and the environment variables to provide. The following examples cover common options shown for Claude Desktop integration.

{
  "mcpServers": {
    "cwm_api_npm": {
      "type": "stdio",
      "command": "npx",
      "args": ["-y", "@jasondsmith72/CWM-API-Gateway-MCP"],
      "env": {
        "CONNECTWISE_API_URL": "https://na.myconnectwise.net/v4_6_release/apis/3.0",
        "CONNECTWISE_COMPANY_ID": "your_company_id",
        "CONNECTWISE_PUBLIC_KEY": "your_public_key",
        "CONNECTWISE_PRIVATE_KEY": "your_private_key",
        "CONNECTWISE_AUTH_PREFIX": "yourprefix+"
      }
    },
    "cwm_api_node": {
      "type": "stdio",
      "command": "node",
      "args": ["C:/path/to/CWM-API-Gateway-MCP/bin/server.js"],
      "env": {
        "CONNECTWISE_API_URL": "https://na.myconnectwise.net/v4_6_release/apis/3.0",
        "CONNECTWISE_COMPANY_ID": "your_company_id",
        "CONNECTWISE_PUBLIC_KEY": "your_public_key",
        "CONNECTWISE_PRIVATE_KEY": "your_private_key",
        "CONNECTWISE_AUTH_PREFIX": "yourprefix+"
      }
    },
    "cwm_api_py": {
      "type": "stdio",
      "command": "python",
      "args": ["C:/path/to/CWM-API-Gateway-MCP/api_gateway_server.py"],
      "env": {
        "CONNECTWISE_API_URL": "https://na.myconnectwise.net/v4_6_release/apis/3.0",
        "CONNECTWISE_COMPANY_ID": "your_company_id",
        "CONNECTWISE_PUBLIC_KEY": "your_public_key",
        "CONNECTWISE_PRIVATE_KEY": "your_private_key",
        "CONNECTWISE_AUTH_PREFIX": "yourprefix+"
      }
    },
    "cwm_api_py3": {
      "type": "stdio",
      "command": "python3",
      "args": ["/path/to/CWM-API-Gateway-MCP/api_gateway_server.py"],
      "env": {
        "CONNECTWISE_API_URL": "https://na.myconnectwise.net/v4_6_release/apis/3.0",
        "CONNECTWISE_COMPANY_ID": "your_company_id",
        "CONNECTWISE_PUBLIC_KEY": "your_public_key",
        "CONNECTWISE_PRIVATE_KEY": "your_private_key",
        "CONNECTWISE_AUTH_PREFIX": "yourprefix+"
      }
    }
  }
}

Troubleshooting and tips

If you encounter authentication errors, verify that all ConnectWise credentials are correct and that the AUTH_PREFIX matches your integration type. For connectivity issues, check that the API URL is reachable and that network access to ConnectWise is not blocked.

In case the database or fast memory features are not loading as expected, confirm that you have started the server with the correct environment and that any required databases exist at their expected locations.

Notes and examples

The MCP gateway supports both structured API discovery and raw API access, enabling you to explore endpoints by keywords or natural language, and to execute calls with friendly parameter handling. You can store frequently used queries in Fast Memory for quick reuse.

API reference and features

Key features include database-backed API discovery, natural language search, categorized navigation, and adaptive learning from usage to improve recommendations over time.

Available tools

search_api_endpoints

Search for API endpoints by query string

natural_language_api_search

Find endpoints using natural language descriptions

list_api_categories

List all available API categories

get_category_endpoints

List all endpoints in a specific category

get_api_endpoint_details

Get detailed information about a specific endpoint

execute_api_call

Execute an API call with path, method, parameters, and data

send_raw_api_request

Send a raw API request in the format "METHOD /path [JSON body]"

save_to_fast_memory

Manually save an API query to Fast Memory

list_fast_memory

List all queries saved in Fast Memory

delete_from_fast_memory

Delete a specific query from Fast Memory

clear_fast_memory

Clear all queries from Fast Memory