项目简介

freshservice_mcp 是一个基于 Model Context Protocol (MCP) 构建的应用后端,旨在无缝集成大型语言模型(如 Claude)与 Freshservice IT 服务管理平台。通过此服务器,AI 模型可以调用 Freshservice 的 API,执行创建、更新、查询工单,管理用户、资产等一系列操作,从而自动化 IT 服务流程,提高效率。

主要功能

该MCP服务器提供了与 Freshservice 多个模块交互的能力,包括但不限于:

  • 工单管理 (Tickets & Conversations): 创建、更新、删除、查询工单;获取工单详情、留言和回复;发送工单回复和内部笔记。
  • 资源管理 (Products & Service Items): 获取产品列表、按ID查询产品;创建和更新产品;列出服务目录项;获取服务请求的条目;创建服务请求。
  • 用户管理 (Requesters & Agents): 创建、获取所有或按ID查询用户/代理;更新用户/代理信息;列出用户/代理字段;过滤用户/代理。
  • 分组管理 (Agent Groups & Requester Groups): 获取所有或按ID查询代理组/用户组;创建和更新组;列出用户组成员;添加用户到用户组。
  • 知识库管理 (Solution Categories, Folders & Articles): 获取所有或按ID查询知识库分类/文件夹/文章;创建和更新知识库分类/文件夹/文章;发布知识库文章;获取文件夹下的文章列表。
  • 其他: 获取所有工作空间;获取 Canned Responses (预设回复) 及文件夹。

服务器将这些能力通过标准化的 MCP 工具接口暴露给 LLM 客户端。

安装

  1. 先决条件:

    • 拥有一个 Freshservice 账号及有效的 API Key。您可以在 Freshservice 管理面板的 Profile Settings → API Settings 中找到并生成 API Key。
    • 已安装 Python 运行环境。
    • 推荐安装 'uvx',一个用于执行 Python 包中脚本的工具。如果尚未安装,可以通过 pip 或 brew 安装:
      pip install uv
      # 或使用 brew
      brew install uv
  2. 安装服务器: 使用 pip 安装 freshservice_mcp 包:

    pip install freshservice-mcp

配置

freshservice_mcp 服务器需要您的 Freshservice 域名和 API Key 才能工作。这些信息通常通过环境变量提供给服务器进程。

在使用支持 MCP 的 LLM 客户端(如 Claude Desktop)时,您需要在客户端的配置中指定如何启动 freshservice_mcp 服务器,并传递必要的环境变量。以下是一个 Claude Desktop 配置的示例片段:

"mcpServers": {
  "freshservice-mcp": {
    "command": "uvx", // 启动服务器的命令
    "args": [
        "freshservice-mcp" // 命令的参数,这里指代安装的 freshservice-mcp 可执行脚本
    ],
    "env": {
      "FRESHSERVICE_API_KEY": "<YOUR_FRESHSERVICE_API_KEY>", // 您的 Freshservice API Key (替换为您实际的 Key)
      "FRESHSERVICE_DOMAIN": "<YOUR_FRESHSERVICE_DOMAIN>"   // 您的 Freshservice 域名 (替换为您实际的域名,例如 yourcompany.freshservice.com)
    }
  }
}

请将上述示例中的占位符 '<YOUR_FRESHSERVICE_API_KEY>' 和 '<YOUR_FRESHSERVICE_DOMAIN>' 替换为您实际的 Freshservice API Key 和域名。具体的配置步骤和文件位置可能因 LLM 客户端不同而异,请参考您所使用客户端的 MCP 集成文档。

使用示例

配置完成后,您可以通过与集成了此 MCP 服务器的 LLM 客户端进行自然语言交互来使用 Freshservice 功能。例如,您可以向 AI 提出请求:

  • “在 Freshservice 中创建一个主题为‘市场部网络连接问题’的紧急工单。” (AI 将调用 'create_ticket' 工具)
  • “查询所有状态为‘开放’的高优先级工单。” (AI 将调用 'filter_tickets' 工具)
  • “查找 ID 为 12345 的用户的详细信息。” (AI 将调用 'get_requester_id' 或 'get_agent' 工具)
  • “获取知识库分类‘常见问题’下的所有文章。” (AI 将调用 'get_list_of_solution_folder' 和 'get_list_of_solution_article' 等工具组合完成)

AI 会根据您的请求,自动识别并调用相应的 Freshservice MCP 工具来执行操作或获取信息。

信息

分类

商业系统