README
🚀 ConnectWise 管理 MCP 服务器
这是一个提供与 ConnectWise Manage API 集成的模型上下文协议 (Model Context Protocol) 服务器。它允许 Claude 通过 ConnectWise Manage API 执行操作,如检索票证、公司、联系人等,为相关业务操作提供了便利。
🚀 快速开始
此 MCP 服务器可让您借助 ConnectWise Manage API 进行一系列操作。下面将为您介绍安装、配置及使用方法。
✨ 主要特性
- 🔑 使用 API 密钥进行身份验证,保障系统安全。
- 🔍 支持检索票证、公司、联系人和其他实体,满足多样化的数据获取需求。
- ✍️ 能够创建、更新和删除实体,实现对数据的灵活管理。
- 📄 提供查询过滤和分页支持,方便数据筛选与浏览。
📦 安装指南
使用 NPM
npm install -g connectwise-mcp-server
手动设置
- 克隆此仓库。
- 安装依赖项:
npm install。 - 构建项目:
npm run build。 - 启动服务器:
npm start。
📚 详细文档
配置
要使用此 MCP 服务器,您需要提供 ConnectWise Manage API 凭据:
- 公司 ID
- 公共密钥
- 私有密钥
- ConnectWise 管理 URL(例如 api-na.myconnectwise.net)
Claude 桌面配置
将以下内容添加到您的 Claude 桌面配置文件中(通常位于 ~/Library/Application Support/Claude/claude_desktop_config.json,macOS):
{
"mcpServers": {
"connectwise": {
"command": "npx",
"args": ["-y", "connectwise-mcp-server"],
"env": {
"CW_COMPANY_ID": "your_company_id",
"CW_PUBLIC_KEY": "your_public_key",
"CW_PRIVATE_KEY": "your_private_key",
"CW_URL": "api-na.myconnectwise.net"
},
"options": {
"autoStart": true,
"logLevel": "info"
}
}
}
}
可用功能
💻 使用示例
基础用法
以下是一些基础功能的使用示例:
# 搜索票证
cw_search_tickets(conditions, page_size, page)
# 获取票证
cw_get_ticket(ticket_id)
# 创建票证
cw_create_ticket(summary, description, board_id, company_id)
# 搜索公司
cw_search_companies(conditions, page_size, page)
# 获取公司
cw_get_company(company_id)
📄 许可证
本项目采用 MIT 许可证。
Scan to contact