项目简介

TiFlux MCP 服务器是一个基于 Model Context Protocol (MCP) 构建的后端服务，旨在将 TiFlux 平台的票据、客户和内部沟通功能无缝集成到各种 AI 客户端（如 Claude Code）中。它提供了一套标准化的工具，让大型语言模型 (LLM) 能够安全、高效地访问和操作 TiFlux 系统中的关键业务数据。

主要功能点

• 票据管理：支持获取、创建、更新、关闭和列出工单，提供详细的过滤选项，帮助 LLM 处理客户请求。
• 内部沟通：可以创建和列出工单的内部沟通记录，包括支持添加文件附件，促进团队协作。
• 客户查询：根据客户名称进行搜索，并自动解析客户信息，方便 LLM 识别和关联客户。
• 文件上传：允许向内部沟通添加最多10个文件，每个文件最大25MB，支持多媒体内容的交流。
• API 集成：直接与 TiFlux API v2 深度集成，确保所有操作和数据访问的实时性和准确性。
• 安全配置：通过环境变量管理 API 凭据和默认参数，保证敏感信息的安全，并支持灵活的环境配置。

安装步骤

要安装 TiFlux MCP 服务器，您需要确保系统已安装 Node.js (版本 >= 16.0.0)。然后，可以通过 npm 全局安装该软件包：

npm install -g @tiflux/mcp

服务器配置

在启动 MCP 服务器之前，您需要配置 TiFlux API 凭据和一些默认值。请在您的项目根目录创建一个名为 '.env' 的文件，并添加以下内容（请将 '您的_TiFlux_API_密钥' 替换为您的实际 API 密钥，并将默认值调整为您 TiFlux 平台上的对应 ID）：

# TiFlux API 密钥，从 TiFlux 平台获取，用于认证和访问 TiFlux API。
TIFLUX_API_KEY=您的_TiFlux_API_密钥

# 创建新票据时使用的默认客户端 ID（可选）。如果 LLM 未在请求中提供客户端 ID，将使用此值。
TIFLUX_DEFAULT_CLIENT_ID=1

# 创建新票据时使用的默认服务台 ID（可选）。如果 LLM 未在请求中提供服务台 ID，将使用此值。
TIFLUX_DEFAULT_DESK_ID=1

# 创建新票据时使用的默认优先级 ID（可选）。如果 LLM 未在请求中提供优先级 ID，将使用此值。
TIFLUX_DEFAULT_PRIORITY_ID=1

# 创建新票据时使用的默认服务目录项 ID（可选）。如果 LLM 未在请求中提供服务目录项 ID，将使用此值。
TIFLUX_DEFAULT_CATALOG_ITEM_ID=1

这些配置将允许 MCP 服务器正确连接到 TiFlux API 并处理 LLM 客户端的请求。

基本使用方法

安装并配置好 '.env' 文件后，您可以直接通过命令行启动 TiFlux MCP 服务器：

npx @tiflux/mcp@latest

对于集成到 Claude Code 或其他支持 MCP 协议的 AI 客户端，您需要在客户端的 MCP 配置中添加以下 JSON 片段。这会告诉您的 AI 客户端如何启动和连接到 TiFlux MCP 服务器：

{
  "tiflux": {
    "command": "npx",
    "args": ["@tiflux/mcp@latest"],
    "description": "TiFlux MCP Server，提供票据、客户和内部沟通管理工具。"
  }
}

配置完成后，您的 AI 客户端将能够发现并调用 TiFlux MCP 服务器提供的各种工具，例如获取票据详情、创建新票据、搜索客户或添加内部沟通。