Skip to content
ScholarMCP
Documentation menu

Local Development

Run ScholarMCP from source and verify changes.

Prerequisites

  • Node.js 24 LTS, or Node.js 22.14 or later
  • pnpm 10

Setup

pnpm install --frozen-lockfile

Run from Source

Stdio mode:

pnpm dev:stdio

HTTP mode:

pnpm dev:http

Verify

Type check package:

pnpm check

Run tests:

pnpm test

Build the docs and check generated content:

node --test scripts/generate-docs-*.test.mjs
pnpm docs:build
pnpm --filter scholar-mcp-docs test
git diff -- apps/docs/src/content/docs/reference/mcp-tools.md apps/docs/src/content/docs/releases/index.md

Commit generated changes with the source changes that caused them. The docs CI job rejects stale generated content. Run pnpm release:check before releasing to also check the package build and tarball contents.

Start typing to search