ISOPlanner MCP 服务器使用说明

项目简介

ISOPlanner MCP 服务器是一个基于 Model Context Protocol (MCP) 标准构建的服务器端应用。它充当 LLM(大型语言模型)客户端与 ISOPlanner 风险管理平台之间的桥梁,使得 LLM 能够通过标准化的 MCP 协议访问 ISOPlanner 的数据资源(如风险信息)并调用其功能(如获取风险列表)。该服务器简化了 LLM 应用与 ISOPlanner 的集成过程,为构建智能风险管理应用提供了基础。

主要功能点

  • 资源管理: 托管和管理 ISOPlanner 的风险相关数据,例如风险列表、风险标签等,并以结构化的资源形式暴露给 LLM 客户端。
  • 工具注册: 注册并提供可供 LLM 客户端调用的工具,例如获取风险列表、获取风险标签列表等,允许 LLM 执行特定的风险管理操作。
  • API 集成: 封装了与 ISOPlanner API 的交互细节,LLM 客户端无需直接处理复杂的 API 调用和认证流程。
  • 标准化接口: 基于 MCP 协议,提供标准化的 JSON-RPC 接口,方便各种 MCP 客户端接入。

安装步骤

  1. 克隆仓库:

    git clone https://github.com/ivarvd-hldng/isoplanner-mcp-server.git
    cd isoplanner-mcp-server
  2. 安装依赖: 确保已安装 Node.js 和 npm。在项目根目录下运行:

    npm install
  3. 配置环境变量: 在项目根目录下创建 '.env' 文件,并根据您的 ISOPlanner API 账户信息配置以下环境变量:

    ISOPLANNER_API_URL=您的_ISOPlanner_API_URL  # ISOPlanner API 的基础 URL,例如 https://api.isoplanner.com
    ISOPLANNER_CLIENT_ID=您的_ISOPlanner_客户端ID  # 您的 ISOPlanner 客户端 ID
    ISOPLANNER_CLIENT_SECRET=您的_ISOPlanner_客户端密钥 # 您的 ISOPlanner 客户端密钥

    请联系 ISOPlanner 管理员获取 'ISOPLANNER_API_URL'、'ISOPLANNER_CLIENT_ID' 和 'ISOPLANNER_CLIENT_SECRET'。

  4. 启动服务器: 在项目根目录下运行以下命令启动 MCP 服务器:

    npm start

    成功启动后,您应该在控制台看到 "MCP Server started successfully" 的信息。

服务器配置 (MCP 客户端配置)

以下 JSON 配置信息用于 MCP 客户端连接到 ISOPlanner MCP 服务器。您需要将此配置提供给您的 MCP 客户端。

{
  "serverName": "isoplanner-mcp",  // MCP 服务器名称,与代码中 server.name 一致
  "command": "node",             // 启动服务器的命令,这里使用 Node.js 运行
  "args": [                       // 启动服务器命令的参数
    "src/index.ts"               // 服务器入口文件路径
  ]
}

请注意: MCP 客户端还需要能够访问到配置的环境变量,或者您需要在服务器启动脚本中预先设置好这些环境变量。更推荐的做法是在运行 MCP 客户端的环境中配置环境变量,确保安全性和灵活性。

基本使用方法

  1. 启动 MCP 服务器: 按照 "启动服务器" 步骤确保 ISOPlanner MCP 服务器已成功运行。
  2. 配置 MCP 客户端: 在您的 MCP 客户端应用中,配置上述提供的服务器配置信息,建立与 ISOPlanner MCP 服务器的连接。
  3. 客户端请求: 通过 MCP 客户端,您可以向 ISOPlanner MCP 服务器发送请求,例如:
    • 访问资源: 请求获取名为 'risks' 的资源,以获取 ISOPlanner 中的风险列表数据。
    • 调用工具: 调用名为 'get_risks' 的工具,执行获取风险列表的操作。
    • 具体请求格式和操作方式请参考您使用的 MCP 客户端的文档。

通过以上步骤,您的 LLM 应用即可借助 ISOPlanner MCP 服务器,便捷地利用 ISOPlanner 平台的风险管理能力。

信息

分类

商业系统