README
🚀 ConnectWise 管理 MCP 服务器
ConnectWise 管理 MCP 服务器是一个模型上下文协议(Model Context Protocol)服务器,它提供了与 ConnectWise Manage API 的集成能力。借助该服务器,Claude 可以与 ConnectWise Manage 进行交互,实现诸如检索票证、公司、联系人等操作,为用户提供便捷的信息获取与管理体验。
🚀 快速开始
ConnectWise 管理 MCP 服务器允许 Claude 与 ConnectWise Manage 进行交互,您可以按照以下步骤进行安装和配置,以使用该服务器提供的功能。
✨ 主要特性
- 身份验证:使用 API 密钥与 ConnectWise Manage API 进行身份验证,确保数据交互的安全性。
- 实体检索:支持检索票证、公司、联系人和其他实体,方便用户获取所需信息。
- 实体操作:具备创建、更新和删除实体的能力,满足多样化的业务需求。
- 查询功能:查询支持筛选和分页,提高信息检索的效率。
📦 安装指南
使用 NPM
使用以下命令全局安装 connectwise-mcp-server:
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"
}
}
}
}
💻 使用示例
基础用法
搜索票证
在 ConnectWise 管理中搜索服务票证。
cw_search_tickets(conditions, page_size, page)
获取票证
检索特定服务票证的详细信息,通过 ID。
cw_get_ticket(ticket_id)
创建票证
创建新的服务票证。
cw_create_ticket(summary, description, board_id, company_id)
搜索公司
在 ConnectWise 管理中搜索公司。
cw_search_companies(conditions, page_size, page)
获取公司
检索特定公司的详细信息,通过 ID。
cw_get_company(company_id)
📄 许可证
本项目采用 MIT 许可证。
微信扫一扫