Openalex MCP

🚀 OpenAlex MCP 服務端

OpenAlex MCP 服務端是一個使用 Node.js、Express 和 Axios 創建的代理服務器，它的主要作用是將查詢轉發到 OpenAlex API，為用戶與 OpenAlex API 之間搭建了便捷的橋樑。

作者: Samadori H. Biaou hbiaou@gmail.com

許可證: MIT 許可證

🚀 快速開始

在使用 OpenAlex MCP 服務端之前，需要先完成一些準備工作，包括安裝必要的軟件和配置環境。

📦 安裝指南

先決條件

• Node.js (>=14)
• npm

安裝依賴

npm install

配置環境

在項目根目錄創建一個 .env 文件，內容如下：

PORT=3000
OPENALEX_BASE_URL=https://api.openalex.org

運行服務器

npm start

服務器將在 http://localhost:<PORT> 監聽

💻 使用示例

基礎用法

可以通過發送 GET 請求到 /search 接口進行查詢，查詢參數 q 用於指定搜索詞。

GET http://localhost:3000/search?q=machine%20learning

📚 詳細文檔

API 說明

GET /search

查詢參數:

• q: 搜索詞

生產部署

Docker 部署

提供了一個 Dockerfile 用於生產部署。

• 構建 Docker 鏡像:

  docker build -t openalex-mcp .
  

• 運行容器:

  docker run -p 3000:3000 -d openalex-mcp
  

環境配置

確保生產環境變量（例如 PORT 和 OPENALEX_BASE_URL）正確設置。對於敏感數據，考慮使用秘密管理器。

擴展和監控

• 擴展: 使用容器編排工具如 Docker Swarm 或 Kubernetes 水平擴展基於負載。
• 監控: 集成監控解決方案（例如 New Relic、Prometheus 或 Grafana）以跟蹤服務器健康狀況和性能。

備份程序

為關鍵數據和配置文件實施自動化備份。定期備份容器卷和數據庫（如有必要）。

測試和 CI/CD

使用 GitHub Actions 配置了一個 CI 管道，用於在每個推送和拉取請求上運行單元測試和集成測試。

📄 許可證

本項目採用 MIT 許可證。