@openread/mcp 0.0.1-test.1

package/LICENSE

@@ -0,0 +1,23 @@
+MIT License
+
+Copyright (c) 2025 OpenRead Contributors
+
+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.
+
+SPDX-License-Identifier: MIT

package/README.md

@@ -0,0 +1,147 @@
+# @openread/mcp
+
+MCP server for [Openread](https://openread.ai) -- access your book library from AI assistants like Claude, Cursor, VS Code Copilot, and more.
+
+## Quick Start
+
+1. Get an API key from [Openread Settings > API Keys](https://app.openread.ai/settings)
+2. Add to your AI client configuration (see below)
+3. Ask your AI about your books!
+
+## Configuration
+
+### Claude Desktop
+
+Add to `~/Library/Application Support/Claude/claude_desktop_config.json` (macOS) or `%APPDATA%\Claude\claude_desktop_config.json` (Windows):
+
+```json
+{
+  "mcpServers": {
+    "openread": {
+      "command": "npx",
+      "args": ["-y", "@openread/mcp"],
+      "env": {
+        "OPENREAD_API_KEY": "orsk-your-key-here"
+      }
+    }
+  }
+}
+```
+
+### Claude Code
+
+Add to `~/.claude/settings.json`:
+
+```json
+{
+  "mcpServers": {
+    "openread": {
+      "command": "npx",
+      "args": ["-y", "@openread/mcp"],
+      "env": {
+        "OPENREAD_API_KEY": "orsk-your-key-here"
+      }
+    }
+  }
+}
+```
+
+### Cursor
+
+Add to `~/.cursor/mcp.json` (global) or `.cursor/mcp.json` (project):
+
+```json
+{
+  "mcpServers": {
+    "openread": {
+      "command": "npx",
+      "args": ["-y", "@openread/mcp"],
+      "env": {
+        "OPENREAD_API_KEY": "orsk-your-key-here"
+      }
+    }
+  }
+}
+```
+
+### Other Clients
+
+The same configuration works for all MCP-compatible clients:
+
+| Client     | Config File                                                               |
+| ---------- | ------------------------------------------------------------------------- |
+| VS Code    | `.vscode/mcp.json` (project-level)                                        |
+| Windsurf   | `~/.windsurf/mcp.json`                                                    |
+| Codex      | `~/.codex/mcp.json`                                                       |
+| Gemini CLI | `~/.gemini/settings.json`                                                 |
+
+## Available Tools
+
+| Tool             | Description                                          |
+| ---------------- | ---------------------------------------------------- |
+| `list_books`     | List all books in your library                       |
+| `get_book_info`  | Get metadata for a specific book                     |
+| `get_toc`        | Get table of contents                                |
+| `get_chapter`    | Get full chapter text                                |
+| `get_page_range` | Get text for a page range                            |
+| `get_headings`   | Get heading hierarchy for a chapter (~500B vs 100KB) |
+| `get_section`    | Get content for a specific section by heading        |
+| `get_passage`    | Get text around a location with context              |
+| `get_key_terms`  | Get key terms extracted from a chapter               |
+| `search_book`    | Full-text search within a book                       |
+| `search_library` | Search across all books                              |
+
+## Agent Navigation Pattern
+
+For efficient book navigation, agents can use a progressive disclosure pattern:
+
+```
+1. get_toc(bookId)             -> chapter list
+2. get_key_terms(bookId, ch)   -> assess relevance (~500B)
+3. get_headings(bookId, ch)    -> section structure (~500B)
+4. get_section(bookId, ch, h)  -> targeted content (1-5KB)
+```
+
+This achieves 96%+ token savings compared to fetching full chapters.
+
+## Environment Variables
+
+| Variable             | Required | Default                   | Description                                    |
+| -------------------- | -------- | ------------------------- | ---------------------------------------------- |
+| `OPENREAD_API_KEY`   | Yes      | --                        | Your `orsk-` API key from the Openread web app |
+| `OPENREAD_API_URL`   | No       | `https://api.openread.ai` | API base URL (for self-hosted or staging)      |
+| `OPENREAD_CACHE_DIR` | No       | OS-specific               | Override the default disk cache directory       |
+
+## Troubleshooting
+
+### "Invalid token" error
+
+- Verify your API key starts with `orsk-` followed by a UUID
+- Check the key has not been revoked in Settings > API Keys
+- Ensure `OPENREAD_API_KEY` is set in the `env` block of your config (not as a shell env var)
+
+### "Connection refused" or server won't start
+
+- Verify Node.js 18+ is installed: `node --version`
+- Verify npx works: `npx --version`
+- Check your client's MCP log for detailed error messages
+
+### Server starts but no books appear
+
+- Verify you have uploaded books to your Openread library
+- Try asking your AI to call `list_books` directly to check connectivity
+
+### Slow first response
+
+- The first call for each book downloads and parses the file (~5-15 seconds depending on file size)
+- Subsequent calls use the disk cache and are near-instant
+- Cache is stored at `~/Library/Caches/openread-mcp` (macOS), `~/.cache/openread-mcp` (Linux), or `%LOCALAPPDATA%\openread-mcp\Cache` (Windows)
+
+## Requirements
+
+- Node.js 18 or later
+- An Openread account with books in your library
+
+## License
+
+AGPL-3.0