# MCP tool reference

Every tool the Ornix MCP connector registers — 42 in total — grouped by access tier, with parameters and what each one touches.

Source: https://ornix.io/docs/mcp/tools

## Overview

The connector registers 42 tools, all prefixed `ornix_`. Your account's access tier — read, write, or full — is the most any authorized app can call, and you can limit each app further under Connected apps. Structural roadmap changes from any tier are proposals you apply on the roadmap.

Haven't connected yet? Start with [connector setup](https://ornix.io/docs/mcp).

## Read

Runs without asking, since nothing here changes your data — the default tier for every new connection.

- `ornix_get_context` (Plans): Resume where the learner left off: the current roadmap, current week, what is due today, and a short learning-memory brief. Call it first in a new conversation.
  - Parameters: `plan?`
- `ornix_list_plans` (Plans): List your roadmaps — status, progress, and current week for each.
  - Parameters: `status?, limit ≤100 (default 20), cursor?`
- `ornix_get_plan` (Plans): Pull a roadmap's outline — phases, weeks, and which goals are done. Narrow to one phase or a set of week ids.
  - Parameters: `plan, format: concise | detailed, phase?, week_ids?`
- `ornix_get_week` (Weeks): Zoom into one week: goals, resources, the concepts it teaches, its note list, flashcard counts, and what your learning memory says about it.
  - Parameters: `plan, week_id, include_notes?`
- `ornix_get_progress` (Progress): Streaks, due-card count, and how each plan tracks against schedule. Scope to one plan to also get today's queue.
  - Parameters: `plan?`
- `ornix_list_notes` (Notes): List the notes on a plan, optionally filtered to one week.
  - Parameters: `plan, week_id?, limit ≤200 (default 50), cursor?`
- `ornix_get_note` (Notes): Read one note in full, including its markdown body.
  - Parameters: `id — or plan + slug`
- `ornix_get_due_cards` (Flashcards): Fetch the flashcards due for a study session, across one plan or all of them.
  - Parameters: `plan?, limit ≤200 (default 50)`
- `ornix_flashcard_stats` (Flashcards): Deck summaries — due/new counts, retention, a 7-day review count, and the review forecast.
  - Parameters: `plan?`
- `ornix_list_labs` (Labs): List the interactive labs attached to one week (titles and summaries, no HTML).
  - Parameters: `plan, week_id`
- `ornix_get_lab` (Labs): Fetch one lab in full, including its HTML, so you can read or revise it.
  - Parameters: `lab_id`
- `ornix_get_memory` (Memory): Read a roadmap's learning memory — concept mastery with evidence, open misconceptions, next steps, your background, and past session recaps. Entries show #ids for ornix_remember.
  - Parameters: `plan, week_id?, kind?, include_resolved?, limit ≤100 (default 30), response_format? (concise | detailed), cursor?`
- `ornix_get_flashcard` (Flashcards): Fetch one flashcard including its back, for grading a single answer.
  - Parameters: `card_id`
- `ornix_get_visual` (Notes): Fetch one visual's full content (widget HTML or mermaid source) by id, after a note reports its visuals collapsed.
  - Parameters: `note, plan?, visual_id`
- `ornix_list_resources` (Library): List the documents you uploaded and the links you saved to your library.
  - Parameters: `status?, limit ≤100 (default 20), cursor?`
- `ornix_get_resource` (Library): Read a windowed slice of one library document's extracted text; page through large documents instead of pulling them whole.
  - Parameters: `id, offset_chars?, limit_chars ≤20000 (default 8000)`
- `ornix_search_resources` (Library): Full-text search inside your uploaded documents, returning matching excerpts with resource ids.
  - Parameters: `q, limit ≤25 (default 10)`
- `ornix_search` (Search): Search across plans, notes, flashcards, and the public resource catalog.
  - Parameters: `query, types?, limit ≤50 (default 10)`

## Write

Prompts before running, with an “Allow always” option per chat — requires write tier or above.

- `ornix_create_plan` (Plans): Author a brand-new roadmap in one call — phases, weeks, goals, and resources — and Ornix stores, schedules, and starts tracking it.
  - Parameters: `title, summary?, start_date?, prerequisites?, phases[] (≤10 phases, ≤60 weeks total)`
- `ornix_update_plan` (Plans): Rename a roadmap, shift its start date, recover it from a failed status, or switch it between private/public visibility.
  - Parameters: `title?, start_date?, status? ("ready" to recover from failed), visibility?`
- `ornix_complete_goals` (Plans): Mark one or more goals done or undone in a single batch; completing every goal in a week finishes it and extends the streak.
  - Parameters: `updates[]: week_id, goal_index, done (≤100 per call)`
- `ornix_get_timeline` (Plans): See the schedule for every week, plus how far it's drifted from the original dates.
  - Parameters: `plan`
- `ornix_shift_schedule` (Plans): Push every remaining date out by N days, or resync the whole schedule to a resume date.
  - Parameters: `days or resume_date (exactly one)`
- `ornix_update_week` (Plans): Edit a single week's content — goals, focus, resources — without touching the rest of the plan.
  - Parameters: `plan, week_id, fields to update`
- `ornix_insert_week` (Plans): Add a hand-authored week into the plan at a given position.
  - Parameters: `plan, position, week content`
- `ornix_remove_week` (Plans): Remove a week from the plan and renumber the weeks that follow.
  - Parameters: `plan, week_id`
- `ornix_undo_plan_edit` (Plans): Revert the plan's last structural edit — available for 3 days after the edit.
  - Parameters: `plan`
- `ornix_create_note` (Notes): Write a new note on a plan, optionally scoped to one week.
  - Parameters: `plan, week_id?, title?, body_md? (≤100k chars)`
