Add cross-course lexical search with evidence and scope reporting

Open
#40 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Active
Tech stack
javascript, node.js
Domain
search

Research direction

Read AGENTS.md and docs/PROJECT_CONTEXT.md, then inspect src/index.js, index metadata, and the existing search_course behavior. This depends on #39, and the issue asks contributors to discuss the design before implementation, so wait for the dependent contracts and maintainer direction. Done means the acceptance tests cover scoped search, valid citations, authorization checks, and missing or unindexed coverage while preserving compatibility.

Written by the indexing model from the issue text.

Description

area:backend area:docs priority:medium status:blocked type:feature

Part of #28 · Target: Retrieval / v0.4

Goal and scope

Search explicit authorized course/semester scopes over indexed text and documents. Return ranked bounded snippets, course/resource/page references, index freshness and missing/unindexed coverage. Keep current search_course behavior compatible.

Implementation starting points

new search adapter/tool, src/index.js, index metadata. Follow AGENTS.md and docs/PROJECT_CONTEXT.md; reuse existing authorization, safe-error and synthetic-fixture patterns. New runtime dependencies need a documented reason.

Dependencies and readiness

Depends on #39. Discuss the design before starting implementation; dependent contracts must land first.

Out of scope

No generated unsupported answers, semantic search, implicit semester inference or hidden query telemetry.

Acceptance criteria and test plan

Tests cover Unicode/case/diacritics, filters, ranking, limits, no-result and partially indexed scopes. Every result has a valid citation; authorization is rechecked and unknown/unindexed is distinguishable from no matching text.

Run the relevant offline tests, npm run check and git diff --check; runtime changes also require npm test and npm audit. Report checks not run. No faculty credentials or private course material are required for a contribution.

Contributing

Comment here before starting so the maintainer can coordinate the approach and avoid duplicate work. Fork the repository, branch from master, and open a focused PR referencing this issue. No assignee or delivery deadline is set; required checks and review apply.

Dominant language
JavaScript
Stars
0
Forks
0
Avg merge
1h 25m
Merged PRs (30d)
13

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from mahmutmft/courses-mcp

All issues in mahmutmft/courses-mcp

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.