使用说明

项目简介

Teamtailor MCP Server 是一个基于 Model Context Protocol (MCP) 的服务器,旨在将 Teamtailor API 的功能以标准化的方式提供给 LLM 客户端。通过此服务器,LLM 可以查询和管理 Teamtailor 中的候选人数据。

主要功能点

  • 候选人列表查询: 提供 'teamtailor_list_candidates' 工具,允许根据分页和筛选条件列出 Teamtailor 中的候选人信息。
  • 候选人详情获取: 提供 'teamtailor_get_candidate' 工具,允许通过候选人 ID 获取其详细信息。
  • 标准 MCP 协议: 使用 JSON-RPC over Stdio 作为传输协议,符合 MCP 标准,易于与各种 MCP 客户端集成。

安装步骤

该项目无需额外安装步骤,因为它是一个可以直接通过 'npx' 运行的 Node.js 应用。您只需确保已安装 Node.js 和 npm (或 npx)。

服务器配置

要将 Teamtailor MCP Server 集成到 MCP 客户端(例如 Claude Desktop),您需要配置 MCP 服务器连接信息。以下是一个典型的配置示例,您需要将其添加到您的 MCP 客户端配置中。请务必替换 'YOUR_TEAMTAILOR_API_KEY' 为您实际的 Teamtailor API 密钥。

{
  "mcpServers": {
    "teamtailor": {
      "command": "npx",
      "args": [
        "-y",
        "@crunchloop/mcp-teamtailor"
      ],
      "env": {
        "TEAMTAILOR_URL": "https://api.teamtailor.com/v1",  // Teamtailor API 的基础 URL,通常无需修改
        "TEAMTAILOR_API_KEY": "YOUR_TEAMTAILOR_API_KEY"  // 您的 Teamtailor API 密钥,用于身份验证
      }
    }
  }
}

配置参数说明:

  • 'server name': 'teamtailor' - 服务器的名称,用于在 MCP 客户端中标识和引用。
  • 'command': 'npx' - 用于执行 Node.js 包的命令。
  • 'args': '["-y", "@crunchloop/mcp-teamtailor"]' - 传递给 'npx' 的参数,用于运行 'mcp-teamtailor' 包。'-y' 参数用于自动确认安装包。
  • 'env': 环境变量配置。
    • 'TEAMTAILOR_URL': Teamtailor API 的根 URL。默认值为 'https://api.teamtailor.com/v1',通常不需要更改。
    • 'TEAMTAILOR_API_KEY': 必需。您的 Teamtailor API 密钥,用于服务器向 Teamtailor API 发送请求时进行身份验证。您需要在 Teamtailor 后台获取具有 'Admin' 权限的 API 密钥。

基本使用方法

配置完成后,您的 MCP 客户端应该能够检测到名为 'teamtailor' 的 MCP 服务器。您可以在 LLM 的 Prompt 中通过工具调用的方式使用以下工具:

  • 'teamtailor_list_candidates': 列出候选人。可以接受 'pageSize' (每页数量), 'page' (页码), 和 'filter' (筛选条件,例如 'createdAfter', 'createdBefore', 'updatedAfter', 'updatedBefore') 等参数。
  • 'teamtailor_get_candidate': 获取指定 ID 的候选人详情。需要 'candidateId' 参数(候选人 ID)。

具体工具的使用方法和参数可以在您的 MCP 客户端的界面或文档中查找。

信息

分类

商业系统