Skip to content

QUICKSTART.md

Latest commit

 

History

History
101 lines (71 loc) · 2.31 KB

QUICKSTART.md

File metadata and controls

101 lines (71 loc) · 2.31 KB

Quick Start Guide (5 minutes)

Get your AI tutor running in 5 minutes or less!

1. Install (2 minutes)

cd tutor-mcp-python
pip install -e .

Or with uv:

uv pip install -e .

2. Configure Claude Desktop (2 minutes)

Edit the config file:

  • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
  • Windows: %APPDATA%\Claude\claude_desktop_config.json

Add this:

{
  "mcpServers": {
    "tutor": {
      "command": "tutor-mcp",
      "env": {
        "TUTOR_MATERIALS_PATH": "/Users/yourname/path/to/materials"
      }
    }
  }
}

Important: Use the absolute path to your materials directory!

3. Add Materials (1 minute)

Create a materials directory and add some files:

mkdir materials
cd materials

Add any .txt, .md, or .pdf files with your study materials. For example:

  • Lecture notes
  • Textbook chapters
  • Study guides
  • Problem sets

4. Start Using (30 seconds)

  1. Restart Claude Desktop
  2. Look for the hammer icon 🔨 in Claude - this confirms the server is connected
  3. Ask questions like:
    • "What educational materials do I have?"
    • "Explain [concept] from my notes"
    • "Generate a quiz on [topic]"

That's it!

Your AI tutor is now running with access to your personal study materials.

Example Conversation

You: "What materials do I have?"

Claude: Uses the list_topics tool to show all your documents

You: "Explain recursion based on my materials"

Claude: Uses explain_concept to find and explain recursion from your notes

You: "Generate a 5 question quiz on sorting algorithms, medium difficulty"

Claude: Uses generate_quiz to create practice questions from your materials

Troubleshooting

Server not showing up?

  • Double-check the config file is valid JSON
  • Make sure you restarted Claude Desktop
  • Verify the materials path is absolute (starts with / or C:\)

No materials found?

  • Check the path in your config
  • Ensure your files have supported extensions (.txt, .md, .pdf)
  • Look at Claude Desktop logs for error messages

Next Steps

  • Organize your materials into folders by subject
  • Try different tools: search, summarize, quiz generation
  • Ask Claude to explain difficult concepts from your materials
  • Generate practice problems to test your understanding

Happy learning!