loxo-mcp-server

🚀 Loxo MCP 服务器

Loxo MCP 服务器是一个模型上下文协议（MCP）服务器，它提供了与 Loxo 招聘平台 API 交互的工具。借助该服务器，AI 助手能够执行各类招聘相关任务，如管理候选人、工作机会、活动以及电话队列等。

🚀 快速开始

安装

# 克隆仓库
git clone [repository-url]
cd loxo-mcp-server

# 安装依赖
npm install

# 构建项目
npm run build

配置

复制提供的 .env.example 文件并重命名为 .env，然后填写值：

cp .env.example .env

接着更新 .env 文件中的配置：

LOXO_API_KEY=your_api_key
LOXO_AGENCY_SLUG=your_agency_slug
LOXO_DOMAIN=app.loxo.co

所需的环境变量：

• LOXO_API_KEY：你的 Loxo API 密钥
• LOXO_AGENCY_SLUG：你在 Loxo 中的机构标识符
• LOXO_DOMAIN：（可选）默认为 'app.loxo.co'

开发

# 在开发模式下运行，带有监控功能
npm run dev

# 构建项目
npm run build

# 启动服务器
npm start

✨ 主要特性

• 丰富的工具集：提供活动管理、电话队列管理、候选人管理和工作机会管理等多种工具。
• 类型安全：使用 Zod 进行运行时类型验证，确保环境变量、工具输入参数和 API 响应的类型安全。
• 全面的错误处理：包含环境变量验证、API 请求失败、无效工具参数和未知工具请求等全面的错误处理功能。
• 良好的架构设计：使用 Model Context Protocol SDK 构建，通过 stdio 进行通信，便于与 AI 助手无缝集成，采用 TypeScript 实现类型安全和更好的开发体验，并实现与 Loxo 平台的 RESTful API 调用。

📦 安装指南

克隆仓库

git clone [repository-url]
cd loxo-mcp-server

安装依赖

npm install

构建项目

npm run build

💻 使用示例

基础用法

以下是一些常用工具的使用示例：

活动管理

• 获取所有可用活动类型

# 执行命令获取所有可用活动类型
get-activity-types

• 获取今天的所有任务和计划活动

# 执行命令获取今天的所有任务和计划活动
get-todays-tasks

电话队列管理

• 查看当前的电话队列

# 执行命令查看当前的电话队列
get-call-queue

候选人管理

• 在 Loxo 中搜索候选人

# 执行命令在 Loxo 中搜索候选人
search-candidates

工作机会管理

• 在 Loxo 中搜索工作机会

# 执行命令在 Loxo 中搜索工作机会
search-jobs

高级用法

安排未来的活动

# 执行命令安排未来的活动（电话、会议等）
schedule-activity

向候选人添加备注

# 执行命令向候选人添加备注
add-note

🔧 技术细节

• 类型安全：该服务器使用 Zod 进行运行时类型验证，涵盖环境变量、工具输入参数和 API 响应，确保程序在运行时的类型正确性。
• 错误处理：服务器具备全面的错误处理功能，包括环境变量验证、API 请求失败、无效工具参数和未知工具请求等情况的处理，提高了系统的稳定性和健壮性。
• 架构设计：使用 Model Context Protocol SDK 构建，通过 stdio 进行通信，实现了与 AI 助手的无缝集成。采用 TypeScript 编写，提供了类型安全和更好的开发体验，同时实现了与 Loxo 平台的 RESTful API 调用。