Skip to main content
Glama

All About NTU

Explore NTU services from your terminal or connect them to an AI assistant. Search courses and library resources, navigate campus, check shuttle arrivals, and access your own learning materials and student services through a single application.

Documentation · CLI guide · MCP setup · Service reference · Report an issue

All About NTU provides two interfaces to the same services:

  • CLI: run ntu commands directly in your terminal, with readable output or JSON for scripts.

  • MCP: give a compatible AI client access to selected NTU tools through a local server or the hosted public server.

Quickstart

Install uv and Python 3.10 or newer. Then choose how you want to use All About NTU:

Use the CLI

uv tool install 'all-abt-ntu[cli,personal]@latest'
ntu cli setup
ntu --help

Connect an MCP client

uvx --from 'all-abt-ntu[cli,mcp,personal]@latest' ntu mcp setup

Setup lets you choose a profile, enable tools, and configure Codex, Claude Code, or OpenCode. You can also connect to the hosted public server without installing anything locally.

For personal services such as NTULearn and One Stop, use CLI setup to save your credentials and install Chromium. You can skip these steps if you only use public services; no NTU account is needed for those.

Your password stays in your OS keyring. It is entered through a hidden prompt, stored locally with no plaintext fallback, and sent only to NTU or its Microsoft sign-in service when needed. It is never returned through MCP or shared with your AI client.

Related MCP server: McGill VSB MCP

Available services

Service

What you can do

CLI

Reference

STARS

Search courses, explore prerequisites and indexes, view schedules and manage plans

ntu stars

STARS

NTULearn

Browse enrolled courses, learning materials, announcements, grades and calendars

ntu learn

NTULearn

CareerAxis

Find opportunities, employers, career events and resources

ntu career

CareerAxis

MazeMap

Search campus places and get walking directions

ntu map

MazeMap

DR-NTU

Discover research publications, repository collections and datasets

ntu research

DR-NTU

Library

Search the catalogue, inspect records and explore facilities

ntu library

Library

Faculty

Find faculty members and research interests

ntu faculty

Faculty

News

Browse and search NTU news

ntu news

News

Campus Services

Find food, shops, clinics and other campus services

ntu services

Campus Services

Omnibus

Check shuttle routes, stops, arrivals and service status

ntu bus

Omnibus

One Stop @ SAC

Explore the catalog and manage requests, appointments and other student services

ntu onestop

One Stop

The service references include CLI commands, MCP tools, arguments, outputs and service-specific limits.

Authentication

If you saved your credentials during setup, you do not need to save them again. To save or manage them later, run:

ntu auth save
ntu auth status
ntu auth delete

Your password is entered through a hidden prompt and stored locally in your OS keyring; there is no plaintext fallback. Your keyring must be available and unlocked. Never enter a password into an AI conversation or MCP client configuration.

If you use MCP through uvx without installing the CLI, save credentials with:

uvx --from 'all-abt-ntu[cli,personal]@latest' ntu auth save

See credentials and platform setup for more details.

CLI

Installation

For public and authenticated services:

uv tool install 'all-abt-ntu[cli,personal]@latest'

For public services only, install the smaller CLI extra:

uv tool install 'all-abt-ntu[cli]@latest'

See the CLI installation guide for browser-cookie support.

Manual CLI installation

To run the CLI from a local checkout:

git clone https://github.com/pitchaya-s/all-abt-ntu.git
cd all-abt-ntu
uv sync --no-default-groups --extra cli --extra personal
uv run --no-sync playwright install chromium
uv run --no-sync ntu --help

For public services only, omit --extra personal and the Chromium installation. Use uv run --no-sync ntu auth save to save credentials for personal services. See the manual CLI guide for environment activation and platform-specific details.

Examples

Search courses, inspect a course and explore its indexes and prerequisites:

ntu stars courses search "data structures" --year 2026 --semester 1 --limit 10 --offset 0
ntu stars course ZZ0001 --year 2026 --semester 1
ntu stars indexes ZZ0001 --year 2026 --semester 1 --limit 10 --offset 0
ntu stars prerequisites ZZ0001 --year 2026 --semester 1 --prerequisite-depth 2 --dependent-depth 2

