Openalex MCP

🚀 OpenAlex MCP Server

A proxy server created using Node.js, Express, and Axios to forward queries to the OpenAlex API.

Author: Samadori H. Biaou hbiaou@gmail.com

License: MIT License

🚀 Quick Start

✨ Features

This server is a proxy built with Node.js, Express, and Axios. It serves to forward queries to the OpenAlex API.

📦 Installation

Before installation, make sure you have the following prerequisites:

• Node.js (>=14)
• npm

Run the following command to install the dependencies:

npm install

Configuration

Create a .env file in the project root directory with the following content:

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

Running the Server

Execute the following command to start the server:

npm start

The server will listen on http://localhost:

💻 Usage Examples

Basic Usage

To search using the API, you can use the following example:

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

📚 Documentation

API

• GET /search
  • Query parameters:
    • q: Search term

🔧 Technical Details

Production Deployment

• Docker A Dockerfile is provided for production deployment.
  • Build the Docker image:

    docker build -t openalex-mcp .
    

  • Run the container:

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

• Environment Configuration Ensure that the production environment variables (e.g., PORT and OPENALEX_BASE_URL) are correctly set. For sensitive data, consider using a secret manager.
• Scaling and Monitoring
  • Scaling: Use container orchestration tools such as Docker Swarm or Kubernetes to scale horizontally based on the load.
  • Monitoring: Integrate monitoring solutions (e.g., New Relic, Prometheus, or Grafana) to track the server's health and performance.
• Backup Procedures Implement automated backups for critical data and configuration files. Regularly back up container volumes and databases (if necessary).

Testing and CI/CD

A CI pipeline is configured using GitHub Actions to run unit tests and integration tests on every push and pull request.