Crossref MCP

🚀 Crossref MCP Server

A Model Context Protocol (MCP) server for interacting with the Crossref API.

🚀 Quick Start

The Crossref MCP Server is designed to interact seamlessly with the Crossref API, enabling users to search for works and retrieve detailed information efficiently.

✨ Features

• Search for works by title.
• Search for works by author.
• Retrieve detailed information about a work using its DOI.

📦 Installation

To install the Crossref MCP Server, you need to configure the following JSON settings:

{
  "mcpServers": {
    "crossref": {
      "command": "npx",
      "args": [
        "-y",
        "@botanicastudios/crossref-mcp"
      ]
    }
  }
}

💻 Usage Examples

Basic Usage

The server provides three main tools for interacting with the Crossref API:

Search by Title

Search for works in Crossref by title:

// Example: Search for works with "quantum computing" in the title
{
  "title": "quantum computing",
  "rows": 5  // Optional, default is 5
}

Search by Author

Search for works in Crossref by author:

// Example: Search for works written by "Einstein"
{
  "author": "Einstein",
  "rows": 5  // Optional, default is 5
}

Retrieve Work Information by DOI

Retrieve information about a specific work using its DOI:

// Example: Retrieve the work with the DOI "10.1088/1742-6596/1398/1/012023"
{
  "doi": "10.1088/1742-6596/1398/1/012023"
}

Advanced Usage

The server returns all responses in a structured JSON object format. Here are the different response formats for various scenarios:

Successful Search Response

{
  "status": "success",
  "query": {
    /* Original query parameters */
  },
  "count": 5,
  "results": [
    {
      "title": "Work Title",
      "authors": [
        {
          "given": "First Name",
          "family": "Last Name",
          "name": "First Name Last Name"
        }
      ],
      "published": {
        "dateParts": [2023, 1, 15],
        "dateString": "2023-1-15"
      },
      "type": "Journal Article",
      "doi": "10.xxxx/xxxxx",
      "url": "https://doi.org/10.xxxx/xxxxx",
      "journalTitle": "Journal Title",
      "volume": "Volume Number",
      "issue": "Issue Number",
      "pageRange": "Page Range"
    }
  ]
}

Single Work Retrieval by DOI

{
  "status": "success",
  "result": {
    "title": "Work Title",
    "authors": [
      {
        "given": "First Name",
        "family": "Last Name",
        "name": "First Name Last Name"
      }
    ],
    "published": {
      "dateParts": [2023, 1, 15],
      "dateString": "2023-1-15"
    },
    "type": "Journal Article",
    "doi": "10.xxxx/xxxxx",
    "url": "https://doi.org/10.xxxx/xxxxx",
    "journalTitle": "Journal Title",
    "volume": "Volume Number",
    "issue": "Issue Number",
    "pageRange": "Page Range"
  }
}

Error or No Results Response

{
  "status": "error",
  "message": "Error message"
}

📚 Documentation

Testing

To run the test suite, execute the following command:

npm test crossref

Test Structure

• Mock Data: Use crossref-mock to simulate the responses of the Crossref API.
• Test Cases:
  • Successfully search for multiple works.
  • Successfully search for works by a single author.
  • Successfully retrieve work information using a DOI.
  • Handle queries with no results.
  • Handle error cases.

Extending Tests

To add more test cases, follow these steps:

1. Add a new test description file in the test/crossref.test.js file.
2. Write test cases using Node.js and the Jest framework.
3. Run the test suite to verify the new cases.

With these tools and methods, you can easily interact with the Crossref API and obtain the required work information.