Browse NTULearn content and download a file or video:

ntu learn courses --limit 20 --offset 0
ntu learn content ZZ0001 --limit 20 --offset 0
ntu learn attachments ZZ0001 "_67890_1" --limit 20 --offset 0
ntu learn files download ZZ0001 "_67890_1" "_24680_1" --output "./lecture.pdf" --max-bytes 20000000
ntu learn videos download ZZ0001 "_67890_1" --output "./lecture.mp4" --max-mb 500

ZZ0001 and the IDs above are fictional. Replace them with your course and content IDs from the preceding commands. Supported NTULearn content URLs can also be used in place of course and content IDs; see the NTULearn CLI guide. Downloads require confirmation.

Explore the rest of campus:

ntu map search "LT1" --limit 10 --offset 0
ntu bus arrivals --route Blue --stop "North Spine" --source shuttle
ntu library search "machine learning" --field title --match contains --limit 10 --offset 0
ntu news search "artificial intelligence" --sort latest --page 1
ntu services search "coffee" --location "North Spine" --limit 10 --offset 0

Run ntu --help, ntu stars --help, or add --help to a command to see its available arguments. Many data commands support --json, pagination options and --refresh where applicable:

ntu map search "LT1" --limit 10 --offset 0 --json

See the CLI guide and complete command reference for more examples and options.

MCP

MCP connects NTU tools to compatible AI clients. The local server offers a public profile and a personal profile; personal tools use your locally saved credentials. You choose which tools are available, and actions and downloads require confirmation.

Local setup

uvx --from 'all-abt-ntu[cli,mcp,personal]@latest' ntu mcp setup

To review or change tools later:

uvx --from 'all-abt-ntu[cli,mcp,personal]@latest' ntu mcp tools list
uvx --from 'all-abt-ntu[cli,mcp,personal]@latest' ntu mcp tools list --all
uvx --from 'all-abt-ntu[cli,mcp,personal]@latest' ntu mcp tools disable news
uvx --from 'all-abt-ntu[cli,mcp,personal]@latest' ntu mcp tools enable stars

To run a public stdio server directly:

uvx --from 'all-abt-ntu[mcp]@latest' ntu mcp --profile public

The MCP setup guide covers client configuration, profiles, Chromium and manual installation. See the tool reference for available tools.

Manual MCP installation

For interactive setup and personal tools from a local checkout:

git clone https://github.com/pitchaya-s/all-abt-ntu.git
cd all-abt-ntu
uv sync --no-default-groups --extra cli --extra mcp --extra personal
uv run --no-sync ntu mcp setup

For a public server, install only the MCP extra and start the server directly:

uv sync --no-default-groups --extra mcp
uv run --no-sync ntu mcp --profile public

If you didn't save credentials during setup, use uv run --no-sync ntu auth save. The manual MCP guide has more details.

Hosted public server

Add the following URL to a client that supports remote MCP servers, using Streamable HTTP and no authentication:

https://all-abt-ntu-mcp.vercel.app/mcp

The hosted server provides public, read-only information. Personal services require the local server. See the hosted MCP guide for details.

Documentation and contributing

Browse the documentation site for getting started, service guides, architecture and security, known issues, and limitations.

To work on the project, see the development guide, testing guide, and contributing guide. Preview the documentation locally with:

uvx --from mkdocs-material mkdocs serve

Disclaimer

This is an independent project and is not affiliated with, sponsored by, or endorsed by Nanyang Technological University (NTU), Singapore.

Your NTU credentials are retrieved locally from your OS keyring and submitted over HTTPS to NTU or its Microsoft sign-in service. They are never returned through MCP. Academic data returned by tools is visible to the AI client. Keyring storage protects credentials at rest; it does not isolate them from other programs or agents allowed to access your unlocked keyring or the server process.

Use this software only to access accounts and materials you are authorized to access. Do not download, copy, store, or redistribute course recordings, lecture files, library resources, research data, or other restricted or copyrighted material unless you have permission. Follow NTU policies, copyright and license notices, source-service terms, and applicable law. Do not bypass authentication, CAPTCHA, DRM, paywalls, or other access restrictions. You are responsible for ensuring your access, downloads, retention, and reuse are authorized.

