Skip to main content

MCP server for Librus Synergia — access grades, messages, attendance, homework, timetables, and announcements from AI assistants

Project description

Librus MCP Server

License: MIT PyPI

An MCP (Model Context Protocol) server that provides AI assistants with access to the Librus Synergia electronic gradebook. It supports multiple student accounts simultaneously and exposes tools for grades (numeric, GPA, and descriptive), messages, attendance, homework, schedules, timetables, announcements, completed lessons, and student information.

Acknowledgments

This project is built on top of the excellent librus-apix library by RustySnek. Their work on reverse-engineering and maintaining a Python client for the Librus Synergia platform made this MCP server possible. If you find this project useful, please consider starring their repository as well.

Quick Start

1. Add to your AI assistant

Pick your client. Credentials are passed directly via the env block — no files or cloning needed.

Claude Desktop

Add to your claude_desktop_config.json:

{
  "mcpServers": {
    "librus": {
      "command": "uvx",
      "args": ["librus-mcp"],
      "env": {
        "LIBRUS_ACCOUNTS": "[{\"alias\":\"daughter\",\"username\":\"12345\",\"password\":\"...\"}]"
      }
    }
  }
}

Claude Code

Via the /mcp command or in ~/.claude.json (global):

{
  "mcpServers": {
    "librus": {
      "command": "uvx",
      "args": ["librus-mcp"],
      "env": {
        "LIBRUS_ACCOUNTS": "[{\"alias\":\"daughter\",\"username\":\"12345\",\"password\":\"...\"}]"
      }
    }
  }
}

Gemini CLI

Add to ~/.gemini/settings.json (global) or .gemini/settings.json (project-level):

{
  "mcpServers": {
    "librus": {
      "command": "uvx",
      "args": ["librus-mcp"],
      "env": {
        "LIBRUS_ACCOUNTS": "[{\"alias\":\"daughter\",\"username\":\"12345\",\"password\":\"...\"}]"
      }
    }
  }
}

OpenAI Codex CLI

Add to ~/.codex/config.toml (global) or .codex/config.toml (project-level):

[mcp_servers.librus]
command = "uvx"
args = ["librus-mcp"]

[mcp_servers.librus.env]
LIBRUS_ACCOUNTS = '[{"alias":"daughter","username":"12345","password":"..."}]'

