Skip to main content

Local-first course knowledge bases for AI agents: index your materials, study grounded, share the index.

Project description

Groundly

Local-first course knowledge bases for AI agents. Index your course materials once; then any MCP-capable agent — Claude Code, Claude Desktop, Codex — can answer questions grounded in the actual course content with page-level citations, generate execution-verified tests and flashcards, quiz your weak areas, and track your mastery. Share the finished knowledge base with your coursemates as a single file.

Bachelor thesis project, Universitatea Politehnica Timișoara.

$ groundly index <SUBJECT> ./slides/
  ✓ 12 PDFs → 384 chunks → embedded (bge-m3, local) → indexed
$ # wire into Claude Code:  { "command": "groundly", "args": ["mcp"] }

Then, inside your agent: "What did lecture 4 say about deadlock prevention?" → answer cited to lecture-04.pdf, page 12, "Deadlocks › Prevention" — or "not covered by the course materials", never a hallucination.

Why not NotebookLM / a Claude Project?

  1. Verified generation — every test question and flashcard passes a verifier: answerable from the cited sources, answer key checked, and code questions' reference solutions actually executed before acceptance.
  2. Enforced citations — structural, page-level, with honest refusal when the corpus doesn't cover it.
  3. A portable indexgroundly export <SUBJECT> → one file; a coursemate imports it and their agent uses it directly. The expensive artifacts (knowledge graph, verified decks) are built once and shared.
  4. Cross-host progress — mastery per topic and study memory persist in local files, whatever agent you talk to. Your queries and results never leave your machine and are never part of an export.

Features

  • Grounded Q&A — hybrid retrieval (bge-m3 dense + learned sparse + BM25, reranked; optional GraphRAG for synthesis questions), via MCP tools or groundly ask
  • Verified quizzes & coding challenges — generated by Groundly (your API key) or by your agent (no key needed) — either way, nothing unverified is stored
  • Flashcards → Anki — verified decks exported as .apkg
  • Mastery map & study memory — per-topic mastery from quiz results; "continue studying" warm starts in any host
  • Import/export — the whole knowledge base as one shareable file, with pinned-model compatibility

Install

uv tool install groundly

Local-first honestly stated: first run downloads the embedding models (~2.7GB total). Indexing and search need no API key; grounded answer generation and graph builds use your own OpenAI-compatible provider (cloud key, LM Studio, or Ollama).

Setup guides: connect Claude Code / Codex to the MCP server · use LM Studio as a zero-key local provider

Thesis core: four-arm RAG vs GraphRAG evaluation on real RO/EN course corpora, plus a measured comparison of enforced vs agent-mediated grounding.

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

groundly-0.5.2.tar.gz (2.0 MB view details)

Uploaded Source

Built Distribution

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

groundly-0.5.2-py3-none-any.whl (48.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: groundly-0.5.2.tar.gz
  • Upload date:
  • Size: 2.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.29 {"installer":{"name":"uv","version":"0.11.29","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for groundly-0.5.2.tar.gz
Algorithm Hash digest
SHA256 436eef102f5b8d589aadc752847e4500c45ad6673e49eefef4331aca7281e4f7
MD5 84682587d627800c61f1a7ba57e8e77f
BLAKE2b-256 1b3cc58d0ff7730fee489e3e3066a03ca5d3482a2e98f5c95c2a5998c153f297

See more details on using hashes here.

File details

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

File metadata

  • Download URL: groundly-0.5.2-py3-none-any.whl
  • Upload date:
  • Size: 48.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.29 {"installer":{"name":"uv","version":"0.11.29","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for groundly-0.5.2-py3-none-any.whl
Algorithm Hash digest
SHA256 30f3e905a49778ddc2e615b7351f20fdddf2d6b0e00ce7b51034fc1ce5f8d35f
MD5 e14ab3c848255d346ec16eb228aed7db
BLAKE2b-256 eba3800f5d32e0c14ab97f6215a2784078b2abc8fa8a37aca24c01746616c8bb

See more details on using hashes here.

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