Available Tools

7 tools
compare_indexesB
Read-onlyIdempotent

Compare shared and index-specific sessions; optionally check clashes with supplied time slots.

Inputs: indexes (required), semester (required), course_code (required), academic_year (required), +1 more. Returns: object

find_matching_indexesA
Read-onlyIdempotent

Find indexes matching day/time/lesson/week rules and avoiding supplied timetable clashes.

Inputs: semester (required), course_code (required), academic_year (required), constraints, +1 more. Returns: object

get_courseB
Read-onlyIdempotent

Get course metadata and every index with its complete timetable.

Inputs: semester (required), course_code (required), academic_year (required). Returns: object

get_course_indexesB
Read-onlyIdempotent

List all indexes for a course, including every lecture, tutorial, lab, and other session.

Inputs: semester (required), course_code (required), academic_year (required). Returns: object

get_graduate_course_scheduleB
Read-onlyIdempotent

Get a graduate course's class groups for NTU's currently published academic term.

Inputs: course_code (required). Returns: object

get_index_scheduleC
Read-onlyIdempotent

Get every scheduled session for one course index.

Inputs: index (required), semester (required), course_code (required), academic_year (required). Returns: object

get_undergraduate_exam_scheduleA
Read-onlyIdempotent

Get public General Access exam dates and times for a course in the latest or specified published term.

Inputs: course_code (required), semester, academic_year. Returns: object

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

Loading tool schema changelog…

    TDQS

    B3.3/5.0

    Scored across 7 tools

    Disambiguation3/5

    get_course returns course metadata AND every index with its complete timetable, which substantially overlaps with get_course_indexes (list all indexes) and get_index_schedule (one index's sessions). An agent could reasonably pick any of the three for overlapping needs. The exam/graduate schedules and the compare/find pair are clearly distinct, but the course/index trio blurs boundaries.

    Naming Consistency4/5

    All names follow a verb_noun pattern (get_course, get_index_schedule, find_matching_indexes, compare_indexes) with snake_case throughout. The graduate/undergraduate schedule names are longer and add scope qualifiers, a minor deviation but still readable and predictable.

    Tool Count5/5

    Seven tools is well-scoped for a course-index lookup domain, covering distinct resource/action combinations without bloat. No trivial single tool or excessive surface.

    Completeness4/5

    The surface covers course metadata, index listing, per-index schedules, graduate/undergraduate scheduling, exam dates, index comparison, and clash-aware matching, which is strong lifecycle coverage. Some gaps remain, such as no explicit search-by-course-code tool, but core planning workflows are supported.

    Maintenance

    ActivityMaintained
    ResponsivenessNo recent community issues

    Related MCP Connectors

    Related MCP Servers

    • A
      license
      A
      quality
      D
      maintenance
      Enables course planning for University of Pennsylvania by searching the catalog, inspecting sections and ratings, detecting schedule conflicts, and building weekly schedules.
      15
      MIT
    • A
      license
      A
      quality
      B
      maintenance
      Gives AI assistants direct, on-demand access to McGill's public Visual Schedule Builder timetable data, letting them search course offerings, fetch sections and meeting times, check conflicts, and generate ranked schedule combinations without a login, API key, or browser session. Queries and schedule calculations run locally on structured results, with a short-lived cache for repeated requests.
      4
      23 npm
      2
      MIT
    • A
      license
      A
      quality
      B
      maintenance
      Enables read-only querying of eight campus services through independent local MCP adapters: mailbox search, reading and attachment download, Blackboard courses, academic-system terms, timetable and grades, library loans and navigation, teaching-office notices, the Nan7 market listings, course-review community ratings, and the campus data dashboard. Credentials and sessions remain on the user's own device, encrypted with Windows DPAPI, and nothing is submitted, registered, or booked on the user's behalf.
      7
      1
      MIT
    • A
      license
      A
      quality
      B
      maintenance
      Enables AI assistants to read a student's own university academic data — class timetables, exam schedules, grades, available terms, and empty classrooms — from Qiangzhi (jsxsd) or Zhengfang V9 systems via a session imported from the browser. All access is strictly read-only, never performing course selection, withdrawal, or evaluations.
      6
      1
      MIT