Altmetric MCP Server

使用说明(Markdown 格式)

  • 项目简介

    • 该仓库实现了一个 MCP 服务器,提供对 Altmetric 数据与工具的访问能力,供 MCP 客户端(如嵌入式/本地的 LLM 应用)通过标准化的接口读取数据、执行工具并获取结果。
  • 主要功能点

    • MCP 请求处理:实现对 MCP 的核心请求类型(列出工具、执行工具)的处理逻辑,按 MCP 规范返回响应。
    • 工具注册与执行:注册一组工具(如 get_citation_counts、get_citation_details、search_citations 等),并实现对应的执行逻辑与错误处理。
    • 数据源整合:通过 Details Page API 与 Explorer API 获取外部数据,提供对资源的访问能力与数据能力。
    • 传输协议支持:默认使用标准输入/输出(stdio)传输,与本地或嵌入式的 LLM 客户端无缝对接。
    • 安全与容错:对 API 调用进行参数校验、错误日志记录,必要时返回友好错误信息。
  • 安装步骤

    • 确保 Node.js 版本为 18.x 及以上。
    • 克隆或下载本仓库到本地。
    • 安装依赖(在项目根目录执行:通常为 npm install)。
    • 配置 API 凭证(环境变量,或放在 .env 文件中):
      • ALTMETRIC_DETAILS_API_KEY:Details Page API 的密钥(可选,若使用 Details API 的工具则需要)
      • ALTMETRIC_EXPLORER_API_KEY:Explorer API 的密钥(可选,若使用 Explorer API 的工具则需要)
      • ALTMETRIC_EXPLORER_API_SECRET:Explorer API 的密钥对应密钥(需大于等于16字符)
    • 启动服务器(本服务器设计为可通过 MCP 客户端以 stdio 方式连接运行,示例启动方式如下所述,仅作说明,不是必须的唯一方式):
      • 使用 MCP 客户端将服务器作为一个本地进程启动并连接,或直接通过 npx altmetric-mcp 运行(需要在实际发布时将 npm 包发布为可执行命令)。
    • 运行时注意事项
      • 至少配置一个 API(Details Page API 或 Explorer API)密钥,确保工具可以正常请求外部数据。
      • 服务器启动后将通过标准输入/输出与 MCP 客户端建立连接,确保客户端正确配置以使用 stdio 传输。
  • 服务器配置(给 MCP 客户端的连接信息,JSON 形式描述,非直接代码块,便于理解) { server_name: "altmetric-mcp", command: "npx", args: ["-y", "altmetric-mcp"], env: { ALTMETRIC_DETAILS_API_KEY: "<your_details_api_key>", ALTMETRIC_EXPLORER_API_KEY: "<your_explorer_api_key>", ALTMETRIC_EXPLORER_API_SECRET: "<your_explorer_api_secret>" } // 说明 // - 该配置用于 MCP 客户端知道如何启动并连接本服务器。 // - 仅包含你实际拥有的 API 凭证(若不使用某个 API,则可不设置对应的密钥)。 // - server_name 与 command/args 对应 README 中的示例:服务名为 altmetric-mcp,命令为 npx,参数为 -y 和 altmetric-mcp。 }

  • 基本使用方法

    • 启动后,MCP 客户端通过标准输入/输出与服务器建立连接。
    • 客户端可通过列表接口获取已注册的工具清单,并通过调用接口执行具体工具。
    • 工具执行结果包含结构化数据(structuredContent)与可展示的文本摘要(content),便于在 UI/LLM 对话中展示。

服务器信息