使用说明
项目简介
MCP ITSM Integration 是一个实现了 Model Context Protocol (MCP) 的服务器,旨在为大型语言模型 (LLM) 提供一个统一且标准化的接口,用于与多种 IT 服务管理 (ITSM) 系统进行交互。该项目通过 MCP 协议,将 ServiceNow、Jira、Zendesk 等不同的 ITSM 系统整合起来,为 LLM 应用提供一致的工具集,简化跨系统的数据访问和功能调用。
主要功能点
- 统一的ITSM接口: 为多种主流 ITSM 系统 (ServiceNow, Jira, Zendesk, Ivanti, Cherwell) 提供一致的工具定义,LLM 无需针对不同系统学习不同的 API。
- 工单管理工具: 提供创建、查询、更新、列出、指派和评论工单等核心工单管理功能。
- 知识库搜索: 支持在 ITSM 系统的知识库中搜索相关文章。
- MCP 协议兼容: 完全遵循 Model Context Protocol 规范,保证与 MCP 客户端的兼容性。
- 多种传输协议支持: 支持 HTTP 和 Stdio 传输协议。
- Smithery 集成: 设计上与 Smithery 平台无缝集成,方便部署和管理。
安装步骤
- 克隆仓库: 使用 'git clone https://github.com/madosh/MCP-ITSM.git' 命令克隆代码仓库到本地。
- 安装依赖: 进入项目目录,运行 'npm install' 命令安装项目所需的 Node.js 依赖包。
- 配置 ITSM 凭据: 创建 '.env' 文件,根据仓库提供的 '.env' 示例,配置您要集成的 ServiceNow、Jira、Zendesk 等 ITSM 系统的连接凭据。
- 部署 (可选): 如果需要部署到 Smithery 平台,请参考仓库 README 中的 Smithery 部署说明。
服务器配置
MCP 服务器是为 MCP 客户端设计的后端服务。为了让 MCP 客户端能够连接到此服务器,您需要在 MCP 客户端中配置服务器的启动命令和参数。以下是针对 MCP ITSM 集成服务器的典型配置信息 (JSON 格式):
{ "serverName": "MCP-ITSM Server", "command": "node", "args": ["index.js"] }
配置参数说明:
- 'serverName': 为您的 MCP 服务器配置指定一个名称,可以自定义,例如 "MCP-ITSM Server"。
- 'command': 指定启动 MCP 服务器的命令。由于该服务器是 Node.js 应用,此处应设置为 'node'。
- 'args': 一个字符串数组,用于指定传递给启动命令的参数。对于此服务器,需要指定入口文件 'index.js' 来运行服务器代码。
基本使用方法
- 启动服务器: 在项目根目录下,打开终端并运行命令 'node index.js' 启动 MCP ITSM 服务器。服务器将监听标准输入 (stdio) 或 HTTP 请求(根据具体配置)。
- 使用 MCP 客户端: 配置并启动任何兼容 MCP 协议的客户端,例如 MCP Inspector CLI 工具 或支持 MCP 集成的 LLM 应用 (如 Claude)。
- 客户端与服务器交互: MCP 客户端将根据用户指令或 LLM 的需求,构造符合 MCP 协议的 JSON-RPC 请求发送给 MCP ITSM 服务器。
- 服务器处理请求: MCP ITSM 服务器接收到请求后,将根据请求类型 (例如 'tool_call') 和工具名称,调用相应的 ITSM 系统 API,并处理数据。
- 服务器返回响应: 服务器将处理结果封装成符合 MCP 协议的 JSON-RPC 响应返回给客户端。客户端根据响应内容进行后续操作,例如将工单信息展示给用户或继续与 LLM 进行对话。
注意: 此仓库提供的 'index.js' 文件包含的是 mock 实现的 ITSM 工具,用于演示 MCP 服务器的基本功能。在实际生产环境中使用时,您需要根据自身需求,替换或扩展 'index.js' 中的工具处理逻辑,对接真实的 ITSM 系统 API。
信息
分类
商业系统