项目简介

HaloPSA工作流MCP服务器是一个基于Model Context Protocol (MCP) 构建的应用后端，旨在通过标准化的方式，让AI助手 (如Claude) 能够与HaloPSA工单系统的工作流功能进行交互。该服务器充当AI助手和HaloPSA系统之间的桥梁，允许AI助手安全、可扩展地访问和操作HaloPSA的工作流数据。

主要功能点

工作流数据访问: 提供对HaloPSA工作流的读取能力，包括工作流列表、工作流步骤和单个工作流详情。
工作流管理: 支持AI助手创建、删除HaloPSA中的工作流。
工具集成: 通过预定义的工具 (Tools)，AI助手可以调用服务器提供的特定功能，例如检索指定条件的工作流。
标准化协议: 基于MCP协议和JSON-RPC通信，确保与各种MCP客户端的兼容性。
易于部署: 可以作为独立服务器运行，也可以作为库集成到其他Node.js应用中。

安装步骤

确保已安装Node.js和npm。
克隆或下载仓库代码到本地。

在项目根目录下，运行以下命令安装依赖：

npm install halopsa-workflows-mcp

服务器配置

MCP客户端需要配置以下信息以连接到HaloPSA工作流MCP服务器：

{
  "serverName": "halopsa-workflows",
  "command": "node",
  "args": [
    "dist/halopsa-mcp.js"
  ]
}

配置参数说明:

'serverName': 服务器名称，此处固定为 "halopsa-workflows"。
'command': 启动MCP服务器的命令，通常为 "node"。
'args': 启动命令的参数，指定服务器入口文件路径，此处指向编译后的 'dist/halopsa-mcp.js' 文件。

注意: MCP服务器的HaloPSA API 凭据 (HALOPSA_BASE_URL, HALOPSA_TENANT, HALOPSA_CLIENT_ID, HALOPSA_CLIENT_SECRET) 需要在服务器端配置，通常通过 '.env' 文件设置。MCP客户端无需配置这些信息。

基本使用方法

1. 配置HaloPSA API 凭据 (服务器端)

在服务器端项目根目录下创建 '.env' 文件，并根据您的HaloPSA实例信息配置以下环境变量：

HALOPSA_BASE_URL=https://your-instance.halopsa.com
HALOPSA_TENANT=your-tenant
HALOPSA_CLIENT_ID=your-client-id
HALOPSA_CLIENT_SECRET=your-client-secret
HALOPSA_SCOPE=all

2. 启动MCP服务器

作为独立服务器运行:

在服务器端项目根目录下，运行以下命令启动服务器：

npm start

作为库集成:

如果您想将MCP服务器作为库集成到现有的Node.js应用中，可以使用以下代码：

import { createMcpServer } from 'halopsa-workflows-mcp';

const server = createMcpServer();
server.start();

3. MCP客户端连接

配置您的MCP客户端，使用上述 服务器配置 信息连接到正在运行的HaloPSA工作流MCP服务器。客户端可以通过标准输入/输出 (stdio) 与服务器进行JSON-RPC通信，调用服务器提供的工具来管理HaloPSA工作流。

例如，客户端可以调用 'getWorkflows' 工具来获取工作流列表，或调用 'createWorkflows' 工具来创建新的工作流。详细的工具列表和参数信息请参考服务器代码或MCP协议文档。

关键词