Metadata-Version: 2.4
Name: iflow-mcp_gdkrmr-mcp-git-course
Version: 0.1.2
Summary: Add your description here
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: fastmcp<3
Dynamic: license-file

# Learn `git` with LLMs

Use your local LLM client to learn `git` interactively with the help of this course.

## How it works

- This repository contains an MCP server that instructs your LLM client teach you `git`. It contains course materials and instructions.
- It also keeps track of your progress, so you can continue where you left off.
- To use, add the MCP server to your local LLM client and say `start git course` to begin the course. You can restart the course at any time by saying `restart git course`.
- The MCP server keeps track of your progress, you can ask it to `resume the git course` and it will resume the course.
- Sometimes LLMs get confused you can jump to any lesson b

## How to use

- Set up your local LLM client.
- Install and add `mcp-git-course` as an MCP server to your client.
- Ask your LLM client to "start the git course".

## Requirements

A local LLM client that supports MCP servers, such as [Zed](https://zed.dev), [Claude code](https://claude.ai), [VS Code](https://code.visualstudio.com), or [Gemini](https://ai.google.dev/gemini).

### Installation

#### `pipx`

install via [`pipx`](https://pipx.pypa.io/latest/installation):

```bash
pipx install git+https://github.com/gdkrmr/git-mcp-course.git
```

This will install the `mcp-git-course` command, which is the MCP server that serves the course materials.

update the package:

```bash
pipx upgrade git+https://github.com/gdkrmr/git-mcp-course.git
```

#### `uvx`

use directly via [`uvx`](https://docs.astral.sh/uv/), `uvx` takes care of installation on the fly. Configure as 

```json
{
  "git_course": {
    "command": "uvx",
    "args": [
      "--from",
      "git+https://github.com/gdkrmr/mcp-git-course@master",
      "mcp-git-course"
    ]
  }
}
```

note that the exact configuration may be slightly different, depending on your client.

### Configure for your client

#### Zed

Add the following to `~/.config/zed/settings.json`

```json
{
  ...,
  "context_servers": {
    "git_course": {
      "source": "custom",
      "enabled": true,
      "command": "mcp-git-course",
      "args": [],
      "env": {}
    },
    ...
  },
  ...
}
```

#### Claude code

TODO

#### VS Code

- Install the Copilot and Copilot Chat 
- Press Ctrl+Shift+p 
- Search for "MCP: Add MCP server"
- Choose "Command (stdio)"
- As command enter `uvx --from git+https://github.com/gdkrmr/mcp-git-course@master mcp-git-course`
- As name enter "git-course", or similar
- The server should appear under the tools icon in the agent panel on the bottom right.

The `mcp.json` file should look as follows:

``` json
{
	"servers": {
    // There should be an inline button here to start/restart/stop/etc. the server.
		"git-course": {
			"type": "stdio",
			"command": "uvx",
			"args": [
				"--from",
				"git+https://github.com/gdkrmr/git-mcp-course.git",
				"mcp-git-course"
			]
		}
	},
	"inputs": []
}
```

`

#### gemini-cli

Add this to your `~/.gemini/settings.json` file:

```json
{
  "mcpServers": {
    "serverName": {
      "command": "mcp-git-course",
      "args": [],
      "env": {},
      "cwd": "",
      "timeout": 30000,
      "trust": false
    }
  }
}
```

## Manually following the course

You can also access the course materials [here](https://github.com/gdkrmr/mcp-git-course/tree/master/src/mcp_git_course/resources/lessons) without having an LLM as an intermediary.

## Notice

This work was inspired by MCP course provided by the [mastra mcp server](https://github.com/mastra-ai).