- `ornix_update_note` (Notes): Replace a note's body, append to it, or rename it — pass body_md or append, never both.
  - Parameters: `body_md or append (exactly one), title?`
- `ornix_update_visual` (Notes): Edit a generated visual in place — replace its widget HTML or mermaid source without appending a new one.
  - Parameters: `note, plan?, visual_id, html or source (exactly one), prompt?`
- `ornix_create_note_visual` (Notes): Add a visual to a note. You write it yourself: widget HTML (self-contained, one inline style and script, no network, up to 80,000 characters) or mermaid source (up to 8,000 characters). Ornix stores it and does not generate it from a prompt.
  - Parameters: `note_id, plan?, kind: widget | mermaid, html (widget) or source (mermaid), anchor?`
- `ornix_create_lab` (Labs): Author an interactive lab for a week and attach it to the week canvas. You write the HTML: one inline style and one inline script, no network, sized to fill the viewport, themed with the --ornix-* CSS variables, with a stepped story and Play/Pause/Step/Reset controls. Up to 100,000 characters.
  - Parameters: `plan, week_id, title, html, summary?`
- `ornix_update_lab` (Labs): Revise a lab in place: replace its HTML, title or summary.
  - Parameters: `lab_id, html?, title?, summary?`
- `ornix_remember` (Memory): Save what your AI learned about you on a roadmap — mastery with evidence, misconceptions, next steps, background, and a session recap — so the next session, in any AI app, picks up where this one stopped.
  - Parameters: `plan, memory_version, entries[]?, resolve[]?, recap? (≤12 entries per call)`
- `ornix_create_flashcards` (Flashcards): Turn a note or a conversation into up to 50 flashcards in one batch.
  - Parameters: `plan, week_id?, note_id?, cards[]: front_md, back_md (≤50)`
- `ornix_review_flashcard` (Flashcards): Grade one flashcard and log a real spaced-repetition review, updating its due date.
  - Parameters: `card_id, rating: again | hard | good | easy`
- `ornix_undo_review` (Flashcards): Undo your single most recent flashcard review, across any plan.
  - Parameters: none

## Destructive

Requires full tier, the highest access level — how much confirmation each tool adds varies (see below).

> **Confirmation varies by tool.** `ornix_delete_plan`, `ornix_delete_note`, `ornix_delete_flashcard`, and `ornix_delete_lab` only propose the deletion: nothing is removed until you apply it on the roadmap. `ornix_delete_plan` also requires the caller to state the plan's exact title back. `ornix_forget` acts straight away and relies on your AI client's own confirmation prompt before it calls the tool.

- `ornix_delete_plan` (Plans): Propose deleting a roadmap and everything on it — weeks, notes, and flashcards. Requires the plan's exact title as confirmation; nothing is removed until you apply it.
  - Parameters: `plan, confirm_title (must match exactly)`
- `ornix_delete_note` (Notes): Propose deleting a single note; it is removed once you apply it.
  - Parameters: `id`
- `ornix_delete_flashcard` (Flashcards): Propose deleting a single flashcard; it is removed once you apply it.
  - Parameters: `id`
- `ornix_delete_lab` (Labs): Propose deleting a lab from its week; it is removed once you apply it.
  - Parameters: `lab_id`
- `ornix_forget` (Memory): Permanently delete learning-memory entries by #id, for when you ask your AI to forget something.
  - Parameters: `plan, ids (1–50)`

## Prompt library

Four of these are wired in as canned prompts on the connector itself — `weekly_review`, `study_session`, `tutor_session`, and `capture_notes` — they show up as slash commands in Claude Code and in claude.ai's + menu, so you don't have to type the prompt at all. The rest are plain prompts — copy, paste, and edit the specifics.

### Create a roadmap

```text
I want to learn systems design well enough to pass senior-level interviews in about 4 months. I can put in 6-8 hours a week, and I'm coming from 3 years as a backend engineer. Ask me whatever you need, then build the full roadmap in Ornix.
```

Your AI interviews you, then authors the whole plan — phases, weeks, goals, and resources — as one structured roadmap with ornix_create_plan. Ornix takes it from there: storing it, scheduling it week by week, and tracking your progress.

### Weekly review

Slash command: `/weekly_review`

```text
Run my weekly review — what's my progress, what's due this week, and am I on track? Mark anything I've actually finished, and if I'm behind, suggest a replan.
```

### Study session

Slash command: `/study_session`

```text
Quiz me on my due flashcards for the ML roadmap. Ask one at a time, don't show me the answer first, and log my rating after each one.
```

### Tutor session

Slash command: `/tutor_session`

```text
Tutor me on my systems-design roadmap, week 4. Pick up from what you remember about me, teach one concept at a time, and save what my answers show as we go.
```

Your AI reads the roadmap's learning memory first, so it starts from where you left off and what you still get wrong, then records mastery, misconceptions, and next steps as the session goes. Turn off AI updates in Memory and it only reads.

### Capture notes → flashcards

Slash command: `/capture_notes`

```text
Turn what we just talked about into a note on week 6 of my systems-design plan, and pull 5 flashcards out of the key ideas.
```

### Explain & quiz

```text
Walk me through week 4 of my AI roadmap like you're teaching it fresh, then quiz me on it and log my answers as flashcard reviews so it feeds my spaced repetition.
```

### Replan when life happens

```text
I was out sick for 10 days and I'm three weeks behind on my chemistry roadmap. Replan the rest of it around where I actually am — don't touch the weeks I've already finished.
```

[Back to connector setup](https://ornix.io/docs/mcp)
