StudieSync
Officialby StudieSync
README.md
# StudieSync for Claude
StudieSync puts a university student's course material from Canvas into a folder on their own computer: one folder per course, a subfolder per week or topic, and an overview of the timetable and tasks. This plugin gives Claude read-only access to that folder and adds six ready-made study prompts, so the student can ask about this week's readings, get a quiz or flashcards, or practise for the exam, with answers that point to the file and page they came from.
The plugin runs only on the student's computer. It reads the folder and nothing else, and it sends nothing to StudieSync or anyone else.
```
Claude (Cowork, Claude Code) ── plugin ─┐
Claude Desktop chat ─────────── .mcpb ──┼─ stdio ─► server/index.js ── read only ─► the StudieSync folder
ChatGPT desktop ─────── MCP servers ────┘ (local or a cloud client's synced folder)
```
## What it adds
- **Tools** (all marked `readOnlyHint`, none destructive):
- `list_courses`: the courses in the folder, with their week or topic folders and file counts.
- `list_files`: the files of a course, or of one week or topic in it.
- `read_file`: the text of a PDF, Word (DOCX), PowerPoint (PPTX), Markdown or text file, with `[Side N]` and `[Slide N]` markers, in parts of 20,000 characters.
- **Resources:** `studiesync://skema` (timetable), `studiesync://to-do` (tasks) and `studiesync://laes-mig` (the folder's guide for AI tools).
- **Prompts** with the arguments `fag` and `emne` (`course` and `topic` in English): `overview` (the week at a glance), `podcast` (a script), `flashcards`, `quiz`, `exam` (exam practice, one question at a time) and `explain` (the hardest concepts explained simply).
## Example prompts
1. "Which courses do I have in StudieSync, and what is in week 46 of VØS1?"
2. Run the prompt **overview** with course `VØS1` and topic `46`: the key points of the week, the central concepts and three questions to answer by the end of the week, each with file and page.
3. Run the prompt **quiz** with course `MAK2` and topic `Inflation`: ten questions with four options, answers and sources at the end.
4. "Explain price setting from the article in week 46, and tell me which page it is on."
## What it runs, reads and sends
- **Runs:** `node server/index.js`, started by Claude over stdio. Dependencies (`@modelcontextprotocol/sdk`, `zod`, `unpdf`, `mammoth`, `jszip`) are pinned to exact versions in `package-lock.json`.
- **Reads:** only inside the StudieSync folder, and only with `readdir`, `stat`, `realpath` and `readFile`. Absolute paths, `..`, hidden folders (such as StudieSync's own `.studiesync/`) and symbolic links are refused, so nothing outside the folder can be read.
- **Writes:** nothing. It never creates, changes, moves or deletes a file.
- **Sends and fetches:** nothing. The server makes no network calls (a test checks the source for network modules). File text is kept in memory only, for the last 20 files, and is gone when Claude closes.
- **Finding the folder:** the student picks it in the plugin's settings. Left empty, the server looks for a folder called `StudieSync` in the home folder, Documents, Desktop and the cloud clients' folders (macOS `~/Library/CloudStorage/<client>`, Windows `~/<client>`, including "My Drive"). It only accepts a folder that StudieSync itself made (it contains `.studiesync/`). When it finds none or more than one, it asks the student to pick the folder.
## Install
- **Cowork (Claude desktop app, paid plan; steps from Anthropic's guide, not yet tried in Cowork):** Customize › Plugins › Add › Add marketplace › Add from a repository, enter `StudieSync/studiesync-mcp`, then open Discover and add **StudieSync**. Set "StudieSync folder" in its settings, or leave it empty.
- **Claude Code (tested):** `/plugin marketplace add StudieSync/studiesync-mcp`, then `/plugin install studiesync@studiesync`. It needs Node.js 20 or later.
- **Claude Desktop chat:** plugins with a local server do not run in chat. Use the desktop extension instead: build it with `scripts/build-mcpb.sh`, double-click `dist/studiesync.mcpb` and pick the folder. Claude Desktop runs it with its built-in Node.
- **ChatGPT desktop (partly tested, macOS):** Settings → MCP servers → Add server → STDIO, with `node <path>/server/index.js --folder <StudieSync folder>`.
## Troubleshooting
- **"Ingen StudieSync-mappe er valgt…" or "Der er flere StudieSync-mapper…":** pick the folder in the plugin's settings.
- **"Mappen findes ikke":** the folder has moved, or the cloud client has not mounted it yet. The server tries again on the next call.
- **"StudieSync kan ikke læse tekst fra .png-filer endnu":** images and scanned PDFs without a text layer cannot be read.
## Privacy and security
StudieSync's own service never sees the files, their names or what the student asks. The material belongs to the teachers and the university: Claude is told to quote only what is needed and not to pass it on. To report a security problem, see [SECURITY.md](SECURITY.md).
## Development
- **Test:** `npm ci && npm test` starts the server over stdio with the SDK's client against a synthetic folder (`test/fixture.mjs`). `CONNECTOR_TEST_VERBOSE=1` shows the answers. `CONNECTOR_SERVER=<unpacked .mcpb>/server/index.js` tests the packed version.
- **Check the plugin:** `claude plugin validate . --profile directory`.
- **Build the desktop extension:** `scripts/build-mcpb.sh [--fixture <empty folder>]` writes `dist/studiesync.mcpb` (and a synthetic test folder to try it on).
## License
Copyright StudieSync. All rights reserved; see [LICENSE](LICENSE). The source is public so that anyone can check what the connector does.
This server cannot be deployed
Maintenance
ActivityMaintained
ResponsivenessNo recent community issues