adif-mcp

使用说明

  • 项目简介

    • adif-mcp 是一个使用 MCP 协议的后端服务器,面向 Amateur Radio Logging 的数据上下文服务。核心功能包括托管和管理 ADIF 资源、注册可供 LLM 调用的工具、定义和渲染提示模板,并通过 JSON-RPC 与客户端通信,支持会话管理与多种传输接口。
  • 主要功能点

    • 资源管理:提供 ADIF 相关的元数据与字段编目,便于 LLM 客户端读取与解析。
    • 工具注册与执行:暴露一组工具用于验证、解析、枚举、地理计算等功能,供 LLM 调用。
    • Prompt/模板支持:内置能力用于渲染与管理与对话上下文相关的提示模板(Prompts)。
    • MCP 协议实现:通过 JSON-RPC 与客户端通信,接收请求并返回结构化响应或通知。
    • 会话与身份框架:集成身份/凭据存储与会话管理,便于多租户/多用户场景。
    • 多传输协议准备:设计上支持未来扩展为 STDIO、SSE、WebSocket 等传输模式。
    • 资源/枚举/验证工具:提供 list_enumerations、search_enumerations、validate_adif_record 以及读取规范等工具。
  • 安装步骤

    • 确保环境已安装 Python 3.8+(仓库使用的现代语法特性)。
    • 安装包:通过 pip 安装 adif-mcp(官方发布时的标准方式)。
    • 启动服务器:直接运行包提供的 MCP 服务入口,或按项目提供的 CLI 启动方式启动服务器实例。
  • 服务器配置 说明:MCP 客户端用于连接服务器时,需配置服务器信息(server name、command、args 等)。以下给出一个基于仓库信息的准确示例配置字段与含义,便于客户端建立连接。注意:下列为配置项描述,使用时请以 JSON 形式填写,无需直接在代码中展示。

    配置示例(JSON 结构,注释以文本形式说明字段含义): { "server_name": "adif", "command": "adif-mcp", "args": [] } 字段说明:

    • server_name:在客户端配置中用于标识该 MCP 服务器的名称(示例中为 "adif")。
    • command:启动服务器的命令或可执行入口(示例中为 "adif-mcp",即打包后提供的可执行入口)。
    • args:启动命令的附加参数,通常为空数组,若有特定运行模式可在此传递,如配置路径、端口等。 备注:MCP 客户端只需要 server_name、command、args 等最小信息即可建立连接;其他高级配置如认证、端点筛选等由服务端实现和协议协商处理。
  • 基本使用方法

    • 启动:在具备合适运行环境的服务器上启动 adif-mcp 服务。
    • 连接:MCP 客户端将根据上述配置,通过 JSON-RPC 与 MCP 服务器建立会话并探测可用的资源、工具、以及提示模板。
    • 使用场景示例:
      • 读取资源元数据或规格信息
      • 调用工具进行 ADIF 数据验证、解析、枚举查询等
      • 获取并渲染提示模板以驱动对话式推理
    • 客户端运行后,可以通过标准的 JSON-RPC 调用发起请求,如读取资源、执行工具、查询枚举等,服务器端返回相应的 JSON-RPC 响应或通知。

服务器信息