CWM API Gateway MCP

🚀 Connector for ConnectWise Platform

This connector simplifies the integration with the ConnectWise platform, enabling seamless data synchronization and efficient operations.

🚀 Quick Start

Integration Steps

To integrate this connector with the ConnectWise platform, follow these steps:

📦 Installation

• Ensure you have Python 3.x installed.
• Install the required dependencies:

pip install requests jsonschema

⚙️ Environment Variables

Set the following variables in your system environment:

CONNECTWISE_COMPANY_ID=your_company_id
CONNECTWISE_PUBLIC_KEY=your_public_key
CONNECTWISE_PRIVATE_KEY=your_private_key
CONNECTWISE_AUTH_PREFIX=your_auth_prefix

🗄️ Database Configuration

• Make sure the api_gateway.db file exists in the project directory.
• If the file is missing, generate the initial database by running:

python build_database.py

▶️ Service Startup

Start the connector by running the following command in your terminal or command prompt:

python api_gateway.py

🌐 Accessing the Interface

• Open your browser and navigate to http://localhost:8080.
• Log in using your ConnectWise credentials.

✨ Features

🔄 Automated Data Synchronization

• Real-time Updates: The system automatically detects and synchronizes the latest data from ConnectWise.
• Batch Processing: Supports efficient handling of large volumes of data, reducing API calls.
• Error Recovery: Features resume functionality to ensure data transfer integrity.

🧠 Intelligent Query Optimization

• Adaptive Filters: Dynamically adjusts search criteria based on historical query behavior.
• Field Selection: Requests only relevant fields, improving response time and reducing bandwidth usage.
• Result Pagination: Supports efficient handling of large datasets, controlling the amount of returned data via page and pageSize parameters.

🛠️ Quick Troubleshooting

Database Connection Issues

sqlite3.OperationalError: unable to open database file

Solution:

• Ensure the api_gateway.db file is in the correct location.
• Check file permissions to ensure the service has read and write access.

Authentication Failure

Unauthorized Error 401

Solution:

• Verify that all environment variables are correctly set:
  • CONNECTWISE_COMPANY_ID, CONNECTWISE_PUBLIC_KEY, and CONNECTWISE_PRIVATE_KEY.
• Confirm that the API keys have the correct permissions.
• Check that CONNECTWISE_AUTH_PREFIX is a valid prefix.

Connection Timeout

Request timed out

Solution:

• Optimize your network connection to ensure stable internet access.
• Reduce the amount of requested data by using filtering and pagination.
• Perform large data operations during off-peak hours.

🔧 Technical Details

System Requirements

Operating Systems

• Supported Platforms: Linux, Windows, macOS.
• Minimum Version: Python 3.6 or higher.

Hardware Requirements

• Processor: 1 GHz or faster.
• Memory: At least 2 GB RAM.
• Storage: At least 500 MB of available space.

Security Considerations

• Data Encryption: All API requests and responses are encrypted using SSL/TLS.
• Access Control: Restricts access to the management interface via an IP whitelist.
• Logging: Maintains detailed logs of all operations for auditing and troubleshooting.

📚 Documentation Update History

Version 1.0 (January 15, 2023)

• Initial release.

Version 2.0 (June 10, 2023)

• New Features: Intelligent query optimization and resume functionality.
• Bug Fixes: Resolved database connection timeout and authentication failure issues.

📞 Contact Support

For assistance or to report issues, please contact our support team:

• Email: support@connectwise.com
• Phone: +1 (800) 123-4567