ConnectWise API Gateway MCP Server

ConnectWise API Gateway MCP Server

site icon
2025.03.25 3
PythonAPI 网关ConnectWise 集成开发效率
CWM-API-Gateway-MCP 是一个基于 Model Context Protocol (MCP) 的服务器,为 ConnectWise Manage API 提供了一个全面的接口。它简化了 API 的发现、执行和管理,适用于开发者和 AI 助手。
View on GitHub

Overview

基本能力

产品定位

CWM-API-Gateway-MCP 是一个 API 网关服务器,旨在简化与 ConnectWise Manage API 的交互,提供高效的 API 发现、执行和管理功能。

核心功能

  • API 发现:通过关键词或自然语言搜索和探索 ConnectWise API 端点。
  • 简化的 API 执行:友好的参数处理和自动错误管理。
  • 快速内存系统:保存和检索常用的 API 查询以提高工作效率。
  • 原始 API 访问:完全控制端点、方法和参数的自定义 API 请求。

关键特性

  • 数据库支持的 API 发现:使用从 ConnectWise API 定义 JSON 构建的 SQLite 数据库进行快速、高效的端点查找。
  • 自然语言搜索:使用对话式描述查找相关 API 端点。
  • 分类 API 导航:按功能类别组织的 API 端点浏览。
  • 详细的文档访问:查看 API 端点的全面信息,包括参数、模式和响应格式。
  • 自适应学习:通过使用跟踪学习最有价值的 API 调用。

适用场景

  • 开发者工具:帮助开发者快速发现和执行 ConnectWise API 调用。
  • AI 助手集成:为 AI 助手提供高效的 API 交互接口。
  • 工作流优化:通过快速内存系统保存常用查询,优化工作流程。

工具列表

API 发现工具

  • search_api_endpoints:通过查询字符串搜索 API 端点。
  • natural_language_api_search:使用自然语言描述查找端点。
  • list_api_categories:列出所有可用的 API 类别。
  • get_category_endpoints:列出特定类别中的所有端点。
  • get_api_endpoint_details:获取特定端点的详细信息。

API 执行工具

  • execute_api_call:执行带有路径、方法、参数和数据的 API 调用。
  • send_raw_api_request:以 "METHOD /path [JSON body]" 格式发送原始 API 请求。

快速内存工具

  • save_to_fast_memory:手动将 API 查询保存到快速内存。
  • list_fast_memory:列出快速内存中保存的所有查询。
  • delete_from_fast_memory:从快速内存中删除特定查询。
  • clear_fast_memory:清除快速内存中的所有查询。

常见问题解答

数据库未找到错误

解决方案:运行 build_database.py 脚本生成数据库。

API 认证问题

解决方案:检查环境变量确保所有 ConnectWise 凭据正确。

API 调用超时

解决方案:检查网络连接或为大型数据请求添加更具体的过滤器。

使用教程

使用依赖

  • Python 3.10 或更高版本
  • ConnectWise Manage API 凭据
  • ConnectWise API 定义文件 (manage.json)

安装教程

选项 1:使用 GitHub NPM 包(推荐)

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

选项 2:手动安装

Windows
  1. 克隆仓库:
git clone https://github.com/jasondsmith72/CWM-API-Gateway-MCP.git
cd CWM-API-Gateway-MCP
  1. 安装包:
pip install -e .
macOS
  1. 安装 Python 3.10+:
brew install [email protected]
  1. 克隆仓库并设置虚拟环境:
git clone https://github.com/jasondsmith72/CWM-API-Gateway-MCP.git
cd CWM-API-Gateway-MCP
python3 -m venv venv
source venv/bin/activate
pip install -e .
Linux (Ubuntu/Debian)
  1. 安装 Python 3.10+:
sudo apt update
sudo apt install python3.10 python3.10-venv python3.10-dev python3-pip
  1. 克隆仓库并设置虚拟环境:
git clone https://github.com/jasondsmith72/CWM-API-Gateway-MCP.git
cd CWM-API-Gateway-MCP
python3.10 -m venv venv
source venv/bin/activate
pip install -e .

调试方式

运行服务器测试

# NPM 安装方式
cwm-api-gateway-mcp

# Node.js 脚本方式
node bin/server.js

# Python 脚本方式
python api_gateway_server.py

测试数据库

python test_database.py

许可证

None