PKG-INFO•1.85 kB
Metadata-Version: 2.4
Name: breadcrumb-mcp
Version: 0.1.0
Summary: MCP server for Breadcrumbs project memory system
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: mcp>=0.9.0
Provides-Extra: dev
Requires-Dist: pytest>=7.0.0; extra == "dev"
Requires-Dist: black>=23.0.0; extra == "dev"
Requires-Dist: ruff>=0.1.0; extra == "dev"
# Breadcrumb MCP Server
MCP (Model Context Protocol) server for the Breadcrumbs project memory system.
## Installation
```bash
cd mcp-server
pip install -e .
```
## Usage
The server will be automatically discovered by Claude Code when configured in your MCP settings.
### Configuration
Add to your Claude Code MCP settings:
```json
{
"mcpServers": {
"breadcrumb": {
"command": "python3",
"args": ["-m", "breadcrumb_mcp.server"],
"env": {
"BREADCRUMB_ROOT": "/path/to/breadcrumb"
}
}
}
}
```
## Features
### Tools
- **Project Management**: create_project, list_projects, get_project_info, get_project_stats
- **Documentation**: create_session, create_component, create_adr, create_pattern
- **Search**: search_breadcrumbs, find_related_docs, list_tags, get_timeline
- **Updates**: add_learning, add_followup, update_project_status, quick_note
- **Indexing**: generate_master_index, get_quick_reference
### Resources
- `breadcrumb://projects` - List all projects
- `breadcrumb://project/{name}/index` - Read project index
- `breadcrumb://project/{name}/sessions/{file}` - Read session log
- `breadcrumb://project/{name}/components/{file}` - Read component doc
- `breadcrumb://project/{name}/adr/{file}` - Read ADR
- `breadcrumb://project/{name}/patterns/{file}` - Read pattern
## Development
```bash
# Install with dev dependencies
pip install -e ".[dev]"
# Run tests
pytest
# Format code
black src/
# Lint
ruff check src/
```