academic-search-mcp 0.1.3__tar.gz

academic_search_mcp-0.1.3/.claude/settings.local.json

@@ -0,0 +1,8 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(wc:*)",
+      "Bash(python -m pytest:*)"
+    ]
+  }
+}

academic_search_mcp-0.1.3/.github/workflows/publish.yml

@@ -0,0 +1,32 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - 'v*.*.*'  
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    environment: pypi  
+    permissions:
+      id-token: write  
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.10'
+
+      - name: Install build tools
+        run: |
+          python -m pip install --upgrade pip
+          pip install build
+
+      - name: Build package
+        run: python -m build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

academic_search_mcp-0.1.3/.gitignore

@@ -0,0 +1,172 @@
+.DS_Store
+scratch/
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# vscode
+.vscode/
+**/CLAUDE.local.md
+
+./downloads
+./test_downloads

academic_search_mcp-0.1.3/CLAUDE.md

@@ -0,0 +1,70 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project Overview
+
+Academic Search MCP is a Model Context Protocol (MCP) server that enables Claude and other LLM clients to search and download academic papers from 12 platforms: arXiv, PubMed, bioRxiv, medRxiv, Google Scholar, IACR, Semantic Scholar, CrossRef, OpenAlex, CORE, SSRN, and CyberLeninka.
+
+Fork of [openags/paper-search-mcp](https://github.com/openags/paper-search-mcp) with additional platforms.
+
+## Commands
+
+```bash
+# Install dependencies (editable mode)
+uv venv && source .venv/bin/activate  # Windows: .venv\Scripts\activate
+uv add -e .
+
+# Run tests
+pytest tests/
+
+# Run specific test
+pytest tests/test_arxiv.py
+
+# Run MCP server
+python -m paper_search_mcp.server
+```
+
+## Architecture
+
+### Core Components
+
+- **`server.py`** - MCP server entry point using FastMCP. Declares 18 tools with `@mcp.tool()` decorator
+- **`paper.py`** - `Paper` dataclass for standardized output format across all platforms
+- **`pdf_utils.py`** - PDF text extraction (pdftotext with PyPDF2 fallback)
+- **`academic_platforms/`** - Platform-specific searchers, each inheriting from `PaperSource` base class
+
+### Data Flow
+
+1. MCP Tool receives request → 2. Platform searcher makes API call → 3. Response parsed into `Paper` objects → 4. Serialized via `paper.to_dict(abstract_limit)`
+
+### Base Class Pattern
+
+All platform searchers inherit from `PaperSource` and implement:
+- `search(query, **kwargs) -> List[Paper]`
+- `download_pdf(paper_id, save_path) -> str`
+- `read_paper(paper_id, save_path) -> str`
+
+### Tool Categories
+
+- **Search**: `search_{platform}` for each of the 12 platforms
+- **Metadata**: `get_paper_by_doi`, `get_crossref_paper_by_doi`, `get_openalex_work_by_id`
+- **Citations**: `get_openalex_references`, `get_openalex_citations`
+- **Authors**: `search_authors`, `get_author_papers`
+- **Download/Read**: `download_paper`, `read_paper` (unified interface)
+
+## Conventions
+
+- **Date format**: Always YYYY-MM-DD for `date_from`/`date_to` parameters
+- **Abstract limit**: `abstract_limit` param controls truncation (0=omit, -1=full, default=200)
+- **Searcher naming**: Classes are `{Platform}Searcher` (e.g., `ArxivSearcher`)
+- **Error handling**: Return empty lists on API errors, use logging, graceful degradation
+
+## Adding a New Platform
+
+1. Create `paper_search_mcp/academic_platforms/{platform}.py`
+2. Create class inheriting from `PaperSource`
+3. Implement `search()`, `download_pdf()`, `read_paper()` methods
+4. Add searcher instance to `SEARCHERS` dict in `server.py`
+5. Create `@mcp.tool()` function for `search_{platform}`
+6. Add test file `tests/test_{platform}.py`

academic_search_mcp-0.1.3/Dockerfile

@@ -0,0 +1,19 @@
+# Generated by https://smithery.ai. See: https://smithery.ai/docs/config#dockerfile
+FROM python:3.10-alpine
+
+# Install system dependencies
+RUN apk add --no-cache build-base libffi-dev openssl-dev
+
+WORKDIR /app
+
+# Copy the entire repository
+COPY . .
+
+# Upgrade pip and install dependencies
+RUN pip install --upgrade pip \
+    && pip install --no-cache-dir .
+
+# Expose port if necessary (MCP servers use stdio; no port to expose)
+
+# Command to run the MCP server
+CMD ["python", "-m", "paper_search_mcp.server"]

academic_search_mcp-0.1.3/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 OPENAGS
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

academic_search_mcp-0.1.3/PKG-INFO

@@ -0,0 +1,243 @@
+Metadata-Version: 2.4
+Name: academic-search-mcp
+Version: 0.1.3
+Summary: A MCP server for searching and downloading academic papers from multiple sources.
+Author-email: "P.S Zhang" <pengsongzhang96@gmail.com>
+License-File: LICENSE
+Requires-Python: >=3.10
+Requires-Dist: beautifulsoup4>=4.12.0
+Requires-Dist: curl-cffi>=0.5.0
+Requires-Dist: fastmcp
+Requires-Dist: feedparser
+Requires-Dist: httpx[socks]>=0.28.1
+Requires-Dist: lxml>=4.9.0
+Requires-Dist: mcp[cli]>=1.6.0
+Requires-Dist: pypdf2>=3.0.0
+Requires-Dist: requests
+Description-Content-Type: text/markdown
+
+# Academic Search MCP
+
+A Model Context Protocol (MCP) server for searching and downloading academic papers from multiple sources. Designed for seamless integration with large language models like Claude Desktop.
+
+> **Fork Notice**: This is an extended fork of [openags/academic-search-mcp](https://github.com/openags/academic-search-mcp) with additional platforms (CORE, SSRN, CyberLeninka) and improvements.
+
+![License](https://img.shields.io/badge/license-MIT-blue.svg) ![Python](https://img.shields.io/badge/python-3.10+-blue.svg)
+
+---
+
+## Table of Contents
+
+- [Overview](#overview)
+- [Features](#features)
+- [Installation](#installation)
+  - [Quick Start](#quick-start)
+    - [Install Package](#install-package)
+    - [Configure Claude Desktop](#configure-claude-desktop)
+  - [For Development](#for-development)
+    - [Setup Environment](#setup-environment)
+    - [Install Dependencies](#install-dependencies)
+- [Contributing](#contributing)
+- [Demo](#demo)
+- [License](#license)
+- [TODO](#todo)
+
+---
+
+## Overview
+
+`academic-search-mcp` is a Python-based MCP server that enables users to search and download academic papers from various platforms. It provides tools for searching papers (e.g., `search_arxiv`) and downloading PDFs (e.g., `download_arxiv`), making it ideal for researchers and AI-driven workflows. Built with the MCP Python SDK, it integrates seamlessly with LLM clients like Claude Desktop.
+
+---
+
+## Features
+
+- **Multi-Source Support**: Search and download papers from arXiv, PubMed, bioRxiv, medRxiv, Google Scholar, IACR ePrint Archive, Semantic Scholar, CrossRef, OpenAlex, CORE, SSRN, and CyberLeninka.
+- **Date Filtering**: All sources support `date_from` and `date_to` parameters (YYYY-MM-DD format) to filter papers by publication date.
+- **Citation Counts**: OpenAlex, Semantic Scholar, CrossRef, and Google Scholar include citation counts in search results.
+- **Citation Graph**: OpenAlex tools to explore references (papers a work cites) and citations (papers citing a work), sorted by impact.
+- **Open Access PDFs**: OpenAlex includes PDF URLs for open access papers.
+- **Token-Optimized Output**: Configurable `abstract_limit` parameter to control abstract length (default: 200 chars, use -1 for full, 0 to omit).
+- **Standardized Output**: Papers are returned in a consistent, compact dictionary format via the `Paper` class.
+- **Asynchronous Tools**: Efficiently handles network requests using `httpx`.
+- **MCP Integration**: Compatible with MCP clients for LLM context enhancement.
+- **Extensible Design**: Easily add new academic platforms by extending the `academic_platforms` module.
+
+### Search Parameters
+
+All search tools support these common parameters:
+
+| Parameter | Type | Default | Description |
+|-----------|------|---------|-------------|
+| `query` | str | required | Search query string |
+| `max_results` | int | 10 | Maximum number of papers to return |
+| `abstract_limit` | int | 200 | Max chars for abstract (0=omit, -1=full) |
+| `date_from` | str | None | Start date in YYYY-MM-DD format |
+| `date_to` | str | None | End date in YYYY-MM-DD format |
+
+> **Note**: Google Scholar only supports year-level filtering (month/day are ignored).
+
+---
+
+## Installation
+
+### Quick Start with uvx
+
+The easiest way to use `academic-search-mcp`:
+
+```bash
+uvx academic-search-mcp
+```
+
+Or install globally:
+
+```bash
+uv tool install academic-search-mcp
+```
+
+### Configure Claude Desktop
+
+Add this configuration to `~/Library/Application Support/Claude/claude_desktop_config.json` (Mac) or `%APPDATA%\Claude\claude_desktop_config.json` (Windows):
+
+```json
+{
+  "mcpServers": {
+    "academic_search": {
+      "command": "uvx",
+      "args": ["academic-search-mcp"]
+    }
+  }
+}
+```
+
+### Alternative: Install with pip/uv
+
+```bash
+pip install academic-search-mcp
+# or
+uv add academic-search-mcp
+```
+
+2. **Configure Claude Desktop (alternative)**:
+   Add this configuration to `~/Library/Application Support/Claude/claude_desktop_config.json` (Mac) or `%APPDATA%\Claude\claude_desktop_config.json` (Windows):
+   ```json
+   {
+     "mcpServers": {
+       "paper_search_server": {
+         "command": "uv",
+         "args": [
+           "run",
+           "--directory",
+           "/path/to/your/academic-search-mcp",
+           "-m",
+           "paper_search_mcp.server"
+         ],
+         "env": {
+           "SEMANTIC_SCHOLAR_API_KEY": "", // Optional: For enhanced Semantic Scholar features
+           "CORE_API_KEY": "" // Optional: for CORE repository access
+         }
+       }
+     }
+   }
+   ```
+   > Note: Replace `/path/to/your/academic-search-mcp` with your actual installation path.
+
+### For Development
+
+For developers who want to modify the code or contribute:
+
+1. **Setup Environment**:
+
+   ```bash
+   # Install uv if not installed
+   curl -LsSf https://astral.sh/uv/install.sh | sh
+
+   # Clone repository
+   git clone https://github.com/openags/academic-search-mcp.git
+   cd academic-search-mcp
+
+   # Create and activate virtual environment
+   uv venv
+   source .venv/bin/activate  # On Windows: .venv\Scripts\activate
+   ```
+
+2. **Install Dependencies**:
+
+   ```bash
+   # Install project in editable mode
+   uv add -e .
+
+   # Add development dependencies (optional)
+   uv add pytest flake8
+   ```
+
+---
+
+## Contributing
+
+We welcome contributions! Here's how to get started:
+
+1. **Fork the Repository**:
+   Click "Fork" on GitHub.
+
+2. **Clone and Set Up**:
+
+   ```bash
+   git clone https://github.com/yourusername/academic-search-mcp.git
+   cd academic-search-mcp
+   pip install -e ".[dev]"  # Install dev dependencies (if added to pyproject.toml)
+   ```
+
+3. **Make Changes**:
+
+   - Add new platforms in `academic_platforms/`.
+   - Update tests in `tests/`.
+
+4. **Submit a Pull Request**:
+   Push changes and create a PR on GitHub.
+
+---
+
+## Demo
+
+<img src="docs\images\demo.png" alt="Demo" width="800">
+
+## TODO
+
+### Planned Academic Platforms
+
+- [x] arXiv
+- [x] PubMed
+- [x] bioRxiv
+- [x] medRxiv
+- [x] Google Scholar
+- [x] IACR ePrint Archive
+- [x] Semantic Scholar
+- [x] CrossRef
+- [x] OpenAlex
+- [x] CORE (200M+ open access papers)
+- [x] SSRN (social sciences, law, business preprints)
+- [x] CyberLeninka (Russian academic papers, VAK/RSCI/SCOPUS filters)
+- [ ] PubMed Central (PMC)
+- [ ] Science Direct
+- [ ] Springer Link
+- [ ] IEEE Xplore
+- [ ] ACM Digital Library
+- [ ] Web of Science
+- [ ] Scopus
+- [ ] JSTOR
+- [ ] ResearchGate
+
+---
+
+## License
+
+This project is licensed under the MIT License. See the LICENSE file for details.
+
+---
+
+Happy researching with `academic-search-mcp`!
+
+## Credits
+
+Based on [openags/paper-search-mcp](https://github.com/openags/paper-search-mcp) by P.S Zhang.