Note: uvx automatically downloads and runs the package from PyPI — no cloning or virtual environments needed. You only need uv installed (curl -LsSf https://astral.sh/uv/install.sh | sh).

Providing credentials

Each account represents a parent's login to Librus Synergia for a specific child. In the Polish school system, parents receive separate Librus login credentials for each of their children. The alias is a friendly name you choose to identify which child's data you're accessing. The username and password are the parent portal credentials you use to log in at synergia.librus.pl.

Limitation: accounts that require interactive two-factor authentication are not supported — the underlying librus-apix library has no 2FA flow, so such accounts fail at login.

There are three ways to provide credentials (checked in this order):

Method Best for Example
LIBRUS_ACCOUNTS env var uvx users, CI JSON array of account objects (see examples above)
LIBRUS_CONFIG env var Custom file location Path to your secrets.json, e.g. ~/.config/librus/secrets.json
secrets.json in working dir Local development Create from secrets.json.template

Multiple children

Add multiple accounts to the JSON array:

[{"alias":"daughter","username":"12345","password":"..."},{"alias":"son","username":"67890","password":"..."}]

Using a config file with uvx

If you prefer a file over inline JSON:

{
  "mcpServers": {
    "librus": {
      "command": "uvx",
      "args": ["librus-mcp"],
      "env": {
        "LIBRUS_CONFIG": "/Users/you/.config/librus/secrets.json"
      }
    }
  }
}

Alternative: Install from source

If you prefer to run from a local clone:

git clone https://github.com/krzysztofbury/librus-mcp.git
cd librus-mcp
uv venv && uv pip install -e .
cp secrets.json.template secrets.json   # Then fill in credentials

Then use the full path in your MCP config:

{
  "mcpServers": {
    "librus": {
      "command": "/path/to/librus-mcp/.venv/bin/librus-mcp"
    }
  }
}

Available Tools

Tool Description
list_students() List configured student aliases
get_grades(student_alias, sort_by?) Get numeric grades, GPA, and descriptive grades (all, week, or last_login)
get_final_grades(student_alias) Get end-of-year summary per subject: midterm, predicted annual (przewidywana roczna), and annual grade
get_messages(student_alias, page?, folder?, all_pages?) Get one page of messages from the received or sent folder, or the whole folder (bounded at 2000 messages)
get_message_content(student_alias, message_id) Get a message: author, title, date, and content
get_attendance(student_alias, sort_by?) Get attendance records (all, week, or last_login)
get_attendance_detail(student_alias, detail_url) Get details of one attendance entry
get_attendance_frequency(student_alias) Get attendance frequency per semester and overall
get_subject_frequency(student_alias, start?, end?) Get per-subject attendance percentage, optionally filtered by date range
get_homework(student_alias, date_from?, date_to?) Get homework for a date range (default: next 2 weeks)
get_homework_detail(student_alias, detail_url) Get full details of a specific homework assignment
get_schedule(student_alias, year, month) Get calendar events/exams for a month
get_schedule_detail(student_alias, href) Get details of one schedule event (test scope, room, teacher)
get_recent_schedule_events(student_alias) Get schedule events added since the last Librus login
get_timetable(student_alias, monday?) Get a week's timetable (default: current week; monday picks another week)
get_announcements(student_alias) Get school announcements
get_completed_lessons(student_alias, date_from, date_to) Get completed lessons (subject, teacher, topic) for a date range
get_student_information(student_alias) Get student profile (name, class, tutor, school, lucky number)

All tools carry MCP ToolAnnotations (read-only / destructive / idempotent hints), so MCP hosts can apply their own safety policies.

Optional tools (feature gates)

These tools are registered based on the features section of the configuration (or the LIBRUS_FEATURES env var, a JSON object merged over it):

Tool Feature gate Default Description
get_new_notifications(student_alias) notifications on Everything new since the previous call (grades, attendance, messages, announcements, schedule, homework). Seen-state is persisted per student, so each item is reported once
get_message_attachments(student_alias, message_id) attachments on List attachments (filename + file ID) of a message
download_attachment(student_alias, message_id, file_id) attachments on Download an attachment to the download directory
get_behaviour_notes(student_alias) behaviour_notes on Behaviour notes (uwagi): date, teacher, category, content
get_recipient_groups(student_alias) send_message off List recipient groups for messaging
get_recipients(student_alias, group) send_message off List recipients (name → ID) in a group
send_message(student_alias, title, content, recipient_ids, confirm_token?) send_message off Send a real message to school staff — enable deliberately

send_message uses a two-step confirmation: the first call sends nothing and returns a preview plus a single-use confirm_token (valid 5 minutes); only a second call with that token delivers the message.

Example with all options:

{
  "accounts": [{"alias": "daughter", "username": "12345", "password": "..."}],
  "features": {
    "notifications": true,
    "attachments": true,
    "behaviour_notes": true,
    "send_message": false
  },
  "state_dir": "~/.librus-mcp/state",
  "download_dir": "~/.librus-mcp/downloads"
}
Setting Env override Default Purpose
features LIBRUS_FEATURES see above Enable/disable optional tools
state_dir LIBRUS_STATE_DIR ~/.librus-mcp/state Per-student seen-notification state
download_dir LIBRUS_DOWNLOAD_DIR ~/.librus-mcp/downloads Attachment download target

Project Structure

src/
  server.py              # MCP server with tool definitions and entry point
  librus_client.py       # Librus API client wrapper with caching and retry
  config.py              # Configuration loader (reads secrets.json)
  notification_state.py  # Per-student persistence of seen-notification IDs
  scraping.py            # Own Synergia scraping: attachments, behaviour notes
tests/                   # pytest suite with mocked librus-apix

Contributing

Contributions are welcome! See CONTRIBUTING.md for guidelines.

Security

To report vulnerabilities, see SECURITY.md.

License

This project is licensed under the MIT License. See LICENSE for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

librus_mcp-0.5.2.tar.gz (192.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

librus_mcp-0.5.2-py3-none-any.whl (29.7 kB view details)

Uploaded Python 3

File details

Details for the file librus_mcp-0.5.2.tar.gz.

File metadata

  • Download URL: librus_mcp-0.5.2.tar.gz
  • Upload date:
  • Size: 192.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for librus_mcp-0.5.2.tar.gz
Algorithm Hash digest
SHA256 db26ddc1e915407687977e85a10a9bfaa34cfa2b08a1c0efbacfdfe8250a45c1
MD5 d03f90b31f3dc78b723ea4b61f99f88d
BLAKE2b-256 d333345a5185d0438a0431311aaaffca5299d4808c0102bf17c6723372d477ae

See more details on using hashes here.

Provenance

The following attestation bundles were made for librus_mcp-0.5.2.tar.gz:

Publisher: publish.yml on krzysztofbury/librus-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file librus_mcp-0.5.2-py3-none-any.whl.

File metadata

  • Download URL: librus_mcp-0.5.2-py3-none-any.whl
  • Upload date:
  • Size: 29.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for librus_mcp-0.5.2-py3-none-any.whl
Algorithm Hash digest
SHA256 d5f3ff1698cd55b7cbb37bb147a125adf5d45592cb48e573b7c045e4fa0dc348
MD5 52e78f28252aa39b564d2a9ff20defc0
BLAKE2b-256 349c0d9cf9060597a5af3c1bde9678d1cc8fa50f3bc95c20be4a50d29886ec0b

See more details on using hashes here.

Provenance

The following attestation bundles were made for librus_mcp-0.5.2-py3-none-any.whl:

Publisher: publish.yml on krzysztofbury/librus-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page