# ClearPath Learning MCP

ClearPath Learning MCP is a beginner-first technical learning project. It ships a public website, a hosted learner workspace, and a standalone MCP package that turns a technical topic into four useful parts: **What it is**, **Real-world analogy**, **Example**, and **Try it**.

The project is designed for people learning Python, security, DevOps, web development, databases, networking, and related subjects. Security lessons are intentionally constrained to defensive, lawful, locally authorized learning examples.

## Project map

| Area | Purpose |
|---|---|
| `client/` | Public MCP product website and authenticated learner interface. |
| `server/` | GPT-5 mini lesson engine, private lesson history, hosted MCP routes, and optional reminder flow. |
| `packages/clearpath-learning-mcp/` | The publishable local MCP package using standard input/output transport. |
| `docs/` | Release and open-source maintenance guidance. |

## Quick start

Use Node.js 20 or later and pnpm 10 or later.

```bash
pnpm install
pnpm dev
```

The public product site is available at `/`, while the hosted learner is at `/learn`. Run the verification suite before opening a pull request:

```bash
pnpm check
pnpm test
```

## Local MCP package

The standalone package is located in `packages/clearpath-learning-mcp`. It is intentionally separate from the hosted website so developers can install and run it from any MCP-compatible desktop client or project. After publication, users can install it with `npm install clearpath-learning-mcp`.

### Install from npm

Install the published MCP package in a project:

```bash
npm install clearpath-learning-mcp
```

Or let an MCP-compatible client start the current package through `npx`:

```bash
npx -y clearpath-learning-mcp
```

Use the package [README](packages/clearpath-learning-mcp/README.md) for the complete MCP-client configuration, including the locally supplied provider key.

### Install directly from GitHub

Users do **not** need an npm token to use ClearPath from this repository. Clone the project, build the local MCP package, and add its command to an MCP-compatible client. The full copy-and-paste guide is available in [Using ClearPath from GitHub](docs/USING_CLEARPATH_FROM_GITHUB.md).

```bash
cd packages/clearpath-learning-mcp
npm install
npm run build
npm test
```

The local package requires each user to configure their own OpenAI-compatible provider key. See the package [README](packages/clearpath-learning-mcp/README.md) and the [configuration reference](docs/CONFIGURATION.md) for the complete client configuration example. **Never commit provider keys, test credentials, or `.env` files.**

## Open-source community

This project is distributed under the [MIT License](LICENSE). Please read the [contribution guide](CONTRIBUTING.md), [code of conduct](CODE_OF_CONDUCT.md), and [security policy](SECURITY.md) before participating.

## Release ownership

The package metadata links to this public repository. Before publishing a version, maintainers should complete the [npm publishing guide](docs/NPM_PUBLISHING.md) and the [release checklist](docs/OPEN_SOURCE_RELEASE_CHECKLIST.md). **Only maintainers publishing to npm need an npm token; end users cloning or installing ClearPath do not.**