QUICKSTART.md•2.44 kB
# Breadcrumb MCP Server - Quick Start
Get the breadcrumb MCP server running in 5 minutes.
## 1. Install
```bash
cd mcp-server
pip install -e .
```
## 2. Configure Claude Code
Add to your Claude Code MCP settings (usually at `~/.config/claude/mcp_settings.json`):
```json
{
"mcpServers": {
"breadcrumb": {
"command": "python3",
"args": ["-m", "breadcrumb_mcp.server"],
"env": {
"BREADCRUMB_ROOT": "/Users/hoangd/breadcrumb"
}
}
}
}
```
**Important:** Replace `/Users/hoangd/breadcrumb` with your actual breadcrumb directory path.
## 3. Restart Claude Code
Restart Claude Code to load the MCP server.
## 4. Verify Installation
In Claude Code, try:
```
List all breadcrumb projects
```
Claude should use the `mcp__breadcrumb__list_projects` tool.
## 5. Create Your First Project
```
Create a new breadcrumb project called "my-app"
```
Claude will use the `create_project` tool to set up the structure.
## 6. Start Using It
Now you can:
- Search documentation: "Search breadcrumbs for authentication"
- Add learnings: "Add a learning to my-app about JWT tokens"
- Create sessions: "Create a session log for my-app about today's work"
- Read documents: Claude can read `breadcrumb://project/my-app/index`
## Common Issues
### Server not starting
- Check Python version: `python3 --version` (need 3.10+)
- Verify installation: `pip show breadcrumb-mcp`
### Tools not appearing
- Check MCP config path is correct
- Restart Claude Code completely
- Check `BREADCRUMB_ROOT` points to the right directory
### Path errors
```bash
ls $BREADCRUMB_ROOT/templates # Should show template files
```
## Next Steps
1. Read the full installation guide: `INSTALL.md`
2. Read the usage guide: `../CLAUDE.md`
3. Look at the example project: `../projects/example-project/`
## Tool Quick Reference
| What You Want | What To Say to Claude |
|---------------|----------------------|
| Create project | "Create a new breadcrumb project called X" |
| List projects | "List all breadcrumb projects" |
| Search docs | "Search breadcrumbs for X" |
| Create session | "Create a session log for project X about Y" |
| Add learning | "Add a learning to project X: Y" |
| Get project info | "Show me the project index for X" |
| Recent sessions | "What are the recent sessions for project X?" |
That's it! The MCP server handles all the complexity - just tell Claude what you want in natural language.