Loxo MCP Server 使用说明

项目简介

Loxo MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器,旨在为AI助手提供与Loxo招聘平台进行交互的能力。通过此服务器,AI助手可以执行诸如管理候选人、职位、活动和呼叫队列等招聘相关任务,从而提高招聘效率和自动化水平。

主要功能点

  • 活动管理工具:包括获取活动类型列表、今日任务和计划活动、安排未来活动以及记录活动日志等功能。
  • 呼叫队列管理工具:支持查看当前呼叫队列以及向呼叫队列添加候选人或联系人。
  • 候选人管理工具:提供在Loxo中搜索候选人、获取候选人详细信息以及为候选人添加备注的功能。
  • 职位管理工具:支持在Loxo中搜索职位、获取职位详细信息以及为职位添加备注的功能。
  • 基于 MCP 协议:采用标准的 Model Context Protocol,易于与各种 MCP 客户端集成。
  • 使用 Stdio 传输协议:通过标准输入输出流与客户端通信,简化部署和集成。
  • 类型安全和错误处理:使用 TypeScript 和 Zod 保证代码质量,并提供全面的错误处理机制。

安装步骤

  1. 克隆仓库
    git clone https://github.com/tbensonwest/loxo-mcp-server
    cd loxo-mcp-server
  2. 安装依赖
    npm install
  3. 构建项目
    npm run build

服务器配置

MCP客户端需要配置以下信息以连接到 Loxo MCP Server:

{
  "serverName": "loxo-server",
  "command": "npm",
  "args": ["start"]
  // "command": "node",
  // "args": ["build/index.js"]
}

配置参数说明:

  • 'serverName': 服务器名称,此处为 "loxo-server"。
  • 'command': 启动服务器的命令,通常为 'npm' 或 'node'。
    • 如果使用 'npm start' 启动,则配置为 '"npm"','args' 配置为 '["start"]'。
    • 如果直接运行构建后的 JavaScript 文件,例如 'node build/index.js',则 'command' 配置为 '"node"','args' 配置为 '["build/index.js"]'。
  • 'args': 启动命令的参数,根据 'command' 的不同而配置。

环境变量配置:

在运行服务器之前,需要配置以下环境变量。复制 '.env.example' 文件为 '.env' 并根据您的Loxo平台信息进行修改:

LOXO_API_KEY=your_api_key        # 您的 Loxo API 密钥,必填
LOXO_AGENCY_SLUG=your_agency_slug   # 您的机构在 Loxo 中的 Slug,必填
LOXO_DOMAIN=app.loxo.co           # Loxo 域名,默认为 'app.loxo.co',通常无需修改

请确保在 '.env' 文件中填入正确的 'LOXO_API_KEY' 和 'LOXO_AGENCY_SLUG'。

基本使用方法

  1. 配置环境变量: 根据 “服务器配置” 章节的说明,配置 '.env' 文件。
  2. 启动服务器: 在项目根目录下运行命令 'npm start' 或 'node build/index.js' 启动 Loxo MCP Server。
  3. 配置 MCP 客户端: 在您的 MCP 客户端中,根据 “服务器配置” 章节提供的 JSON 配置信息,配置连接到 Loxo MCP Server。
  4. 使用 AI 助手: 启动 MCP 客户端,您的 AI 助手即可通过 Loxo MCP Server 提供的工具与 Loxo 招聘平台进行交互,执行各种招聘任务。

注意: 启动服务器后,请保持终端运行,直到您停止使用 MCP 服务。

信息

分类

商业系统