---
title: "Quickstart"
description: "Install the plugins, mint an MCP key, and connect an AI client in a few minutes."
source: "https://docs.blend-ed.com/openedx-mcp/quickstart/"
---

# Quickstart

Two packages: **`tutor-contrib-openedxmcp`** (runs the MCP server + installs the app) and **`openedx-mcp`** (the Django facade inside LMS/CMS). Targets the **Ulmo** release.

## 1. Install
```
pip install tutor-contrib-openedxmcptutor plugins enable openedxmcp
# The openedx-mcp Django app auto-installs into the openedx image (Dockerfile# patch) — no extra step. To pin a version instead:#   tutor config save --append OPENEDX_EXTRA_PIP_REQUIREMENTS=openedx-mcp==<ver>
tutor images build openedx openedxmcptutor local launch          # or: tutor k8s launchtutor local do init         # runs migrations -> creates the MCP key tables
```
## 2. Mint a key
Django admin → **Open edX MCP → MCP keys → Add**. Pick the acting user (must be `is_staff`/`is_superuser`), a name, tick the [scopes](/openedx-mcp/security/), save. The raw key is shown **once** in the banner — copy it — along with ready-to-paste connect steps.

## 3. Connect
```
claude mcp add --transport http openedx https://mcp.<LMS_HOST>/mcp \  --header "Authorization: Bearer <YOUR_MCP_KEY>"
```
See [Connect a client](/openedx-mcp/connect/) for Claude Desktop, Cursor and others.

## 4. Verify
In a session, call the **`whoami`** tool — it returns your identity, the resolved `is_staff`/`is_superuser` flags, and the scopes granted to the key.

> **Tip**
> Start read-only: mint a `read`-scoped key first, confirm `whoami` and `analytics_overview`, then widen scopes as you trust the workflow.