scholar-mcp 1.0.3 → 1.0.6

package/README.md

@@ -1,14 +1,13 @@
-![ScholarMCP banner](public/scholarmcp_banner.svg)
+![ScholarMCP banner](public/scholarmcp_banner.png)
 
 # ScholarMCP
 
 [![npm](https://img.shields.io/npm/v/scholar-mcp)](https://www.npmjs.com/package/scholar-mcp)
-[![latest commit](https://img.shields.io/github/last-commit/lstudlo/ScolarMCP)](https://github.com/lstudlo/ScolarMCP/commits/main)
-[![license](https://img.shields.io/github/license/lstudlo/ScolarMCP)](https://github.com/lstudlo/ScolarMCP/blob/main/LICENSE)
-[![minified](https://img.shields.io/bundlephobia/min/scholar-mcp)](https://bundlephobia.com/package/scholar-mcp)
-[![minzipped](https://img.shields.io/bundlephobia/minzip/scholar-mcp)](https://bundlephobia.com/package/scholar-mcp)
+[![latest commit](https://img.shields.io/github/last-commit/lstudlo/ScholarMCP)](https://github.com/lstudlo/ScholarMCP/commits/main)
+[![license](https://img.shields.io/github/license/lstudlo/ScholarMCP)](https://github.com/lstudlo/ScholarMCP/blob/main/LICENSE)
 
 ScholarMCP is an MCP server for literature research workflows in coding agents.
+Official documentation: https://scholar-mcp.lstudlo.com/
 
 It gives your agent tools to:
 - search papers across multiple sources
@@ -164,7 +163,7 @@ RESEARCH_ALLOW_LOCAL_PDFS = "true"
 Run sidecar:
 
 ```bash
-cd python-sidecar
+cd ../../services/python-sidecar
 python -m venv .venv
 source .venv/bin/activate
 pip install -r requirements.txt
@@ -210,6 +209,47 @@ pnpm check
 pnpm test
 ```
 
+## Documentation Site (Astro)
+
+The repository includes an integrated Astro + Starlight docs app at `apps/docs` (repo-root path).
+
+```bash
+# run docs locally
+pnpm docs:dev
+
+# regenerate generated docs artifacts only
+pnpm docs:sync
+
+# verify docs
+pnpm docs:check
+
+# build docs output to apps/docs/dist
+pnpm docs:build
+```
+
+Generated docs artifacts:
+- MCP tool reference: `apps/docs/src/content/docs/reference/mcp-tools.mdx`
+- Release notes index: `apps/docs/src/content/docs/releases/index.mdx`
+
+Generation source inputs:
+- Tool metadata: `packages/scholar-mcp/src/mcp/create-scholar-mcp-server.ts`
+- Release metadata: git tags in this repository
+
+Cloudflare Pages target settings:
+- Root directory: `/`
+- Build command: `pnpm install --frozen-lockfile && pnpm docs:build`
+- Build output directory: `apps/docs/dist`
+- Production branch: `main`
+- Canonical docs URL: `https://scholar-mcp.lstudlo.com/`
+
+Automatic deployment is configured via Cloudflare Pages Git integration:
+- Cloudflare dashboard path: `Workers & Pages` -> your project -> `Settings` -> `Builds` -> `Git repository`
+- Ensure repo access is granted in the Cloudflare GitHub app installation
+- Configure branch controls in `Settings` -> `Builds` -> `Branch control`
+  - Production branch: `main`
+  - Preview branches: `All non-production branches` (or custom include/exclude)
+- Build skip flags in commit message disable auto deploy (`[CI Skip]`, `[CI-Skip]`, `[Skip CI]`, `[Skip-CI]`, `[CF-Pages-Skip]`)
+
 ## Publish Workflow
 
 ```bash

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "scholar-mcp",
-  "version": "1.0.3",
+  "version": "1.0.6",
   "description": "MCP Server for researchers",
   "license": "MIT",
   "type": "module",
@@ -10,7 +10,8 @@
   },
   "files": [
     "dist",
-    "README.md"
+    "README.md",
+    "public/scholarmcp_banner.png"
   ],
   "scripts": {
     "dev": "tsx watch src/index.ts",
@@ -55,5 +56,13 @@
     "tsx": "^4.21.0",
     "typescript": "^5.9.3",
     "vitest": "^4.0.18"
+  },
+  "homepage": "https://scholar-mcp.lstudlo.com",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/lstudlo/ScholarMCP.git"
+  },
+  "bugs": {
+    "url": "https://github.com/lstudlo/ScholarMCP/issues"
   }
 }

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2026 Light Chen from lstudlo
-
-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.