使用说明(简明易懂,便于快速上手)

  • 项目简介

    • 该仓库实现了一个基于 FastMCP 的 MCP 服务器,目标是向 LLM 客户端提供结构化的资源、工具和能力。通过按需加载工具集,服务器能够覆盖 CATS API v3 的大量端点(总计约164工具),并支持 STDIO 与 HTTP 两种传输模式,方便本地开发、云端部署及远程集成。
  • 主要功能点

    • 动态工具集加载:默认工具集包含候选人、职位、流程等核心功能,另外还有招聘相关、数据配置等工具集,计164个工具,可按需加载。
    • 工具注册与执行:通过工具装饰器注册工具,LLM 可远程调用工具执行对接的 CATS API。
    • 多传输协议支持:STDIO(适用于 Claude Desktop 等本地桌面工具)和 HTTP(适用于 web 应用与云端服务)。
    • 健康与状态探测:提供健康检查接口,便于监控与部署编排。
    • 资源与权限抽象:统一通过工具集对 CATS API 进行资源操作,简化对外调用。
    • 安全性考虑:通过 CATS API Key 进行鉴权(需要在环境变量或 .env 文件中配置),并在请求中携带 Authorization 头。
  • 安装步骤

      1. 安装依赖
      • python 环境
      • pip install fastmcp httpx python-dotenv
      1. 配置环境
      • 将 CATS_API_BASE_URL 设置为 CATS API v3 的基地址,例如 https://api.catsone.com/v3
      • 设置 CATS_API_KEY 为你的 CATS API v3 Key
      • 可选:设置 CATS_TOOLSETS 指定默认加载的工具集,例如 candidates,jobs,companies
      1. 启动服务器
      • 本仓库提供两种启动方式:
        • 通过命令行启动(STDIO 模式,适用于 Claude Desktop 等工具)
          • python server.py
          • 或查看工具集列表:python server.py --list-toolsets
          • 指定工具集:python server.py --toolsets candidates,jobs
          • 加载全部工具:python server.py --toolsets all
        • 通过 HTTP 传输启动服务(若需要对外访问)
          • 设置 CATS_TRANSPORT=http
          • 运行前确保 CATS_PORT、CATS_HOST 配置正确
          • 运行:python server.py
      1. 服务器配置(MCP 客户端使用,不需要服务器端代码查看,以下为示例 JSON 配置说明) 说明:MCP 客户端(如 Claude)需要一个 JSON 配置来连接该 MCP 服务器。下面是可用于配置的示例字段与含义,实际值请按你的环境替换: { "server_name": "CATS API v3 MCP Server", "command": "python", "args": ["server.py"], "environment": { "CATS_API_BASE_URL": "https://api.catsone.com/v3", "CATS_API_KEY": "your_cats_api_key", "CATS_TOOLSETS": "candidates,jobs,companies" // 可选,若未设置则以服务器默认加载为准 } // 为了安全性,生产环境通常不将密钥写死在配置中,请以环境变量方式注入 }
      1. 基本使用方法
      • 启动后,LLM 客户端可以向 MCP 服务器发送 JSON-RPC 请求,调用注册在 toolsets 中的工具来获取数据、执行操作或查询某些资源。
      • 使用时请按需加载工具集以优化请求成本和上下文窗口的消耗。
      • 若要在本地调试,请先确保 CATS_API_KEY 有效、CATS_API_BASE_URL 可访问,且服务器已正确启动并暴露相应传输端口。
  • 基本使用示例

    • 启动后,通过 Claude 类似工具连接时,工具将以名称形式暴露在可调用列表中,例如 list_candidates、get_job、list_pipelines 等。具体调用方式可参考 MCP 客户端文档。
  • 其他注意事项

    • 该实现包含多套工具集定义(默认、招聘相关、数据与配置等)以及一个健康端点,便于运维集成。
    • 对 CATS API 的请求通过 make_request 封装,统一处理鉴权、错误和日志。
  • 备注

    • 服务器提供的工具数量和名称等信息可能会随版本变化,请以实际部署时加载的工具集为准。官方文档中的 API 端点请参考 CATS API v3 的最新资源。

信息

分类

网页与API